@@ -37,17 +37,14 @@ def __init__(
37
37
Mean average precision is the computed by taking the mean of this average precision over different classes
38
38
and possibly some additional dimensions in the detection task.
39
39
40
- For detection tasks user should use downstream metrics like
41
- :class:`~ignite.metrics.vision.object_detection_map.ObjectDetectionMAP` or subclass this metric and implement
42
- its :meth:`_do_matching` method to provide the metric with desired matching logic. Then this method is called
43
- internally in :meth:`update` method on prediction-target pairs. For classification, all the binary, multiclass
44
- and multilabel data are supported. In the latter case, ``classification_is_multilabel`` should be set to true.
40
+ For detection tasks, user should use downstream metrics like
41
+ :class:`~ignite.metrics.vision.object_detection_map.ObjectDetectionMAP`. For classification, all the binary,
42
+ multiclass and multilabel data are supported. In the latter case, ``classification_is_multilabel`` should be
43
+ set to true.
45
44
46
45
`mean` in the mean average precision accounts for mean of the average precision across classes. ``class_mean``
47
46
determines how to take this mean. In the detection tasks, it's possible to take mean of the average precision
48
- in other respects as well e.g. IoU threshold in an object detection task. To this end, average precision
49
- corresponding to each value of IoU thresholds should get measured in :meth:`_do_matching`. Please refer to
50
- :meth:`_do_matching` for more info on this.
47
+ in other respects as well e.g. IoU threshold in an object detection task.
51
48
52
49
Args:
53
50
rec_thresholds: recall thresholds (sensivity levels) to be considered for computing Mean Average Precision.
@@ -317,8 +314,9 @@ def update(self, output: Union[Tuple[Any, Any], Tuple[torch.Tensor, torch.Tensor
317
314
"""Metric update function using prediction and target.
318
315
319
316
Args:
320
- output: a binary tuple. It should consist of prediction and target tensors in the classification case but
321
- for detection it is the same as the implemented-by-user :meth:`_do_matching`.
317
+ output: a binary tuple. It should consist of prediction and target tensors in the classification case.
318
+ for detection, user should refer to the desired subclass metric e.g.
319
+ :meth:`~ignite.metrics.vision.object_detection_map.ObjectDetectionMAP.update`
322
320
323
321
For classification, this metric follows the same rules on ``output`` members shape as the
324
322
:meth:`Precision.update <precision.Precision.update>` except for ``y_pred`` of binary and multilabel
0 commit comments