human_name vs Base.nameof

Open
#208 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
julia

Research direction

Start by reviewing the definitions and current uses of Base.nameof and MMI.human_name in MLJModelInterface.jl, then inspect how model-instance names are consumed across the MLJ and ModelingToolkit ecosystems. Done requires an agreed relationship between the two naming functions and a documented or tested behavior for model instances.

Written by the indexing model from the issue text.

Description

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.

Dominant language
Julia
Stars
39
Forks
8
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from JuliaAI/MLJModelInterface.jl

All issues in JuliaAI/MLJModelInterface.jl

Similar issues

More Julia issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.