Merge branch 'master' into refactoring/remove_compute_on_step_regression

Lightning-AI · Apr 20, 2022 · 1fe59e5 · 1fe59e5
2 parents 4d4664e + 23b2e45
commit 1fe59e5
Show file tree

Hide file tree

Showing 14 changed files with 177 additions and 83 deletions.
diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html
@@ -4,7 +4,7 @@
 {% block footer %}
 {{ super() }}
 <script script type="text/javascript">
-  var collapsedSections = ['Audio', 'Classification', 'Image', 'Detection', 'Pairwise', 'Regression', 'Retrieval', 'Text', 'API Reference', 'Community'];
+  var collapsedSections = ['Audio', 'Classification', 'Image', 'Detection', 'Pairwise', 'Regression', 'Retrieval', 'Text', 'Aggregation', 'Wrappers', 'API Reference', 'Community'];
 </script>
 
 {% endblock %}
diff --git a/docs/source/aggregation/cat.rst b/docs/source/aggregation/cat.rst
@@ -0,0 +1,16 @@
+.. customcarditem::
+   :header: Concatenation
+   :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/graph_classification.svg
+   :tags: Aggregation
+
+.. include:: ../links.rst
+
+#############
+Concatenation
+#############
+
+Module Interface
+________________
+
+.. autoclass:: torchmetrics.CatMetric
+    :noindex:
diff --git a/docs/source/aggregation/max.rst b/docs/source/aggregation/max.rst
@@ -0,0 +1,16 @@
+.. customcarditem::
+   :header: Maximum
+   :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/graph_classification.svg
+   :tags: Aggregation
+
+.. include:: ../links.rst
+
+#######
+Maximum
+#######
+
+Module Interface
+________________
+
+.. autoclass:: torchmetrics.MaxMetric
+    :noindex:
diff --git a/docs/source/aggregation/mean.rst b/docs/source/aggregation/mean.rst
@@ -0,0 +1,16 @@
+.. customcarditem::
+   :header: Mean
+   :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/graph_classification.svg
+   :tags: Aggregation
+
+.. include:: ../links.rst
+
+####
+Mean
+####
+
+Module Interface
+________________
+
+.. autoclass:: torchmetrics.MeanMetric
+    :noindex:
diff --git a/docs/source/aggregation/min.rst b/docs/source/aggregation/min.rst
@@ -0,0 +1,16 @@
+.. customcarditem::
+   :header: Minimum
+   :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/graph_classification.svg
+   :tags: Aggregation
+
+.. include:: ../links.rst
+
+#######
+Minimum
+#######
+
+Module Interface
+________________
+
+.. autoclass:: torchmetrics.MinMetric
+    :noindex:
diff --git a/docs/source/aggregation/sum.rst b/docs/source/aggregation/sum.rst
@@ -0,0 +1,16 @@
+.. customcarditem::
+   :header: Sum
+   :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/graph_classification.svg
+   :tags: Aggregation
+
+.. include:: ../links.rst
+
+###
+Sum
+###
+
+Module Interface
+________________
+
+.. autoclass:: torchmetrics.SumMetric
+    :noindex:
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -198,14 +198,28 @@ Or directly from conda
 
    text/*
 
+.. toctree::
+   :maxdepth: 2
+   :name: aggregation
+   :caption: Aggregation
+   :glob:
+
+   aggregation/*
+
+.. toctree::
+   :maxdepth: 2
+   :name: wrappers
+   :caption: Wrappers
+   :glob:
+
+   wrappers/*
+
 .. toctree::
    :maxdepth: 3
    :name: metrics
    :caption: API Reference
 
    references/metric
-   references/aggregation
-   references/wrappers
    references/utilities
 
 .. toctree::

diff --git a/docs/source/references/aggregation.rst b/docs/source/references/aggregation.rst
diff --git a/docs/source/references/wrappers.rst b/docs/source/references/wrappers.rst
diff --git a/docs/source/wrappers/bootstrapper.rst b/docs/source/wrappers/bootstrapper.rst
@@ -0,0 +1,16 @@
+.. customcarditem::
+   :header: Bootstrapper
+   :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/graph_classification.svg
+   :tags: Wrappers
+
+.. include:: ../links.rst
+
+############
+Bootstrapper
+############
+
+Module Interface
+________________
+
+.. autoclass:: torchmetrics.BootStrapper
+    :noindex:
diff --git a/docs/source/wrappers/classwise_wrapper.rst b/docs/source/wrappers/classwise_wrapper.rst
@@ -0,0 +1,16 @@
+.. customcarditem::
+   :header: Classwise Wrapper
+   :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/graph_classification.svg
+   :tags: Wrappers
+
+.. include:: ../links.rst
+
+#################
+Classwise Wrapper
+#################
+
+Module Interface
+________________
+
+.. autoclass:: torchmetrics.ClasswiseWrapper
+    :noindex:
diff --git a/docs/source/wrappers/metric_tracker.rst b/docs/source/wrappers/metric_tracker.rst
@@ -0,0 +1,16 @@
+.. customcarditem::
+   :header: Metric Tracker
+   :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/graph_classification.svg
+   :tags: Wrappers
+
+.. include:: ../links.rst
+
+##############
+Metric Tracker
+##############
+
+Module Interface
+________________
+
+.. autoclass:: torchmetrics.MetricTracker
+    :noindex:
diff --git a/docs/source/wrappers/min_max.rst b/docs/source/wrappers/min_max.rst
@@ -0,0 +1,16 @@
+.. customcarditem::
+   :header: Min / Max
+   :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/graph_classification.svg
+   :tags: Wrappers
+
+.. include:: ../links.rst
+
+#########
+Min / Max
+#########
+
+Module Interface
+________________
+
+.. autoclass:: torchmetrics.MinMaxMetric
+    :noindex:
diff --git a/docs/source/wrappers/multi_output_wrapper.rst b/docs/source/wrappers/multi_output_wrapper.rst
@@ -0,0 +1,16 @@
+.. customcarditem::
+   :header: Multi-output Wrapper
+   :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/graph_classification.svg
+   :tags: Wrappers
+
+.. include:: ../links.rst
+
+####################
+Multi-output Wrapper
+####################
+
+Module Interface
+________________
+
+.. autoclass:: torchmetrics.MultioutputWrapper
+    :noindex: