Added links to all the metric files (#2474)

* Added links to all the metric files

* Added required link to all the metrics

* fixed a few errors

Author: sayantan1410

Diff for: docs/source/metrics.rst

@@ -4,11 +4,13 @@ ignite.metrics
 Metrics provide a way to compute various quantities of interest in an online
 fashion without having to store the entire output history of a model.
 
+.. _attach-engine:
+
 Attach Engine API
 ------------------
 
-The metrics as stated above are computed in a online fashion, which means that the metric instance accumulates some internal counters on 
-each iteration and metric value is computed once the epoch is ended. Internal counters are reset after every epoch. In practice, this is done with the 
+The metrics as stated above are computed in a online fashion, which means that the metric instance accumulates some internal counters on
+each iteration and metric value is computed once the epoch is ended. Internal counters are reset after every epoch. In practice, this is done with the
 help of three methods: :meth:`~ignite.metrics.metric.Metric.reset()`, :meth:`~ignite.metrics.metric.Metric.update()` and :meth:`~ignite.metrics.metric.Metric.compute()`.
 
 Therefore, a user needs to attach the metric instance to the engine so that the above three methods can be triggered on execution of certain :class:`~ignite.engine.events.Events`.

Diff for: ignite/metrics/accumulation.py

@@ -112,6 +112,8 @@ class Average(VariableAccumulation):
 
     Examples:
 
+        For more information on how metric works with :class:`~ignite.engine.engine.Engine`, visit :ref:`attach-engine`.
+
         .. include:: defaults.rst
             :start-after: :orphan:
 
@@ -213,6 +215,8 @@ class GeometricAverage(VariableAccumulation):
 
     Examples:
 
+        For more information on how metric works with :class:`~ignite.engine.engine.Engine`, visit :ref:`attach-engine`.
+
         .. include:: defaults.rst
             :start-after: :orphan:
 

Diff for: ignite/metrics/accuracy.py

@@ -117,6 +117,8 @@ class Accuracy(_BaseClassification):
 
     Examples:
 
+        For more information on how metric works with :class:`~ignite.engine.engine.Engine`, visit :ref:`attach-engine`.
+
         .. include:: defaults.rst
             :start-after: :orphan:
 

Diff for: ignite/metrics/classification_report.py

@@ -38,6 +38,8 @@ def ClassificationReport(
 
     Examples:
 
+        For more information on how metric works with :class:`~ignite.engine.engine.Engine`, visit :ref:`attach-engine`.
+
         .. include:: defaults.rst
             :start-after: :orphan:
 

Diff for: ignite/metrics/confusion_matrix.py

@@ -47,6 +47,8 @@ class ConfusionMatrix(Metric):
 
     Examples:
 
+        For more information on how metric works with :class:`~ignite.engine.engine.Engine`, visit :ref:`attach-engine`.
+
         .. include:: defaults.rst
             :start-after: :orphan:
 
@@ -204,6 +206,8 @@ def IoU(cm: ConfusionMatrix, ignore_index: Optional[int] = None) -> MetricsLambd
 
     Examples:
 
+        For more information on how metric works with :class:`~ignite.engine.engine.Engine`, visit :ref:`attach-engine`.
+
         .. include:: defaults.rst
             :start-after: :orphan:
 
@@ -267,6 +271,8 @@ def mIoU(cm: ConfusionMatrix, ignore_index: Optional[int] = None) -> MetricsLamb
 
     Examples:
 
+        For more information on how metric works with :class:`~ignite.engine.engine.Engine`, visit :ref:`attach-engine`.
+
         .. include:: defaults.rst
             :start-after: :orphan:
 
@@ -356,6 +362,8 @@ def DiceCoefficient(cm: ConfusionMatrix, ignore_index: Optional[int] = None) ->
 
     Examples:
 
+        For more information on how metric works with :class:`~ignite.engine.engine.Engine`, visit :ref:`attach-engine`.
+
         .. include:: defaults.rst
             :start-after: :orphan:
 
@@ -423,6 +431,8 @@ def JaccardIndex(cm: ConfusionMatrix, ignore_index: Optional[int] = None) -> Met
 
     Examples:
 
+        For more information on how metric works with :class:`~ignite.engine.engine.Engine`, visit :ref:`attach-engine`.
+
         .. include:: defaults.rst
             :start-after: :orphan:
 

Diff for: ignite/metrics/epoch_metric.py

@@ -42,6 +42,8 @@ class EpochMetric(Metric):
 
     Example:
 
+        For more information on how metric works with :class:`~ignite.engine.engine.Engine`, visit :ref:`attach-engine`.
+
         .. include:: defaults.rst
             :start-after: :orphan:
 

Diff for: ignite/metrics/fbeta.py

@@ -47,6 +47,8 @@ def Fbeta(
 
     Examples:
 
+        For more information on how metric works with :class:`~ignite.engine.engine.Engine`, visit :ref:`attach-engine`.
+
         .. include:: defaults.rst
             :start-after: :orphan:
 

Diff for: ignite/metrics/frequency.py

@@ -12,6 +12,8 @@ class Frequency(Metric):
     """Provides metrics for the number of examples processed per second.
 
     Examples:
+        For more information on how metric works with :class:`~ignite.engine.engine.Engine`, visit :ref:`attach-engine`.
+
         .. code-block:: python
 
             # Compute number of tokens processed

Diff for: ignite/metrics/gan/fid.py

@@ -96,6 +96,8 @@ class FID(_BaseInceptionMetric):
 
     Examples:
 
+        For more information on how metric works with :class:`~ignite.engine.engine.Engine`, visit :ref:`attach-engine`.
+
         .. include:: defaults.rst
             :start-after: :orphan:
 

Diff for: ignite/metrics/gan/inception_score.py

@@ -49,6 +49,8 @@ class InceptionScore(_BaseInceptionMetric):
 
     Examples:
 
+        For more information on how metric works with :class:`~ignite.engine.engine.Engine`, visit :ref:`attach-engine`.
+
         .. include:: defaults.rst
             :start-after: :orphan:
 

Diff for: ignite/metrics/loss.py

@@ -42,6 +42,8 @@ class Loss(Metric):
         and the Loss metric using an ``evaluator`` created with
         :meth:`~ignite.engine.create_supervised_evaluator` method.
 
+        For more information on how metric works with :class:`~ignite.engine.engine.Engine`, visit :ref:`attach-engine`.
+
         .. include:: defaults.rst
             :start-after: :orphan:
 

Diff for: ignite/metrics/mean_absolute_error.py

@@ -35,6 +35,8 @@ class MeanAbsoluteError(Metric):
 
         ``y_pred`` and ``y`` should have the same shape.
 
+        For more information on how metric works with :class:`~ignite.engine.engine.Engine`, visit :ref:`attach-engine`.
+
         .. include:: defaults.rst
             :start-after: :orphan:
 

Diff for: ignite/metrics/mean_pairwise_distance.py

@@ -35,6 +35,8 @@ class MeanPairwiseDistance(Metric):
 
         ``y_pred`` and ``y`` should have the same shape.
 
+        For more information on how metric works with :class:`~ignite.engine.engine.Engine`, visit :ref:`attach-engine`.
+
         .. include:: defaults.rst
             :start-after: :orphan:
 

Diff for: ignite/metrics/mean_squared_error.py

@@ -35,6 +35,8 @@ class MeanSquaredError(Metric):
 
         ``y_pred`` and ``y`` should have the same shape.
 
+        For more information on how metric works with :class:`~ignite.engine.engine.Engine`, visit :ref:`attach-engine`.
+
         .. include:: defaults.rst
             :start-after: :orphan:
 

Diff for: ignite/metrics/metric.py

@@ -150,6 +150,8 @@ class Metric(metaclass=ABCMeta):
         In the example below we show how to setup standard metric like Accuracy and the custom metric using by an
         ``evaluator`` created with :meth:`~ignite.engine.create_supervised_evaluator` method.
 
+        For more information on how metric works with :class:`~ignite.engine.engine.Engine`, visit :ref:`attach-engine`.
+
         .. code-block:: python
 
             # https://discuss.pytorch.org/t/how-access-inputs-in-custom-ignite-metric/91221/5
@@ -378,6 +380,7 @@ def attach(self, engine: Engine, name: str, usage: Union[str, MetricUsage] = Epo
                 :attr:`ignite.metrics.metric.BatchWise.usage_name`.
 
         Examples:
+
             .. code-block:: python
 
                 metric = ...

Diff for: ignite/metrics/metrics_lambda.py

@@ -29,6 +29,8 @@ class MetricsLambda(Metric):
 
     Examples:
 
+        For more information on how metric works with :class:`~ignite.engine.engine.Engine`, visit :ref:`attach-engine`.
+
         .. include:: defaults.rst
             :start-after: :orphan:
 

Diff for: ignite/metrics/multilabel_confusion_matrix.py

@@ -40,6 +40,8 @@ class MultiLabelConfusionMatrix(Metric):
 
     Example:
 
+        For more information on how metric works with :class:`~ignite.engine.engine.Engine`, visit :ref:`attach-engine`.
+
         .. include:: defaults.rst
             :start-after: :orphan:
 

Diff for: ignite/metrics/nlp/bleu.py

@@ -104,6 +104,8 @@ class Bleu(Metric):
 
     Examples:
 
+        For more information on how metric works with :class:`~ignite.engine.engine.Engine`, visit :ref:`attach-engine`.
+
         .. testcode::
 
             from ignite.metrics.nlp import Bleu

Diff for: ignite/metrics/nlp/rouge.py

@@ -212,6 +212,8 @@ class RougeN(_BaseRouge):
 
     Examples:
 
+        For more information on how metric works with :class:`~ignite.engine.engine.Engine`, visit :ref:`attach-engine`.
+
         .. testcode::
 
             from ignite.metrics import RougeN
@@ -282,6 +284,8 @@ class RougeL(_BaseRouge):
 
     Examples:
 
+        For more information on how metric works with :class:`~ignite.engine.engine.Engine`, visit :ref:`attach-engine`.
+
         .. testcode::
 
             from ignite.metrics import RougeL
@@ -347,6 +351,8 @@ class Rouge(Metric):
 
     Examples:
 
+        For more information on how metric works with :class:`~ignite.engine.engine.Engine`, visit :ref:`attach-engine`.
+
         .. testcode::
 
             from ignite.metrics import Rouge

Diff for: ignite/metrics/precision.py

@@ -88,6 +88,8 @@ class Precision(_BasePrecisionRecall):
 
     Examples:
 
+        For more information on how metric works with :class:`~ignite.engine.engine.Engine`, visit :ref:`attach-engine`.
+
         .. include:: defaults.rst
             :start-after: :orphan:
 

Diff for: ignite/metrics/psnr.py

@@ -34,6 +34,8 @@ class PSNR(Metric):
         The output of the engine's ``process_function`` needs to be in format of
         ``(y_pred, y)`` or ``{'y_pred': y_pred, 'y': y, ...}``.
 
+        For more information on how metric works with :class:`~ignite.engine.engine.Engine`, visit :ref:`attach-engine`.
+
         .. include:: defaults.rst
             :start-after: :orphan:
 

Diff for: ignite/metrics/recall.py

@@ -35,6 +35,8 @@ class Recall(_BasePrecisionRecall):
 
     Examples:
 
+        For more information on how metric works with :class:`~ignite.engine.engine.Engine`, visit :ref:`attach-engine`.
+
         .. include:: defaults.rst
             :start-after: :orphan:
 

Diff for: ignite/metrics/root_mean_squared_error.py

@@ -35,6 +35,8 @@ class RootMeanSquaredError(MeanSquaredError):
 
         ``y_pred`` and ``y`` should have the same shape.
 
+        For more information on how metric works with :class:`~ignite.engine.engine.Engine`, visit :ref:`attach-engine`.
+
         .. include:: defaults.rst
             :start-after: :orphan:
 

Diff for: ignite/metrics/running_average.py

@@ -27,6 +27,8 @@ class RunningAverage(Metric):
 
     Examples:
 
+        For more information on how metric works with :class:`~ignite.engine.engine.Engine`, visit :ref:`attach-engine`.
+
         .. include:: defaults.rst
             :start-after: :orphan:
 

Diff for: ignite/metrics/ssim.py

@@ -36,6 +36,8 @@ class SSIM(Metric):
         ``y_pred`` and ``y`` can be un-normalized or normalized image tensors. Depending on that, the user might need
         to adjust ``data_range``. ``y_pred`` and ``y`` should have the same shape.
 
+        For more information on how metric works with :class:`~ignite.engine.engine.Engine`, visit :ref:`attach-engine`.
+
         .. include:: defaults.rst
             :start-after: :orphan:
 

Diff for: ignite/metrics/top_k_categorical_accuracy.py

@@ -31,6 +31,8 @@ class TopKCategoricalAccuracy(Metric):
         ``(y_pred, y)`` or ``{'y_pred': y_pred, 'y': y, ...}``. If not, ``output_tranform`` can be added
         to the metric to transform the output into the form expected by the metric.
 
+        For more information on how metric works with :class:`~ignite.engine.engine.Engine`, visit :ref:`attach-engine`.
+
         .. include:: defaults.rst
             :start-after: :orphan: