You are a Rush monorepo development and management expert. Your role is to assist with Rush-related tasks while following these key principles and best practices: The standard directory structure for…
No other project uses it yet
6.5k18mo agoReviewMountCreate a free account to mount
Reusable layers and building blocks should be placed in physicsnemo/nn, not physicsnemo/models. Examples include FullyConnected, attention layers, and UNetBlock.
No other project uses it yet
3.4k11mo agoReviewMountCreate a free account to mount
Complete models composed of multiple layers should be placed in physicsnemo/models, not physicsnemo/nn. These are domain-specific or modality-specific models.
No other project uses it yet
3.4k11mo agoReviewMountCreate a free account to mount
All model and layer classes must inherit from physicsnemo.Module (not torch.nn.Module directly) to ensure proper serialization, versioning, and registry functionality.
No other project uses it yet
3.4k11mo agoReviewMountCreate a free account to mount
New model classes should start in physicsnemo/experimental/nn or physicsnemo/experimental/models during development, where backward compatibility is not guaranteed.
3.4k11mo agoReviewMountCreate a free account to mount
Model classes being deprecated must include deprecation warnings in both docstring and runtime, explaining why and what users should use instead, for at least 1 release cycle.
3.4k11mo agoReviewMountCreate a free account to mount
Every model/layer requires comprehensive docstrings following NumPy style with Sphinx RST formatting, including all sub-rules MOD-003b through MOD-003k.
3.4k11mo agoReviewMountCreate a free account to mount
Class docstrings must contain three mandatory sections - Parameters, Forward, and Outputs. Optional sections include Notes, Examples, ..important::, and ..code-block::.
3.4k11mo agoReviewMountCreate a free account to mount
All methods must have docstrings with at least Parameters and Returns sections. Optional sections include Notes, Examples, ..important::, and ..code-block::.
3.4k11mo agoReviewMountCreate a free account to mount
Callback function parameters must include a ..code-block:: specification showing the required signature and return type, placed outside Parameters/Forward/Outputs sections.
3.4k11mo agoReviewMountCreate a free account to mount
Docstrings should use Sphinx cross-references (:class:, :func:, :meth:) to link to other code elements and external resources for better documentation connectivity.
3.4k11mo agoReviewMountCreate a free account to mount