Cursor rule Cursor
Reusable layers and building blocks should be placed in physicsnemo/nn, not physicsnemo/models. Examples include FullyConnected, attention layers, and UNetBlock.
3.2k 3d ago A 34 tokens
original Apache-2.0
3.2kStars on the repository
31Mods indexed here, across every type
3d agoLast push, which is what freshness is scored on
Apache-2.0Licence, which decides whether bodies are shown
Cursor rule Cursor
Complete models composed of multiple layers should be placed in physicsnemo/models, not physicsnemo/nn. These are domain-specific or modality-specific models.
3.2k 3d ago A 31 tokens
original Apache-2.0
Cursor rule Cursor
All model and layer classes must inherit from physicsnemo.Module (not torch.nn.Module directly) to ensure proper serialization, versioning, and registry functionality.
3.2k 3d ago A 31 tokens
original Apache-2.0
Cursor rule Cursor
New model classes should start in physicsnemo/experimental/nn or physicsnemo/experimental/models during development, where backward compatibility is not guaranteed.
3.2k 3d ago A 30 tokens
original Apache-2.0
Cursor rule Cursor
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.2k 3d ago A 33 tokens
original Apache-2.0
Cursor rule Cursor
After at least 1 release cycle in pre-deprecation stage with warnings, deprecated model classes can be deleted from the codebase.
3.2k 3d ago B 26 tokens
original Apache-2.0
Cursor rule Cursor
Every model/layer requires comprehensive docstrings following NumPy style with Sphinx RST formatting, including all sub-rules MOD-003b through MOD-003k.
3.2k 3d ago A 34 tokens
original Apache-2.0
Cursor rule Cursor
Model and method docstrings must be prefixed with r""" (raw string with triple double quotes) for proper LaTeX rendering in Sphinx documentation.
3.2k 3d ago A 31 tokens
original Apache-2.0
Cursor rule Cursor
Class docstrings must contain three mandatory sections - Parameters, Forward, and Outputs. Optional sections include Notes, Examples, ..important::, and ..code-block::.
3.2k 3d ago A 32 tokens
original Apache-2.0
Cursor rule Cursor
All methods must have docstrings with at least Parameters and Returns sections. Optional sections include Notes, Examples, ..important::, and ..code-block::.
3.2k 3d ago A 30 tokens
original Apache-2.0
Cursor rule Cursor
All tensor shapes in docstrings must use LaTeX math notation like :math:(B, C, H, W) for proper rendering in Sphinx documentation.
3.2k 3d ago A 34 tokens
original Apache-2.0
Cursor rule Cursor
Callback function parameters must include a ..code-block:: specification showing the required signature and return type, placed outside Parameters/Forward/Outputs sections.
3.2k 3d ago A 28 tokens
original Apache-2.0
Cursor rule Cursor
Inline code in docstrings must be formatted with double backticks code, not single backticks, as single backticks don't render properly in Sphinx.
3.2k 3d ago A 32 tokens
original Apache-2.0
Cursor rule Cursor
All parameters must be documented with their type and default values on a single line following NumPy docstring style format.
3.2k 3d ago A 23 tokens
original Apache-2.0
Cursor rule Cursor
Docstrings should use Sphinx cross-references (:class:, :func:, :meth:) to link to other code elements and external resources for better documentation connectivity.
3.2k 3d ago A 32 tokens
original Apache-2.0
Cursor rule Cursor
Docstrings should include an Examples section with executable code demonstrating usage, as these are automatically tested by CI for correctness.
3.2k 3d ago A 23 tokens
original Apache-2.0
Cursor rule Cursor
Complex tensor operations should include high-level semantic comments explaining what blocks of code do, plus inline shape comments for chained operations using symbols consistent with docstrings.
3.2k 3d ago A 30 tokens
original Apache-2.0
Cursor rule Cursor
All utility functions specific to a model must be in the same module file as the model itself, not in separate utility files, to maintain self-contained modules.
3.2k 3d ago A 31 tokens
original Apache-2.0
Cursor rule Cursor
All forward and public methods must validate tensor shapes at the beginning, wrapped in torch.compiler.iscompiling() guard, with standardized error messages.
3.2k 3d ago A 28 tokens
original Apache-2.0
Cursor rule Cursor
All tensor arguments in model methods must have jaxtyping type annotations with shape specifications (e.g. Float[torch.Tensor, "b c h w"]) for runtime-checkable shape information.
3.2k 3d ago A 39 tokens
original Apache-2.0
Cursor rule Cursor
Cannot add new required parameters to production model init or public methods without default values, as this breaks backward compatibility with existing code and checkpoints.
3.2k 3d ago A 29 tokens
original Apache-2.0
Cursor rule Cursor
Cannot remove or rename parameters in production models without implementing backwardcompatargmapper and incrementing modelcheckpointversion to maintain compatibility.
3.2k 3d ago A 29 tokens
original Apache-2.0
Cursor rule Cursor
Cannot change return types of public methods in production models, as this breaks user code that depends on the existing return type structure.
3.2k 3d ago A 25 tokens
original Apache-2.0
Cursor rule Cursor
Every model must have CI tests verifying constructor instantiation and all public attributes (excluding buffers/parameters) using pytest parameterization.
3.2k 3d ago A 25 tokens
original Apache-2.0