Improve documentation for NMS (#2159)

* Improve documentation for NMS * update nms doc for special case

Improve documentation for NMS (#2159)
* Improve documentation for NMS * update nms doc for special case
f8f131a3 · Fahri Ali Rahman · GitHub · f9ef235c · f8f131a3
Unverified Commit f8f131a3 authored May 04, 2020 by Fahri Ali Rahman Committed by GitHub May 04, 2020
Hide whitespace changes
Inline Side-by-side

Showing with 5 additions and 0 deletions

torchvision/ops/boxes.py torchvision/ops/boxes.py +5 -0

No files found.
--- a/torchvision/ops/boxes.py
+++ b/torchvision/ops/boxes.py
@@ -14,6 +14,11 @@ def nms(boxes, scores, iou_threshold):
    IoU greater than iou_threshold with another (higher scoring)
    box.

+    If multiple boxes have the exact same score and satisfy the IoU 
+    criterion with respect to a reference box, the selected box is 
+    not guaranteed to be the same between CPU and GPU. This is similar 
+    to the behavior of argsort in PyTorch when repeated values are present.
+
    Parameters
    ----------
    boxes : Tensor[N, 4])