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 pull request includes significant updates to the documentation and the addition of docstrings to the
pinnx.metrics
module. The most important changes include the addition of new reStructuredText (reST) templates and modules, updates to the documentation configuration, and enhancements to thepinnx.metrics
functions.Documentation Enhancements:
docs/_templates/classtemplate.rst
: Added a new template for class documentation with hidden sections and module references.docs/apis/pinnx.callbacks.rst
,docs/apis/pinnx.fnspace.rst
,docs/apis/pinnx.grad.rst
,docs/apis/pinnx.metrics.rst
,docs/apis/pinnx.rst
: Added new reST files for variouspinnx
modules with autosummary directives for generating documentation. [1] [2] [3] [4] [5]docs/auto_generater.py
: Added a new Python script to automatically generate documentation for modules, including functions to write module summaries and subsections.docs/conf.py
: Updated the Sphinx configuration to include the newly createdauto_generater
script and ensure theapis/
directory is created.docs/index.rst
: Added a toctree directive to include API documentation for variouspinnx
modules.Code Enhancements:
pinnx/metrics.py
: Added docstrings to various metric functions to describe their purpose and usage. [1] [2] [3] [4] [5]