MLJModelInterface.jl icon indicating copy to clipboard operation
MLJModelInterface.jl copied to clipboard

human_name vs Base.nameof

Open oxinabox opened this issue 1 year ago • 2 comments

I am wondering on the relationship (or lack there of) between Base.nameof and MMI.human_name. Should Base.nameof on model instances fall back to MMI.human_name? It is the function i tried to use first when i wanted a name for a model instance

The ModelingToolkit ecosystem uses Base.nameof to provide names for things.

oxinabox avatar Jul 23 '24 06:07 oxinabox

I was not aware of Base.nameof. It's doc-string suggests a different purpose.

human_name is basically for documentation, some of which is generated automatically. So, for example,

using MLJTSVDInterface

julia> human_name(TSVDTransformer)
"truncated SVD transformer"

ablaom avatar Jul 23 '24 20:07 ablaom

I'm using it to make tables of results comparing different models

oxinabox avatar Jul 24 '24 03:07 oxinabox