Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

human_name vs Base.nameof #208

Open
oxinabox opened this issue Jul 23, 2024 · 2 comments
Open

human_name vs Base.nameof #208

oxinabox opened this issue Jul 23, 2024 · 2 comments

Comments

@oxinabox
Copy link

oxinabox commented Jul 23, 2024

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
Copy link
Member

ablaom commented Jul 23, 2024

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
Copy link
Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants