Fix small reference error in classification docs (Lightning-AI#1408)

Co-authored-by: Jirka Borovec <6035284+Borda@users.noreply.github.com> Co-authored-by: Jirka <jirka.borovec@seznam.cz>
ValerianRey · Dec 29, 2022 · e919d57 · e919d57
1 parent b74d1cb
commit e919d57
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 2 deletions.
diff --git a/docs/source/classification/coverage_error.rst b/docs/source/classification/coverage_error.rst
@@ -3,6 +3,8 @@
    :image: https://pl-flash-data.s3.amazonaws.com/assets/thumbnails/tabular_classification.svg
    :tags: Classification
 
+.. include:: ../links.rst
+
 ##############
 Coverage Error
 ##############

diff --git a/docs/source/links.rst b/docs/source/links.rst
@@ -115,4 +115,4 @@
 .. _Scale-invariant signal-to-noise ratio: https://arxiv.org/abs/1711.00541
 .. _Signal-to-noise ratio: https://arxiv.org/abs/1811.02508
 .. _Permutation invariant training: https://arxiv.org/abs/1607.00325
-.. _ranking ref1: https://link.springer.com/chapter/10.1007/978-0-387-09823-4_34
+.. _Multilabel coverage error: https://link.springer.com/chapter/10.1007/978-0-387-09823-4_34
diff --git a/src/torchmetrics/classification/ranking.py b/src/torchmetrics/classification/ranking.py
@@ -29,7 +29,7 @@
 
 
 class MultilabelCoverageError(Metric):
-    """Computes multilabel coverage error [1]. The score measure how far we need to go through the ranked scores to
+    """Computes `Multilabel coverage error`_. The score measure how far we need to go through the ranked scores to
     cover all true labels. The best value is equal to the average number of labels in the target tensor per sample.
 
     Accepts the following input tensors: