[docs] Docstrings for aim models - #61
Merged
Merged
Conversation
Enhance type hints and docstrings for clarity.
Updated type hints and added docstrings for clarity.
Added type annotations for get_model and list_models.
Updated the function signature of _discover_model_packages to specify a return type of None.
Refactor MTP model initialization and prediction methods to include type hints and docstrings.
Added type hints and docstrings for better clarity.
Contributor
Author
|
This PR adds NumPy-style docstrings for the AIM module. Changes:
No functional changes. |
il3241ya
self-requested a review
February 24, 2026 05:03
il3241ya
added
1549
documentation
AndK17
reviewed
Mar 3, 2026
Refactor predict method signature for better readability.
il3241ya
previously approved these changes
Mar 24, 2026
AndK17
approved these changes
Mar 27, 2026
il3241ya
approved these changes
Mar 30, 2026
Haralishev77
added a commit
that referenced
this pull request
Jul 21, 2026
* Refactor ModelRegistry with type hints and docstrings Enhance type hints and docstrings for clarity. * Enhance AIMModel with type hints and docstrings Updated type hints and added docstrings for clarity. * Add type annotations to public API functions Added type annotations for get_model and list_models. * Specify return type for _discover_model_packages function Updated the function signature of _discover_model_packages to specify a return type of None. * Enhance MTP model with type hints and docstrings Refactor MTP model initialization and prediction methods to include type hints and docstrings. * Add docstring for MTP model package * Enhance GNN_mtl_gnn with type hints and docstrings Added type hints and docstrings for better clarity. * Add type import * Remove unused import of None from typing * Remove unused import statement from GNN_mtl_gnn.py * Refactor KeyError raising for unknown model * Add missing newline at end of aim_model.py * Refactor code for consistency and readability * Refactor forward method for cleaner syntax * Refactor forward method for improved readability * Refactor model.py for improved readability * Fix missing newline at end of __init__.py * Refactor get_model and list_models assignments * Improve predict method formatting Refactor predict method signature for better readability. * Refactor ModelRegistry for type hinting improvements * Refactor code for improved readability * Refactor KeyError raising for unknown model name --------- Co-authored-by: Grigoriy Khoroshilov <101859570+Haralishev77@users.noreply.github.com>
meaning-0f-life
pushed a commit
to meaning-0f-life/OpenCDA
that referenced
this pull request
Jul 25, 2026
* Refactor ModelRegistry with type hints and docstrings Enhance type hints and docstrings for clarity. * Enhance AIMModel with type hints and docstrings Updated type hints and added docstrings for clarity. * Add type annotations to public API functions Added type annotations for get_model and list_models. * Specify return type for _discover_model_packages function Updated the function signature of _discover_model_packages to specify a return type of None. * Enhance MTP model with type hints and docstrings Refactor MTP model initialization and prediction methods to include type hints and docstrings. * Add docstring for MTP model package * Enhance GNN_mtl_gnn with type hints and docstrings Added type hints and docstrings for better clarity. * Add type import * Remove unused import of None from typing * Remove unused import statement from GNN_mtl_gnn.py * Refactor KeyError raising for unknown model * Add missing newline at end of aim_model.py * Refactor code for consistency and readability * Refactor forward method for cleaner syntax * Refactor forward method for improved readability * Refactor model.py for improved readability * Fix missing newline at end of __init__.py * Refactor get_model and list_models assignments * Improve predict method formatting Refactor predict method signature for better readability. * Refactor ModelRegistry for type hinting improvements * Refactor code for improved readability * Refactor KeyError raising for unknown model name --------- Co-authored-by: Grigoriy Khoroshilov <101859570+Haralishev77@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds NumPy-style docstrings for the AIM module.
Changes:
No functional changes.