doc patch

mmdet3d/ops/roiaware_pool3d/points_in_boxes.py

@@ -4,7 +4,7 @@ from . import roiaware_pool3d_ext
 
 
 def points_in_boxes_gpu(points, boxes):
-    """find points in boxes (CUDA)
+    """Find points that are in boxes (CUDA)
 
     Args:
         points (torch.Tensor): [B, M, 3], [x, y, z] in LiDAR coordinate
@@ -29,7 +29,10 @@ def points_in_boxes_gpu(points, boxes):
 
 
 def points_in_boxes_cpu(points, boxes):
-    """find points in boxes (CPU)
+    """Find points that are in boxes (CPU)
+
+    Note: Currently, the output of this function is different from that of
+        points_in_boxes_gpu.
 
     Args:
         points (torch.Tensor): [npoints, 3]
@@ -39,6 +42,7 @@ def points_in_boxes_cpu(points, boxes):
     Returns:
         point_indices (torch.Tensor): (N, npoints)
     """
+    # TODO: Refactor this function as a CPU version of points_in_boxes_gpu
     assert boxes.shape[1] == 7
     assert points.shape[1] == 3