Skip to content

Add details to docs #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cboulay merged 1 commit into from
Oct 29, 2025
Merged

Add details to docs #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 64 additions & 0 deletions docs/source/_templates/autosummary/module.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
{{ fullname | escape | underline}}

.. automodule:: {{ fullname }}

{% block attributes %}
{% if attributes %}
.. rubric:: Module Attributes

.. autosummary::
:toctree:
{% for item in attributes %}
{{ item }}
{%- endfor %}
{% endif %}
{% endblock %}

{% block functions %}
{% if functions %}
.. rubric:: Functions

{% for item in functions %}
.. autofunction:: {{ item }}
{%- endfor %}
{% endif %}
{% endblock %}

{% block classes %}
{% if classes %}
.. rubric:: Classes

{% for item in classes %}
.. autoclass:: {{ item }}
:members:
:undoc-members:
:show-inheritance:
:special-members: __init__
{%- endfor %}
{% endif %}
{% endblock %}

{% block exceptions %}
{% if exceptions %}
.. rubric:: Exceptions

{% for item in exceptions %}
.. autoexception:: {{ item }}
:members:
:show-inheritance:
{%- endfor %}
{% endif %}
{% endblock %}

{% block modules %}
{% if modules %}
.. rubric:: Modules

.. autosummary::
:toctree:
:recursive:
{% for item in modules %}
{{ item }}
{%- endfor %}
{% endif %}
{% endblock %}
82 changes: 69 additions & 13 deletions docs/source/api/generated/ezmsg.learn.dim_reduce.adaptive_decomp.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,74 @@
.. automodule:: ezmsg.learn.dim_reduce.adaptive_decomp











.. rubric:: Classes

.. autosummary::

AdaptiveDecompSettings
AdaptiveDecompState
AdaptiveDecompTransformer
BaseAdaptiveDecompUnit
IncrementalPCASettings
IncrementalPCATransformer
IncrementalPCAUnit
MiniBatchNMFSettings
MiniBatchNMFTransformer
MiniBatchNMFUnit


.. autoclass:: AdaptiveDecompSettings
:members:
:undoc-members:
:show-inheritance:
:special-members: __init__
.. autoclass:: AdaptiveDecompState
:members:
:undoc-members:
:show-inheritance:
:special-members: __init__
.. autoclass:: AdaptiveDecompTransformer
:members:
:undoc-members:
:show-inheritance:
:special-members: __init__
.. autoclass:: BaseAdaptiveDecompUnit
:members:
:undoc-members:
:show-inheritance:
:special-members: __init__
.. autoclass:: IncrementalPCASettings
:members:
:undoc-members:
:show-inheritance:
:special-members: __init__
.. autoclass:: IncrementalPCATransformer
:members:
:undoc-members:
:show-inheritance:
:special-members: __init__
.. autoclass:: IncrementalPCAUnit
:members:
:undoc-members:
:show-inheritance:
:special-members: __init__
.. autoclass:: MiniBatchNMFSettings
:members:
:undoc-members:
:show-inheritance:
:special-members: __init__
.. autoclass:: MiniBatchNMFTransformer
:members:
:undoc-members:
:show-inheritance:
:special-members: __init__
.. autoclass:: MiniBatchNMFUnit
:members:
:undoc-members:
:show-inheritance:
:special-members: __init__









38 changes: 33 additions & 5 deletions docs/source/api/generated/ezmsg.learn.dim_reduce.incremental_decomp.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,39 @@
.. automodule:: ezmsg.learn.dim_reduce.incremental_decomp











.. rubric:: Classes

.. autosummary::

IncrementalDecompSettings
IncrementalDecompTransformer
IncrementalDecompUnit

.. autoclass:: IncrementalDecompSettings
:members:
:undoc-members:
:show-inheritance:
:special-members: __init__
.. autoclass:: IncrementalDecompTransformer
:members:
:undoc-members:
:show-inheritance:
:special-members: __init__
.. autoclass:: IncrementalDecompUnit
:members:
:undoc-members:
:show-inheritance:
:special-members: __init__









19 changes: 18 additions & 1 deletion docs/source/api/generated/ezmsg.learn.linear_model.adaptive_linear_regressor.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,21 @@

.. automodule:: ezmsg.learn.linear_model.adaptive_linear_regressor




















19 changes: 18 additions & 1 deletion docs/source/api/generated/ezmsg.learn.linear_model.cca.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,21 @@

.. automodule:: ezmsg.learn.linear_model.cca




















19 changes: 18 additions & 1 deletion docs/source/api/generated/ezmsg.learn.linear_model.linear_regressor.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,21 @@

.. automodule:: ezmsg.learn.linear_model.linear_regressor




















19 changes: 18 additions & 1 deletion docs/source/api/generated/ezmsg.learn.linear_model.sgd.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,21 @@

.. automodule:: ezmsg.learn.linear_model.sgd




















19 changes: 18 additions & 1 deletion docs/source/api/generated/ezmsg.learn.linear_model.slda.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,21 @@

.. automodule:: ezmsg.learn.linear_model.slda




















26 changes: 23 additions & 3 deletions docs/source/api/generated/ezmsg.learn.model.cca.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,29 @@
.. automodule:: ezmsg.learn.model.cca











.. rubric:: Classes

.. autosummary::

IncrementalCCA

.. autoclass:: IncrementalCCA
:members:
:undoc-members:
:show-inheritance:
:special-members: __init__









26 changes: 23 additions & 3 deletions docs/source/api/generated/ezmsg.learn.model.mlp.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,29 @@
.. automodule:: ezmsg.learn.model.mlp











.. rubric:: Classes

.. autosummary::

MLP

.. autoclass:: MLP
:members:
:undoc-members:
:show-inheritance:
:special-members: __init__









Loading