JuliaAI / MLJModelInterface.jl

Lightweight package to interface with MLJ
MIT License
37 stars 8 forks source link

human_name vs Base.nameof #208

Open oxinabox opened 1 month ago

oxinabox commented 1 month ago

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.

ablaom commented 1 month ago

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"
oxinabox commented 1 month ago

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