added Raises section to all retrieval metrics

torchmetrics/retrieval/mean_average_precision.py

@@ -55,6 +55,12 @@ class RetrievalMAP(RetrievalMetric):
             Callback that performs the allgather operation on the metric state. When `None`, DDP
             will be used to perform the allgather.
 
+    Raises:
+        ValueError:
+            If ``empty_target_action`` is not one of ``error``, ``skip``, ``neg`` or ``pos``.
+        ValueError:
+            If ``ignore_index`` is not `None` or an integer.
+
     Example:
         >>> from torchmetrics import RetrievalMAP
         >>> indexes = tensor([0, 0, 0, 1, 1, 1, 1])

torchmetrics/retrieval/mean_reciprocal_rank.py

@@ -55,6 +55,12 @@ class RetrievalMRR(RetrievalMetric):
             Callback that performs the allgather operation on the metric state. When `None`, DDP
             will be used to perform the allgather.
 
+    Raises:
+        ValueError:
+            If ``empty_target_action`` is not one of ``error``, ``skip``, ``neg`` or ``pos``.
+        ValueError:
+            If ``ignore_index`` is not `None` or an integer.
+
     Example:
         >>> from torchmetrics import RetrievalMRR
         >>> indexes = tensor([0, 0, 0, 1, 1, 1, 1])

torchmetrics/retrieval/retrieval_fallout.py

@@ -62,7 +62,11 @@ class RetrievalFallOut(RetrievalMetric):
 
     Raises:
         ValueError:
-            If ``k`` parameter is not `None` or an integer larger than 0
+            If ``empty_target_action`` is not one of ``error``, ``skip``, ``neg`` or ``pos``.
+        ValueError:
+            If ``ignore_index`` is not `None` or an integer.
+        ValueError:
+            If ``k`` parameter is not `None` or an integer larger than 0.
 
     Example:
         >>> from torchmetrics import RetrievalFallOut

torchmetrics/retrieval/retrieval_hit_rate.py

@@ -60,7 +60,11 @@ class RetrievalHitRate(RetrievalMetric):
 
     Raises:
         ValueError:
-            If ``k`` parameter is not `None` or an integer larger than 0
+            If ``empty_target_action`` is not one of ``error``, ``skip``, ``neg`` or ``pos``.
+        ValueError:
+            If ``ignore_index`` is not `None` or an integer.
+        ValueError:
+            If ``k`` parameter is not `None` or an integer larger than 0.
 
     Example:
         >>> from torchmetrics import RetrievalHitRate

torchmetrics/retrieval/retrieval_metric.py

@@ -63,6 +63,12 @@ class RetrievalMetric(Metric, ABC):
         dist_sync_fn:
             Callback that performs the allgather operation on the metric state. When `None`, DDP
             will be used to perform the allgather.
+
+    Raises:
+        ValueError:
+            If ``empty_target_action`` is not one of ``error``, ``skip``, ``neg`` or ``pos``.
+        ValueError:
+            If ``ignore_index`` is not `None` or an integer.
     """
 
     indexes: List[Tensor]

torchmetrics/retrieval/retrieval_ndcg.py

@@ -60,7 +60,11 @@ class RetrievalNormalizedDCG(RetrievalMetric):
 
     Raises:
         ValueError:
-            If ``k`` parameter is not `None` or an integer larger than 0
+            If ``empty_target_action`` is not one of ``error``, ``skip``, ``neg`` or ``pos``.
+        ValueError:
+            If ``ignore_index`` is not `None` or an integer.
+        ValueError:
+            If ``k`` parameter is not `None` or an integer larger than 0.
 
     Example:
         >>> from torchmetrics import RetrievalNormalizedDCG

torchmetrics/retrieval/retrieval_precision.py

@@ -60,7 +60,11 @@ class RetrievalPrecision(RetrievalMetric):
 
     Raises:
         ValueError:
-            If ``k`` parameter is not `None` or an integer larger than 0
+            If ``empty_target_action`` is not one of ``error``, ``skip``, ``neg`` or ``pos``.
+        ValueError:
+            If ``ignore_index`` is not `None` or an integer.
+        ValueError:
+            If ``k`` parameter is not `None` or an integer larger than 0.
 
     Example:
         >>> from torchmetrics import RetrievalPrecision

torchmetrics/retrieval/retrieval_r_precision.py

@@ -55,6 +55,12 @@ class RetrievalRPrecision(RetrievalMetric):
             Callback that performs the allgather operation on the metric state. When `None`, DDP
             will be used to perform the allgather.
 
+    Raises:
+        ValueError:
+            If ``empty_target_action`` is not one of ``error``, ``skip``, ``neg`` or ``pos``.
+        ValueError:
+            If ``ignore_index`` is not `None` or an integer.
+
     Example:
         >>> from torchmetrics import RetrievalRPrecision
         >>> indexes = tensor([0, 0, 0, 1, 1, 1, 1])

torchmetrics/retrieval/retrieval_recall.py

@@ -60,7 +60,11 @@ class RetrievalRecall(RetrievalMetric):
 
     Raises:
         ValueError:
-            If ``k`` parameter is not `None` or an integer larger than 0
+            If ``empty_target_action`` is not one of ``error``, ``skip``, ``neg`` or ``pos``.
+        ValueError:
+            If ``ignore_index`` is not `None` or an integer.
+        ValueError:
+            If ``k`` parameter is not `None` or an integer larger than 0.
 
     Example:
         >>> from torchmetrics import RetrievalRecall