Documentation
#############

Gradient Metric Collector
=========================

.. autoclass:: gradient_metrics.GradientMetricCollector
   :members:
   :undoc-members:
   :special-members: __call__

Gradient Metrics
================

GradientMetric
--------------

.. autoclass:: gradient_metrics.metrics.GradientMetric
   :members:
   :undoc-members:
   :private-members:
   :special-members: __call__

Max
---

.. autoclass:: gradient_metrics.metrics.Max
   :members:
   :undoc-members:
   :show-inheritance:

Mean
----

.. autoclass:: gradient_metrics.metrics.Mean
   :members:
   :undoc-members:
   :show-inheritance:

MeanStd
-------

.. autoclass:: gradient_metrics.metrics.MeanStd
   :members:
   :undoc-members:
   :show-inheritance:

Min
---

.. autoclass:: gradient_metrics.metrics.Min
   :members:
   :undoc-members:
   :show-inheritance:

PNorm
-----

.. autoclass:: gradient_metrics.metrics.PNorm
   :members:
   :undoc-members:
   :show-inheritance: