Skip to content

672 create a supported models class property for hssm#673

Merged
cpaniaguam merged 3 commits intomainfrom
672-create-a-supported_models-class-variable-for-hssm
Feb 28, 2025
Merged

672 create a supported models class property for hssm#673
cpaniaguam merged 3 commits intomainfrom
672-create-a-supported_models-class-variable-for-hssm

Conversation

@cpaniaguam
Copy link
Copy Markdown
Collaborator

This pull request includes several updates to the docs/tutorials/main_tutorial.ipynb and src/hssm/hssm.py files. The changes primarily focus on improving documentation and adding new functionalities to the HSSM class.

Codebase enhancements:

  • Added a classproperty decorator to the HSSM class in src/hssm/hssm.py to allow class-level properties that perform computations or access class-level data. This decorator ensures compatibility across Python versions 3.10 through 3.12.
  • Introduced a new supported_models class property in the HSSM class to return a tuple of all supported model names.

Documentation updates:

  • Updated references to model accessors in docs/tutorials/main_tutorial.ipynb to reflect the new structure, changing hssm.defaults.SupportedModels to hssm.HSSM.supported_models and updating the method to check detailed model information. [1] [2] [3] [4] [5]

@cpaniaguam cpaniaguam self-assigned this Feb 26, 2025
@cpaniaguam cpaniaguam linked an issue Feb 26, 2025 that may be closed by this pull request
2 tasks
@cpaniaguam cpaniaguam added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 26, 2025
@codecov
Copy link
Copy Markdown

codecov bot commented Feb 26, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Files with missing lines Coverage Δ
src/hssm/hssm.py 77.85% <100.00%> (+0.25%) ⬆️

@cpaniaguam cpaniaguam changed the title 672 create a supported models class variable for hssm 672 create a supported models class property for hssm Feb 26, 2025
Copy link
Copy Markdown
Member

@AlexanderFengler AlexanderFengler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good! Thanks @cpaniaguam

@cpaniaguam cpaniaguam merged commit b1aee81 into main Feb 28, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create a supported_models class variable for HSSM

2 participants