[Refactor]fix sunrgb lyft doc (#1833)

* fix the doc

* resolve comments

* fix doct

docs/en/advanced_guides/datasets/lyft_det.md

@@ -78,38 +78,48 @@ mmdetection3d
 │   │   ├── lyft_infos_train.pkl
 │   │   ├── lyft_infos_val.pkl
 │   │   ├── lyft_infos_test.pkl
-│   │   ├── lyft_infos_train_mono3d.coco.json
-│   │   ├── lyft_infos_val_mono3d.coco.json
-│   │   ├── lyft_infos_test_mono3d.coco.json
 ```
 
-Here, .pkl files are generally used for methods involving point clouds, and coco-style .json files are more suitable for image-based methods, such as image-based 2D and 3D detection.
-Different from nuScenes, we only support using the json files for 2D detection experiments. Image-based 3D detection may be further supported in the future.
+- `lyft_infos_train.pkl`: training dataset, a dict contains two keys: `metainfo` and `data_list`.
+  `metainfo` contains the basic information for the dataset itself, such as `CLASSES` and `version`, while `data_list` is a list of dict, each dict ( hereinafter referred to as`info`) contains all the detailed information of single sample as follows:
+  - info\['sample_idx'\]: The index of this sample in the whole dataset.
+  - info\['token'\]: Sample data token.
+  - info\['timestamp'\]: Timestamp of the sample data.
+  - info\['lidar_points'\]: A dict contains all the information related to the lidar points.
+    - info\['lidar_points'\]\['lidar_path'\]: The filename of the lidar point cloud data.
+    - info\['lidar_points'\]\['lidar2ego'\]: The transformation matrix from this lidar sensor to ego vehicle. (4x4 list)
+    - info\['lidar_points'\]\['ego2global'\]: The transformation matrix from the ego vehicle to global coordinates. (4x4 list)
+  - info\['lidar_sweeps'\]: A list contains sweeps information (The intermediate lidar frames without annotations)
+    - info\['lidar_sweeps'\]\[i\]\['lidar_points'\]\['data_path'\]: The lidar data path of i-th sweep.
+    - info\['lidar_sweeps'\]\[i\]\['lidar_points'\]\['lidar2ego'\]: The transformation matrix from this lidar sensor to ego vehicle in i-th sweep timestamp
+    - info\['lidar_sweeps'\]\[i\]\['lidar_points'\]\['ego2global'\]: The transformation matrix from the ego vehicle in i-th sweep timestamp to global coordinates. (4x4 list)
+    - info\['lidar_sweeps'\]\[i\]\['lidar2sensor'\]: The transformation matrix from the the lidar (for collecting the i-th sweep data) to the lidar collecting the key/sample data. (4x4 list)
+    - info\['lidar_sweeps'\]\[i\]\['timestamp'\]: Timestamp of the sweep data.
+    - info\['lidar_sweeps'\]\[i\]\['sample_data_token'\]: The sweep sample data token.
+  - info\['images'\]: A dict contains six keys corresponding to each camera: `'CAM_FRONT'`, `'CAM_FRONT_RIGHT'`, `'CAM_FRONT_LEFT'`, `'CAM_BACK'`, `'CAM_BACK_LEFT'`, `'CAM_BACK_RIGHT'`. Each dict contains all data information related to  corresponding camera.
+    - info\['images'\]\['CAM_XXX'\]\['img_path'\]: Filename of image.
+    - info\['images'\]\['CAM_XXX'\]\['cam2img'\]: The transformation matrix recording the intrinsic parameters when projecting 3D points to each image plane. (3x3 list)
+    - info\['images'\]\['CAM_XXX'\]\['sample_data_token'\]: Sample data token of image.
+    - info\['images'\]\['CAM_XXX'\]\['timestamp'\]: Timestamp of the image.
+    - info\['images'\]\['CAM_XXX'\]\['cam2ego'\]: The transformation matrix from this camera sensor to ego vehicle. (4x4 list)
+    - info\['images'\]\['CAM_XXX'\]\['lidar2cam'\]: The transformation matrix from lidar sensor to this camera. (4x4 list)
+  - info\['instances'\]: It is a list of dict. Each dict contains all annotation information of single instance.
+    - info\['instances'\]\['bbox_3d'\]: List of 7 numbers representing the 3D bounding box in lidar coordinate system of the instance, in (x, y, z, l, w, h, yaw) order.
+    - info\['instances'\]\['bbox_label_3d'\]: A int starting from 0 indicates the label of instance, while the -1 indicates ignore class.
+    - info\['instances'\]\['bbox_3d_isvalid'\]: Whether each bounding box is valid. In general, we only take the 3D boxes that include at least one lidar or radar point as valid boxes.
 
 Next, we will elaborate on the difference compared to nuScenes in terms of the details recorded in these info files.
 
 - without `lyft_database/xxxxx.bin`: This folder and `.bin` files are not extracted on the Lyft dataset due to the negligible effect of ground-truth sampling in the experiments.
-- `lyft_infos_train.pkl`: training dataset infos, each frame info has two keys: `metadata` and `infos`.
-  `metadata` contains the basic information for the dataset itself, such as `{'version': 'v1.01-train'}`, while `infos` contains the detailed information the same as nuScenes except for the following details:
-  - info\['sweeps'\]: Sweeps information.
-    - info\['sweeps'\]\[i\]\['type'\]: The sweep data type, e.g., `'lidar'`.
-      Lyft has different LiDAR settings for some samples, but we always take only the points collected by the top LiDAR for the consistency of data distribution.
-  - info\['gt_names'\]: There are 9 categories on the Lyft dataset, and the imbalance of annotations for different categories is even more significant than nuScenes.
-  - without info\['gt_velocity'\]: There is no velocity measurement on Lyft.
-  - info\['num_lidar_pts'\]: Set to -1 by default.
-  - info\['num_radar_pts'\]: Set to 0 by default.
-  - without info\['valid_flag'\]: This flag does recorded due to invalid `num_lidar_pts` and `num_radar_pts`.
-- `nuscenes_infos_train_mono3d.coco.json`: training dataset coco-style info. This file only contains 2D information, without the information required by 3D detection, such as camera intrinsics.
-  - info\['images'\]: A list containing all the image info.
-    - only containing `'file_name'`, `'id'`, `'width'`, `'height'`.
-  - info\['annotations'\]: A list containing all the annotation info.
-    - only containing `'file_name'`, `'image_id'`, `'area'`, `'category_name'`, `'category_id'`, `'bbox'`, `'is_crowd'`, `'segmentation'`, `'id'`, where `'is_crowd'`, `'segmentation'` are set to `0` and `[]` by default.
-      There is no attribute annotation on Lyft.
-
-Here we only explain the data recorded in the training info files. The same applies to the testing set.
-
-The core function to get `lyft_infos_xxx.pkl` is [\_fill_trainval_infos](https://github.com/open-mmlab/mmdetection3d/blob/master/tools/dataset_converters/lyft_converter.py#L93).
-Please refer to [lyft_converter.py](https://github.com/open-mmlab/mmdetection3d/blob/master/tools/dataset_converters/lyft_converter.py) for more details.
+
+- `lyft_infos_train.pkl`:
+
+  - Without info\['instances'\]\['velocity'\], There is no velocity measurement on Lyft.
+  - Without info\['instances'\]\['num_lidar_pts'\] and info\['instances'\]\['num_radar_pts'\]
+
+Here we only explain the data recorded in the training info files. The same applies to the validation set and test set(without instances).
+
+Please refer to [lyft_converter.py](https://github.com/open-mmlab/mmdetection3d/blob/dev-1.x/tools/dataset_converters/lyft_converter.py) for more details about the structure of `lyft_infos_xxx.pkl`.
 
 ## Training pipeline
 
@@ -124,11 +134,11 @@ train_pipeline = [
         coord_type='LIDAR',
         load_dim=5,
         use_dim=5,
-        file_client_args=file_client_args),
+        ),
     dict(
         type='LoadPointsFromMultiSweeps',
         sweeps_num=10,
-        file_client_args=file_client_args),
+        ),
     dict(type='LoadAnnotations3D', with_bbox_3d=True, with_label_3d=True),
     dict(
         type='GlobalRotScaleTrans',
@@ -139,8 +149,9 @@ train_pipeline = [
     dict(type='PointsRangeFilter', point_cloud_range=point_cloud_range),
     dict(type='ObjectRangeFilter', point_cloud_range=point_cloud_range),
     dict(type='PointShuffle'),
-    dict(type='DefaultFormatBundle3D', class_names=class_names),
-    dict(type='Collect3D', keys=['points', 'gt_bboxes_3d', 'gt_labels_3d'])
+    dict(
+        type='Pack3DDetInputs',
+        keys=['points', 'gt_bboxes_3d', 'gt_labels_3d'])
 ]
 ```
 
@@ -153,7 +164,7 @@ where the first 3 dimensions refer to point coordinates, and the last refers to
 An example to evaluate PointPillars with 8 GPUs with Lyft metrics is as follows.
 
 ```shell
-bash ./tools/dist_test.sh configs/pointpillars/pointpillars_hv_fpn_sbn-all_8xb2-2x_lyft-3d.py checkpoints/hv_pointpillars_fpn_sbn-all_2x8_2x_lyft-3d_20210517_202818-fc6904c3.pth 8 --eval bbox
+bash ./tools/dist_test.sh configs/pointpillars/pointpillars_hv_fpn_sbn-all_8xb2-2x_lyft-3d.py checkpoints/hv_pointpillars_fpn_sbn-all_2x8_2x_lyft-3d_20210517_202818-fc6904c3.pth 8
 ```
 
 ## Metrics
@@ -189,7 +200,7 @@ We employ this official method for evaluation on Lyft. An example of printed eva
 An example to test PointPillars on Lyft with 8 GPUs and generate a submission to the leaderboard is as follows.
 
 ```shell
-./tools/dist_test.sh configs/pointpillars/pointpillars_hv_fpn_sbn-all_8xb2-2x_lyft-3d.py work_dirs/pp-lyft/latest.pth 8 --out work_dirs/pp-lyft/results_challenge.pkl --format-only --eval-options 'jsonfile_prefix=work_dirs/pp-lyft/results_challenge' 'csv_savepath=results/pp-lyft/results_challenge.csv'
+./tools/dist_test.sh configs/pointpillars/pointpillars_hv_fpn_sbn-all_8xb2-2x_lyft-3d.py work_dirs/pp-lyft/latest.pth 8 --cfg-options test_evaluator.jsonfile_prefix=work_dirs/pp-lyft/results_challenge  test_evaluator.csv_savepath=results/pp-lyft/results_challenge.csv
 ```
 
 After generating the `work_dirs/pp-lyft/results_challenge.csv`, you can submit it to the Kaggle evaluation server. Please refer to the [official website](https://www.kaggle.com/c/3d-object-detection-for-autonomous-vehicles) for more information.

docs/en/advanced_guides/datasets/scannet_det.md

@@ -226,11 +226,12 @@ scannet
 - `semantic_mask/xxxxx.bin`: The semantic label for each point, value range: \[1, 40\], i.e. `nyu40id` standard. Note: the `nyu40id` ID will be mapped to train ID in train pipeline `PointSegClassMapping`.
 - `posed_images/scenexxxx_xx`: The set of `.jpg` images with `.txt` 4x4 poses and the single `.txt` file with camera intrinsic matrix.
 - `scannet_infos_train.pkl`: The train data infos, the detailed info of each scan is as follows:
-  - info\['lidar_points'\]\['lidar_path'\]: The filename of `xxx.bin` of lidar points.
-  - info\['lidar_points'\]\['num_pts_feats'\]: The feature dimension of point.
-  - info\['lidar_points'\]\['pts_semantic_mask_path'\]: The filename of `xxx.bin` contains semantic mask annotation.
-  - info\['lidar_points'\]\['pts_instance_mask_path'\]: The filename of `xxx.bin` contains semantic mask annotation.
-  - info\['lidar_points'\]\['axis_align_matrix'\]: The transformation matrix to align the axis.
+  - info\['lidar_points'\]: A dict contains all information relate to the the lidar points.
+    - info\['lidar_points'\]\['lidar_path'\]: The filename of `xxx.bin` of lidar points.
+    - info\['lidar_points'\]\['num_pts_feats'\]: The feature dimension of point.
+    - info\['lidar_points'\]\['axis_align_matrix'\]: The transformation matrix to align the axis.
+  - info\['pts_semantic_mask_path'\]: The filename of `xxx.bin` contains semantic mask annotation.
+  - info\['pts_instance_mask_path'\]: The filename of `xxx.bin` contains semantic mask annotation.
   - info\['instances'\]: A list of dict contains all annotations, each dict contains all annotation information of single instance.
     - info\['instances'\]\[i\]\['bbox_3d'\]: List of 6 numbers representing the axis-aligned 3D bounding box of the instance in depth coordinate system, in (x, y, z, l, w, h) order.
     - info\['instances'\]\[i\]\['bbox_label_3d'\]: The label of each 3d bounding boxes.

docs/en/advanced_guides/datasets/sunrgbd_det.md

@@ -133,94 +133,7 @@ or (if in a slurm environment)
 bash tools/create_data.sh <job_name> sunrgbd
 ```
 
-The above point cloud data are further saved in `.bin` format. Meanwhile `.pkl` info files are also generated for saving annotation and metadata. The core function `process_single_scene` of getting data infos is as follows.
-
-```python
-def process_single_scene(sample_idx):
-    print(f'{self.split} sample_idx: {sample_idx}')
-    # convert depth to points
-    # and downsample the points
-    SAMPLE_NUM = 50000
-    pc_upright_depth = self.get_depth(sample_idx)
-    pc_upright_depth_subsampled = random_sampling(
-        pc_upright_depth, SAMPLE_NUM)
-
-    info = dict()
-    pc_info = {'num_features': 6, 'lidar_idx': sample_idx}
-    info['point_cloud'] = pc_info
-
-    # save point cloud data in `.bin` format
-    mmengine.mkdir_or_exist(osp.join(self.root_dir, 'points'))
-    pc_upright_depth_subsampled.tofile(
-        osp.join(self.root_dir, 'points', f'{sample_idx:06d}.bin'))
-
-    # save point cloud file path
-    info['pts_path'] = osp.join('points', f'{sample_idx:06d}.bin')
-
-    # save image file path and metainfo
-    img_path = osp.join('image', f'{sample_idx:06d}.jpg')
-    image_info = {
-        'image_idx': sample_idx,
-        'image_shape': self.get_image_shape(sample_idx),
-        'image_path': img_path
-    }
-    info['image'] = image_info
-
-    # save calibration information
-    K, Rt = self.get_calibration(sample_idx)
-    calib_info = {'K': K, 'Rt': Rt}
-    info['calib'] = calib_info
-
-    # save all annotation
-    if has_label:
-        obj_list = self.get_label_objects(sample_idx)
-        annotations = {}
-        annotations['gt_num'] = len([
-            obj.classname for obj in obj_list
-            if obj.classname in self.cat2label.keys()
-        ])
-        if annotations['gt_num'] != 0:
-            # class name
-            annotations['name'] = np.array([
-                obj.classname for obj in obj_list
-                if obj.classname in self.cat2label.keys()
-            ])
-            # 2D image bounding boxes
-            annotations['bbox'] = np.concatenate([
-                obj.box2d.reshape(1, 4) for obj in obj_list
-                if obj.classname in self.cat2label.keys()
-            ], axis=0)
-            # 3D bounding box center location (in depth coordinate system)
-            annotations['location'] = np.concatenate([
-                obj.centroid.reshape(1, 3) for obj in obj_list
-                if obj.classname in self.cat2label.keys()
-            ], axis=0)
-            # 3D bounding box dimension/size (in depth coordinate system)
-            annotations['dimensions'] = 2 * np.array([
-                [obj.l, obj.h, obj.w] for obj in obj_list
-                if obj.classname in self.cat2label.keys()
-            ])
-            # 3D bounding box rotation angle/yaw angle (in depth coordinate system)
-            annotations['rotation_y'] = np.array([
-                obj.heading_angle for obj in obj_list
-                if obj.classname in self.cat2label.keys()
-            ])
-            annotations['index'] = np.arange(
-                len(obj_list), dtype=np.int32)
-            # class label (number)
-            annotations['class'] = np.array([
-                self.cat2label[obj.classname] for obj in obj_list
-                if obj.classname in self.cat2label.keys()
-            ])
-            # 3D bounding box (in depth coordinate system)
-            annotations['gt_boxes_upright_depth'] = np.stack(
-                [
-                    obj.box3d for obj in obj_list
-                    if obj.classname in self.cat2label.keys()
-                ], axis=0)  # (K,8)
-        info['annos'] = annotations
-    return info
-```
+The above point cloud data are further saved in `.bin` format. Meanwhile `.pkl` info files are also generated for saving annotation and metadata.
 
 The directory structure after processing should be as follows.
 
@@ -240,22 +153,19 @@ sunrgbd
 
 - `points/0xxxxx.bin`: The point cloud data after downsample.
 - `sunrgbd_infos_train.pkl`: The train data infos, the detailed info of each scene is as follows:
-  - info\['point_cloud'\]: `·`{'num_features': 6, 'lidar_idx': sample_idx}`, where `sample_idx\` is the index of the scene.
-  - info\['pts_path'\]: The path of `points/0xxxxx.bin`.
-  - info\['image'\]: The image path and metainfo:
-    - image\['image_idx'\]: The index of the image.
-    - image\['image_shape'\]: The shape of the image tensor.
-    - image\['image_path'\]: The path of the image.
-  - info\['annos'\]: The annotations of each scene.
-    - annotations\['gt_num'\]: The number of ground truths.
-    - annotations\['name'\]: The semantic name of all ground truths, e.g. `chair`.
-    - annotations\['location'\]: The gravity center of the 3D bounding boxes in depth coordinate system. Shape: \[K, 3\], K is the number of ground truths.
-    - annotations\['dimensions'\]: The dimensions of the 3D bounding boxes in depth coordinate system, i.e. `(x_size, y_size, z_size)`, shape: \[K, 3\].
-    - annotations\['rotation_y'\]: The yaw angle of the 3D bounding boxes in depth coordinate system. Shape: \[K, \].
-    - annotations\['gt_boxes_upright_depth'\]: The 3D bounding boxes in depth coordinate system, each bounding box is `(x, y, z, x_size, y_size, z_size, yaw)`, shape: \[K, 7\].
-    - annotations\['bbox'\]: The 2D bounding boxes, each bounding box is `(x, y, x_size, y_size)`, shape: \[K, 4\].
-    - annotations\['index'\]: The index of all ground truths, range \[0, K).
-    - annotations\['class'\]: The train class id of the bounding boxes, value range: \[0, 10), shape: \[K, \].
+  - info\['lidar_points'\]: A dict contains all information relate to the the lidar points.
+    - info\['lidar_points'\]\['num_pts_feats'\]: The feature dimension of point.
+    - info\['lidar_points'\]\['lidar_path'\]: The filename of `xxx.bin` of lidar points.
+  - info\['images'\]: A dict contains all information relate to the image data.
+    - info\['images'\]\['CAM0'\]\['img_path'\]: The image file name.
+    - info\['images'\]\['CAM0'\]\['depth2img'\]: Transformation matrix from depth to image with shape (4, 4).
+    - info\['images'\]\['CAM0'\]\['height'\]: The height of image.
+    - info\['images'\]\['CAM0'\]\['width'\]: The width of image.
+  - info\['instances'\]: A list of dict contains all the annotations of this frame. Each dict corresponds to annotations of single instance.
+    - info\['instances'\]\['bbox_3d'\]: List of 7 numbers representing the 3D bounding box in depth coordinate system.
+    - info\['instances'\]\['bbox'\]: List of 4 numbers representing the 2D bounding box of the instance, in (x1, y1, x2, y2) order.
+    - info\['instances'\]\['bbox_label_3d'\]: An int indicates the 3D label of instance and the -1 indicates ignore class.
+    - info\['instances'\]\['bbox_label'\]: An int indicates the 2D label of instance and the -1 indicates ignore class.
 - `sunrgbd_infos_val.pkl`: The val data infos, which shares the same format as `sunrgbd_infos_train.pkl`.
 
 ## Train pipeline
@@ -282,8 +192,9 @@ train_pipeline = [
         scale_ratio_range=[0.85, 1.15],
         shift_height=True),
     dict(type='PointSample', num_points=20000),
-    dict(type='DefaultFormatBundle3D', class_names=class_names),
-    dict(type='Collect3D', keys=['points', 'gt_bboxes_3d', 'gt_labels_3d'])
+    dict(
+        type='Pack3DDetInputs',
+        keys=['points', 'gt_bboxes_3d', 'gt_labels_3d'])
 ]
 ```
 
@@ -306,9 +217,8 @@ train_pipeline = [
     dict(type='LoadImageFromFile'),
     dict(type='LoadAnnotations3D'),
     dict(type='LoadAnnotations', with_bbox=True),
-    dict(type='Resize', img_scale=(1333, 600), keep_ratio=True),
+    dict(type='Resize', scale=(1333, 600), keep_ratio=True),
     dict(type='RandomFlip', flip_ratio=0.0),
-    dict(type='Normalize', **img_norm_cfg),
     dict(type='Pad', size_divisor=32),
     dict(
         type='RandomFlip3D',
@@ -320,28 +230,21 @@ train_pipeline = [
         rot_range=[-0.523599, 0.523599],
         scale_ratio_range=[0.85, 1.15],
         shift_height=True),
-    dict(type='PointSample', num_points=20000),
-    dict(type='DefaultFormatBundle3D', class_names=class_names),
     dict(
-        type='Collect3D',
-        keys=[
-            'img', 'gt_bboxes', 'gt_labels', 'points', 'gt_bboxes_3d',
-            'gt_labels_3d'
-        ])
+        type='Pack3DDetInputs',
+        keys=['points', 'gt_bboxes_3d', 'gt_labels_3d','img', 'gt_bboxes', 'gt_bboxes_labels', ])
 ]
 ```
 
 Data augmentation/normalization for images:
 
 - `Resize`: resize the input image, `keep_ratio=True` means the ratio of the image is kept unchanged.
-- `Normalize`: normalize the RGB channels of the input image.
 - `RandomFlip`: randomly flip the input image.
-- `Pad`: pad the input image with zeros by default.
 
 The image augmentation and normalization functions are implemented in [MMDetection](https://github.com/open-mmlab/mmdetection/tree/master/mmdet/datasets/pipelines).
 
 ## Metrics
 
-Same as ScanNet, typically mean Average Precision (mAP) is used for evaluation on SUN RGB-D, e.g. `mAP@0.25` and `mAP@0.5`. In detail, a generic function to compute precision and recall for 3D object detection for multiple classes is called, please refer to [indoor_eval](https://github.com/open-mmlab/mmdetection3d/blob/master/mmdet3d/core/evaluation/indoor_eval.py).
+Same as ScanNet, typically mean Average Precision (mAP) is used for evaluation on SUN RGB-D, e.g. `mAP@0.25` and `mAP@0.5`. In detail, a generic function to compute precision and recall for 3D object detection for multiple classes is called, please refer to [indoor_eval](https://github.com/open-mmlab/mmdetection3d/blob/dev-1.x/mmdet3d/evaluation/functional/indoor_eval.py).
 
 Since SUN RGB-D consists of image data, detection on image data is also feasible. For instance, in ImVoteNet, we first train an image detector, and we also use mAP for evaluation, e.g. `mAP@0.5`. We use the `eval_map` function from [MMDetection](https://github.com/open-mmlab/mmdetection) to calculate mAP.