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

Convert Model, ModelSpace and Problem to standardized classes #109

Closed
7 tasks done
dilpath opened this issue Nov 18, 2024 · 2 comments
Closed
7 tasks done

Convert Model, ModelSpace and Problem to standardized classes #109

dilpath opened this issue Nov 18, 2024 · 2 comments
Labels
fixed in next release This issue is resolved and will be available in the next version.

Comments

@dilpath
Copy link
Member

dilpath commented Nov 18, 2024

  • convert Model (Create standard/schema for a Model #130 )
    • update RTD docs
    • add schema
  • convert ModelSpace won't fix: it's a TSV so could use frictionless, but skipping for now
  • convert Problem
    • update RTD docs
    • add schema

In addition:

  • refactor "model ID" into "model label" or "model name". Currently, "model ID" is mostly useless and is generally the same as "model hash".
@dweindl
Copy link
Member

dweindl commented Nov 19, 2024

  • refactor "model ID" into "model label" or "model name"

It could make sense to keep both, some ID (based on a restricted character set), and a name/label that is arbitrary text (and may include latex math for visualization, ...). The new model hashes may often enough address the first part, but i could imagine, that in some cases, users might prefer their own names. No strong opinion yet.

@dilpath dilpath changed the title Convert Model to a dataclass Convert Model, ModelSpace and Problem to standardized classes Dec 17, 2024
@dilpath dilpath added the fixed in next release This issue is resolved and will be available in the next version. label Jan 6, 2025
@dilpath
Copy link
Member Author

dilpath commented Jan 7, 2025

Model ID and model label are both implemented now. In plots, labels default to model.model_label, then to model.model_id, then to model.hash.

@dilpath dilpath closed this as completed Jan 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
fixed in next release This issue is resolved and will be available in the next version.
Projects
None yet
Development

No branches or pull requests

2 participants