Skip to content

GitLab

"vscode:/vscode.git/clone" did not exist on "703ef6d79a17c1065fcacc8ad2cffa31d04f19b2"
Unverified Commit 009d5d6e authored by Shilong Zhang's avatar Shilong Zhang Committed by GitHub
Browse files

[Doc]: refactor doc directory (#1743) 

* refactor en doc dir

* add rst for en

* fix rest

* add chs

* fix lint
parent 6fa8850e
Show whitespace changes
Inline Side-by-side
Showing with 126 additions and 28 deletions
docs/zh_cn/faq.md → docs/zh_cn/notes/faq.md
View file @ 009d5d6e
...@@ -4,6 +4,37 @@ ...@@ -4,6 +4,37 @@
## MMCV/MMDet/MMDet3D Installation ## MMCV/MMDet/MMDet3D Installation
- 跟 MMCV, MMDetection, MMSegmentation 和 MMDetection3D 相关的编译问题; "ConvWS is already registered in conv layer"; "AssertionError: MMCV==xxx is used but incompatible. Please install mmcv>=xxx, \<=xxx."
MMDetection3D 需要的 MMCV, MMDetection 和 MMSegmentation 的版本列在了下面。请安装正确版本的 MMCV、MMDetection 和 MMSegmentation 以避免相关的安装问题。
| MMDetection3D version | MMDetection version | MMSegmentation version | MMCV version |
| :-------------------: | :----------------------: | :---------------------: | :-------------------------: |
| master | mmdet>=2.24.0, \<=3.0.0 | mmseg>=0.20.0, \<=1.0.0 | mmcv-full>=1.5.2, \<=1.7.0 |
| v1.0.0rc4 | mmdet>=2.24.0, \<=3.0.0 | mmseg>=0.20.0, \<=1.0.0 | mmcv-full>=1.5.2, \<=1.7.0 |
| v1.0.0rc3 | mmdet>=2.24.0, \<=3.0.0 | mmseg>=0.20.0, \<=1.0.0 | mmcv-full>=1.4.8, \<=1.6.0 |
| v1.0.0rc2 | mmdet>=2.24.0, \<=3.0.0 | mmseg>=0.20.0, \<=1.0.0 | mmcv-full>=1.4.8, \<=1.6.0 |
| v1.0.0rc1 | mmdet>=2.19.0, \<=3.0.0 | mmseg>=0.20.0, \<=1.0.0 | mmcv-full>=1.4.8, \<=1.5.0 |
| v1.0.0rc0 | mmdet>=2.19.0, \<=3.0.0 | mmseg>=0.20.0, \<=1.0.0 | mmcv-full>=1.3.17, \<=1.5.0 |
| 0.18.1 | mmdet>=2.19.0, \<=3.0.0 | mmseg>=0.20.0, \<=1.0.0 | mmcv-full>=1.3.17, \<=1.5.0 |
| 0.18.0 | mmdet>=2.19.0, \<=3.0.0 | mmseg>=0.20.0, \<=1.0.0 | mmcv-full>=1.3.17, \<=1.5.0 |
| 0.17.3 | mmdet>=2.14.0, \<=3.0.0 | mmseg>=0.14.1, \<=1.0.0 | mmcv-full>=1.3.8, \<=1.4.0 |
| 0.17.2 | mmdet>=2.14.0, \<=3.0.0 | mmseg>=0.14.1, \<=1.0.0 | mmcv-full>=1.3.8, \<=1.4.0 |
| 0.17.1 | mmdet>=2.14.0, \<=3.0.0 | mmseg>=0.14.1, \<=1.0.0 | mmcv-full>=1.3.8, \<=1.4.0 |
| 0.17.0 | mmdet>=2.14.0, \<=3.0.0 | mmseg>=0.14.1, \<=1.0.0 | mmcv-full>=1.3.8, \<=1.4.0 |
| 0.16.0 | mmdet>=2.14.0, \<=3.0.0 | mmseg>=0.14.1, \<=1.0.0 | mmcv-full>=1.3.8, \<=1.4.0 |
| 0.15.0 | mmdet>=2.14.0, \<=3.0.0 | mmseg>=0.14.1, \<=1.0.0 | mmcv-full>=1.3.8, \<=1.4.0 |
| 0.14.0 | mmdet>=2.10.0, \<=2.11.0 | mmseg==0.14.0 | mmcv-full>=1.3.1, \<=1.4.0 |
| 0.13.0 | mmdet>=2.10.0, \<=2.11.0 | Not required | mmcv-full>=1.2.4, \<=1.4.0 |
| 0.12.0 | mmdet>=2.5.0, \<=2.11.0 | Not required | mmcv-full>=1.2.4, \<=1.4.0 |
| 0.11.0 | mmdet>=2.5.0, \<=2.11.0 | Not required | mmcv-full>=1.2.4, \<=1.3.0 |
| 0.10.0 | mmdet>=2.5.0, \<=2.11.0 | Not required | mmcv-full>=1.2.4, \<=1.3.0 |
| 0.9.0 | mmdet>=2.5.0, \<=2.11.0 | Not required | mmcv-full>=1.2.4, \<=1.3.0 |
| 0.8.0 | mmdet>=2.5.0, \<=2.11.0 | Not required | mmcv-full>=1.1.5, \<=1.3.0 |
| 0.7.0 | mmdet>=2.5.0, \<=2.11.0 | Not required | mmcv-full>=1.1.5, \<=1.3.0 |
| 0.6.0 | mmdet>=2.4.0, \<=2.11.0 | Not required | mmcv-full>=1.1.3, \<=1.2.0 |
| 0.5.0 | 2.3.0 | Not required | mmcv-full==1.0.5 |
- 如果您在 `import open3d` 时遇到下面的问题： - 如果您在 `import open3d` 时遇到下面的问题：
`OSError: /lib/x86_64-linux-gnu/libm.so.6: version 'GLIBC_2.27' not found` `OSError: /lib/x86_64-linux-gnu/libm.so.6: version 'GLIBC_2.27' not found`
......
docs/zh_cn/notes/index.rst 0 → 100644
View file @ 009d5d6e
.. toctree::
:maxdepth: 3
benchmarks.md
changelog.md
compatibility.md
faq.md
docs/zh_cn/2_new_data_model.md → docs/zh_cn/user_guides/2_new_data_model.md
View file @ 009d5d6e
...@@ -68,7 +68,7 @@ KITTI 官方提供的目标检测开发[工具包](https://s3.eu-central-1.amazo ...@@ -68,7 +68,7 @@ KITTI 官方提供的目标检测开发[工具包](https://s3.eu-central-1.amazo
接下来本文将对 Waymo 数据集原始格式进行转换。 接下来本文将对 Waymo 数据集原始格式进行转换。
首先需要将下载的 Waymo 数据集的数据文件和标注文件转换到 KITTI 数据集的格式，接着定义一个从 KittiDataset 类继承而来的 WaymoDataset 类，来帮助数据的加载、模型的训练和评估。 首先需要将下载的 Waymo 数据集的数据文件和标注文件转换到 KITTI 数据集的格式，接着定义一个从 KittiDataset 类继承而来的 WaymoDataset 类，来帮助数据的加载、模型的训练和评估。
具体来说，首先使用[数据转换器](https://github.com/open-mmlab/mmdetection3d/blob/master/tools/dataset_converters/waymo_converter.py)将 Waymo 数据集转换成 KITTI 数据集的格式，并定义 [Waymo 类](https://github.com/open-mmlab/mmdetection3d/blob/master/mmdet3d/datasets/waymo_dataset.py)对转换的数据进行处理。因为我们将 Waymo 原始数据集进行预处理并重新组织成 KITTI 数据集的格式，因此可以比较容易通过继承 KittiDataset 类来实现 WaymoDataset 类。需要注意的是，由于 Waymo 数据集有相应的官方评估方法，我们需要在定义新数据类的过程中引入官方评估方法，此时用户可以顺利的转换 Waymo 数据的格式，并使用 `WaymoDataset` 数据类进行模型的训练和评估。 具体来说，首先使用[数据转换器](https://github.com/open-mmlab/mmdetection3d/blob/master/tools/data_converter/waymo_converter.py)将 Waymo 数据集转换成 KITTI 数据集的格式，并定义 [Waymo 类](https://github.com/open-mmlab/mmdetection3d/blob/master/mmdet3d/datasets/waymo_dataset.py)对转换的数据进行处理。因为我们将 Waymo 原始数据集进行预处理并重新组织成 KITTI 数据集的格式，因此可以比较容易通过继承 KittiDataset 类来实现 WaymoDataset 类。需要注意的是，由于 Waymo 数据集有相应的官方评估方法，我们需要在定义新数据类的过程中引入官方评估方法，此时用户可以顺利的转换 Waymo 数据的格式，并使用 `WaymoDataset` 数据类进行模型的训练和评估。
更多关于 Waymo 数据集预处理的中间结果的细节，请参照对应的[说明文档](https://mmdetection3d.readthedocs.io/zh_CN/latest/datasets/waymo_det.html)。 更多关于 Waymo 数据集预处理的中间结果的细节，请参照对应的[说明文档](https://mmdetection3d.readthedocs.io/zh_CN/latest/datasets/waymo_det.html)。
......
docs/zh_cn/tutorials/backends_support.md → docs/zh_cn/user_guides/backends_support.md
View file @ 009d5d6e
...@@ -111,7 +111,7 @@ model = dict( ...@@ -111,7 +111,7 @@ model = dict(
```python ```python
# replace the path with your checkpoint path on Ceph # replace the path with your checkpoint path on Ceph
load_from = 's3://openmmlab/checkpoints/mmdetection3d/v0.1.0_models/pointpillars/hv_pointpillars_secfpn_6x8_160e_kitti-3d-car/hv_pointpillars_secfpn_6x8_160e_kitti-3d-car_20200620_230614-77663cd6.pth.pth' load_from = 's3://openmmlab/checkpoints/mmdetection3d/v0.1.0_models/pointpillars/hv_pointpillars_secfpn_6x8_160e_kitti-3d-car/hv_pointpillars_secfpn_6x8_160e_kitti-3d-car_20200620_230614-77663cd6.pth'
resume_from = None resume_from = None
workflow = [('train', 1)] workflow = [('train', 1)]
``` ```
...@@ -149,6 +149,6 @@ log_config = dict( ...@@ -149,6 +149,6 @@ log_config = dict(
log_config = dict( log_config = dict(
interval=50, interval=50,
hooks=[ hooks=[
dict(type='TextLoggerHook', out_dir='s3://openmmlab/mmdetection3d'', keep_local=False), dict(type='TextLoggerHook', out_dir='s3://openmmlab/mmdetection3d', keep_local=False),
]) ])
``` ```
docs/zh_cn/tutorials/config.md → docs/zh_cn/user_guides/config.md
View file @ 009d5d6e
...@@ -117,7 +117,7 @@ model = dict( ...@@ -117,7 +117,7 @@ model = dict(
[0.50867593, 0.50656086, 0.30136237], [0.50867593, 0.50656086, 0.30136237],
[1.1511526, 1.0546296, 0.49706793], [1.1511526, 1.0546296, 0.49706793],
[0.47535285, 0.49249494, 0.5802117]]), # 每一类的平均尺寸，其顺序与类名顺序相同 [0.47535285, 0.49249494, 0.5802117]]), # 每一类的平均尺寸，其顺序与类名顺序相同
vote_moudule_cfg=dict( # 投票 (vote) 模块的配置，更多细节请参考 mmdet3d.models.layers vote_moudule_cfg=dict( # 投票 (vote) 模块的配置，更多细节请参考 mmdet3d.models.model_utils
in_channels=256, # 投票模块的输入通道数 in_channels=256, # 投票模块的输入通道数
vote_per_seed=1, # 对于每个种子点生成的投票数 vote_per_seed=1, # 对于每个种子点生成的投票数
gt_per_seed=3, # 每个种子点的真实标签个数 gt_per_seed=3, # 每个种子点的真实标签个数
...@@ -187,77 +187,77 @@ class_names = ('cabinet', 'bed', 'chair', 'sofa', 'table', 'door', 'window', ...@@ -187,77 +187,77 @@ class_names = ('cabinet', 'bed', 'chair', 'sofa', 'table', 'door', 'window',
'bookshelf', 'picture', 'counter', 'desk', 'curtain', 'bookshelf', 'picture', 'counter', 'desk', 'curtain',
'refrigerator', 'showercurtrain', 'toilet', 'sink', 'bathtub', 'refrigerator', 'showercurtrain', 'toilet', 'sink', 'bathtub',
'garbagebin') # 类的名称 'garbagebin') # 类的名称
train_pipeline = [ # 训练流水线，更多细节请参考 mmdet3d.datasets.transforms train_pipeline = [ # 训练流水线，更多细节请参考 mmdet3d.datasets.pipelines
dict( dict(
type='LoadPointsFromFile', # 第一个流程，用于读取点，更多细节请参考 mmdet3d.datasets.transforms.indoor_loading type='LoadPointsFromFile', # 第一个流程，用于读取点，更多细节请参考 mmdet3d.datasets.pipelines.indoor_loading
shift_height=True, # 是否使用变换高度 shift_height=True, # 是否使用变换高度
load_dim=6, # 读取的点的维度 load_dim=6, # 读取的点的维度
use_dim=[0, 1, 2]), # 使用所读取点的哪些维度 use_dim=[0, 1, 2]), # 使用所读取点的哪些维度
dict( dict(
type='LoadAnnotations3D', # 第二个流程，用于读取标注，更多细节请参考 mmdet3d.datasets.transforms.indoor_loading type='LoadAnnotations3D', # 第二个流程，用于读取标注，更多细节请参考 mmdet3d.datasets.pipelines.indoor_loading
with_bbox_3d=True, # 是否读取 3D 框 with_bbox_3d=True, # 是否读取 3D 框
with_label_3d=True, # 是否读取 3D 框对应的类别标签 with_label_3d=True, # 是否读取 3D 框对应的类别标签
with_mask_3d=True, # 是否读取 3D 实例分割掩码 with_mask_3d=True, # 是否读取 3D 实例分割掩码
with_seg_3d=True), # 是否读取 3D 语义分割掩码 with_seg_3d=True), # 是否读取 3D 语义分割掩码
dict( dict(
type='PointSegClassMapping', # 选取有效的类别，更多细节请参考 mmdet3d.datasets.transforms.point_seg_class_mapping type='PointSegClassMapping', # 选取有效的类别，更多细节请参考 mmdet3d.datasets.pipelines.point_seg_class_mapping
valid_cat_ids=(3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 16, 24, 28, 33, 34, valid_cat_ids=(3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 16, 24, 28, 33, 34,
36, 39), # 所有有效类别的编号 36, 39), # 所有有效类别的编号
max_cat_id=40), # 输入语义分割掩码中可能存在的最大类别编号 max_cat_id=40), # 输入语义分割掩码中可能存在的最大类别编号
dict(type='PointSample', # 室内点采样，更多细节请参考 mmdet3d.datasets.transforms.indoor_sample dict(type='PointSample', # 室内点采样，更多细节请参考 mmdet3d.datasets.pipelines.indoor_sample
num_points=40000), # 采样的点的数量 num_points=40000), # 采样的点的数量
dict(type='IndoorFlipData', # 数据增广流程，随机翻转点和 3D 框 dict(type='IndoorFlipData', # 数据增广流程，随机翻转点和 3D 框
flip_ratio_yz=0.5, # 沿着 yz 平面被翻转的概率 flip_ratio_yz=0.5, # 沿着 yz 平面被翻转的概率
flip_ratio_xz=0.5), # 沿着 xz 平面被翻转的概率 flip_ratio_xz=0.5), # 沿着 xz 平面被翻转的概率
dict( dict(
type='IndoorGlobalRotScale', # 数据增广流程，旋转并放缩点和 3D 框，更多细节请参考 mmdet3d.datasets.transforms.indoor_augment type='IndoorGlobalRotScale', # 数据增广流程，旋转并放缩点和 3D 框，更多细节请参考 mmdet3d.datasets.pipelines.indoor_augment
shift_height=True, # 读取的点是否有高度这一属性 shift_height=True, # 读取的点是否有高度这一属性
rot_range=[-0.027777777777777776, 0.027777777777777776], # 旋转角范围 rot_range=[-0.027777777777777776, 0.027777777777777776], # 旋转角范围
scale_range=None), # 缩放尺寸范围 scale_range=None), # 缩放尺寸范围
dict( dict(
type='DefaultFormatBundle3D', # 默认格式打包以收集读取的所有数据，更多细节请参考 mmdet3d.datasets.transforms.formatting type='DefaultFormatBundle3D', # 默认格式打包以收集读取的所有数据，更多细节请参考 mmdet3d.datasets.pipelines.formatting
class_names=('cabinet', 'bed', 'chair', 'sofa', 'table', 'door', class_names=('cabinet', 'bed', 'chair', 'sofa', 'table', 'door',
'window', 'bookshelf', 'picture', 'counter', 'desk', 'window', 'bookshelf', 'picture', 'counter', 'desk',
'curtain', 'refrigerator', 'showercurtrain', 'toilet', 'curtain', 'refrigerator', 'showercurtrain', 'toilet',
'sink', 'bathtub', 'garbagebin')), 'sink', 'bathtub', 'garbagebin')),
dict( dict(
type='Collect3D', # 最后一个流程，决定哪些键值对应的数据会被输入给检测器，更多细节请参考 mmdet3d.datasets.transforms.formatting type='Collect3D', # 最后一个流程，决定哪些键值对应的数据会被输入给检测器，更多细节请参考 mmdet3d.datasets.pipelines.formatting
keys=[ keys=[
'points', 'gt_bboxes_3d', 'gt_labels_3d', 'pts_semantic_mask', 'points', 'gt_bboxes_3d', 'gt_labels_3d', 'pts_semantic_mask',
'pts_instance_mask' 'pts_instance_mask'
]) ])
] ]
test_pipeline = [ # 测试流水线，更多细节请参考 mmdet3d.datasets.transforms test_pipeline = [ # 测试流水线，更多细节请参考 mmdet3d.datasets.pipelines
dict( dict(
type='LoadPointsFromFile', # 第一个流程，用于读取点，更多细节请参考 mmdet3d.datasets.transforms.indoor_loading type='LoadPointsFromFile', # 第一个流程，用于读取点，更多细节请参考 mmdet3d.datasets.pipelines.indoor_loading
shift_height=True, # 是否使用变换高度 shift_height=True, # 是否使用变换高度
load_dim=6, # 读取的点的维度 load_dim=6, # 读取的点的维度
use_dim=[0, 1, 2]), # 使用所读取点的哪些维度 use_dim=[0, 1, 2]), # 使用所读取点的哪些维度
dict(type='PointSample', # 室内点采样，更多细节请参考 mmdet3d.datasets.transforms.indoor_sample dict(type='PointSample', # 室内点采样，更多细节请参考 mmdet3d.datasets.pipelines.indoor_sample
num_points=40000), # 采样的点的数量 num_points=40000), # 采样的点的数量
dict( dict(
type='DefaultFormatBundle3D', # 默认格式打包以收集读取的所有数据，更多细节请参考 mmdet3d.datasets.transforms.formatting type='DefaultFormatBundle3D', # 默认格式打包以收集读取的所有数据，更多细节请参考 mmdet3d.datasets.pipelines.formatting
class_names=('cabinet', 'bed', 'chair', 'sofa', 'table', 'door', class_names=('cabinet', 'bed', 'chair', 'sofa', 'table', 'door',
'window', 'bookshelf', 'picture', 'counter', 'desk', 'window', 'bookshelf', 'picture', 'counter', 'desk',
'curtain', 'refrigerator', 'showercurtrain', 'toilet', 'curtain', 'refrigerator', 'showercurtrain', 'toilet',
'sink', 'bathtub', 'garbagebin')), 'sink', 'bathtub', 'garbagebin')),
dict(type='Collect3D', # 最后一个流程，决定哪些键值对应的数据会被输入给检测器，更多细节请参考 mmdet3d.datasets.transforms.formatting dict(type='Collect3D', # 最后一个流程，决定哪些键值对应的数据会被输入给检测器，更多细节请参考 mmdet3d.datasets.pipelines.formatting
keys=['points']) keys=['points'])
] ]
eval_pipeline = [ # 模型验证或可视化所使用的流水线，更多细节请参考 mmdet3d.datasets.transforms eval_pipeline = [ # 模型验证或可视化所使用的流水线，更多细节请参考 mmdet3d.datasets.pipelines
dict( dict(
type='LoadPointsFromFile', # 第一个流程，用于读取点，更多细节请参考 mmdet3d.datasets.transforms.indoor_loading type='LoadPointsFromFile', # 第一个流程，用于读取点，更多细节请参考 mmdet3d.datasets.pipelines.indoor_loading
shift_height=True, # 是否使用变换高度 shift_height=True, # 是否使用变换高度
load_dim=6, # 读取的点的维度 load_dim=6, # 读取的点的维度
use_dim=[0, 1, 2]), # 使用所读取点的哪些维度 use_dim=[0, 1, 2]), # 使用所读取点的哪些维度
dict( dict(
type='DefaultFormatBundle3D', # 默认格式打包以收集读取的所有数据，更多细节请参考 mmdet3d.datasets.transforms.formatting type='DefaultFormatBundle3D', # 默认格式打包以收集读取的所有数据，更多细节请参考 mmdet3d.datasets.pipelines.formatting
class_names=('cabinet', 'bed', 'chair', 'sofa', 'table', 'door', class_names=('cabinet', 'bed', 'chair', 'sofa', 'table', 'door',
'window', 'bookshelf', 'picture', 'counter', 'desk', 'window', 'bookshelf', 'picture', 'counter', 'desk',
'curtain', 'refrigerator', 'showercurtrain', 'toilet', 'curtain', 'refrigerator', 'showercurtrain', 'toilet',
'sink', 'bathtub', 'garbagebin')), 'sink', 'bathtub', 'garbagebin')),
with_label=False), with_label=False),
dict(type='Collect3D', # 最后一个流程，决定哪些键值对应的数据会被输入给检测器，更多细节请参考 mmdet3d.datasets.transforms.formatting dict(type='Collect3D', # 最后一个流程，决定哪些键值对应的数据会被输入给检测器，更多细节请参考 mmdet3d.datasets.pipelines.formatting
keys=['points']) keys=['points'])
] ]
data = dict( data = dict(
...@@ -423,7 +423,7 @@ gpu_ids = range(0, 1) # 所使用的 GPU 编号 ...@@ -423,7 +423,7 @@ gpu_ids = range(0, 1) # 所使用的 GPU 编号
```python ```python
model = dict( model = dict(
type='MVXFasterRCNN', type='MVXFasterRCNN',
data_preprocessor=dict(voxel_layer=dict(...)), pts_voxel_layer=dict(...),
pts_voxel_encoder=dict(...), pts_voxel_encoder=dict(...),
pts_middle_encoder=dict(...), pts_middle_encoder=dict(...),
pts_backbone=dict(...), pts_backbone=dict(...),
......
docs/zh_cn/tutorials/coord_sys_tutorial.md → docs/zh_cn/user_guides/coord_sys_tutorial.md
View file @ 009d5d6e
...@@ -7,6 +7,7 @@ MMDetection3D 使用 3 种不同的坐标系。3D 目标检测领域中不同坐 ...@@ -7,6 +7,7 @@ MMDetection3D 使用 3 种不同的坐标系。3D 目标检测领域中不同坐
尽管数据集和采集设备多种多样，但是通过总结 3D 目标检测的工作线，我们可以将坐标系大致分为三类： 尽管数据集和采集设备多种多样，但是通过总结 3D 目标检测的工作线，我们可以将坐标系大致分为三类：
- 相机坐标系 -- 大多数相机的坐标系，在该坐标系中 y 轴正方向指向地面，x 轴正方向指向右侧，z 轴正方向指向前方。 - 相机坐标系 -- 大多数相机的坐标系，在该坐标系中 y 轴正方向指向地面，x 轴正方向指向右侧，z 轴正方向指向前方。
``` ```
上 z 前 上 z 前
| ^ | ^
...@@ -22,7 +23,9 @@ MMDetection3D 使用 3 种不同的坐标系。3D 目标检测领域中不同坐 ...@@ -22,7 +23,9 @@ MMDetection3D 使用 3 种不同的坐标系。3D 目标检测领域中不同坐
v v
y 下 y 下
``` ```
- 激光雷达坐标系 -- 众多激光雷达的坐标系，在该坐标系中 z 轴负方向指向地面，x 轴正方向指向前方，y 轴正方向指向左侧。 - 激光雷达坐标系 -- 众多激光雷达的坐标系，在该坐标系中 z 轴负方向指向地面，x 轴正方向指向前方，y 轴正方向指向左侧。
``` ```
z 上 x 前 z 上 x 前
^ ^ ^ ^
...@@ -32,7 +35,9 @@ MMDetection3D 使用 3 种不同的坐标系。3D 目标检测领域中不同坐 ...@@ -32,7 +35,9 @@ MMDetection3D 使用 3 种不同的坐标系。3D 目标检测领域中不同坐
|/ |/
y 左 <------ 0 ------ 右 y 左 <------ 0 ------ 右
``` ```
- 深度坐标系 -- VoteNet、H3DNet 等模型使用的坐标系，在该坐标系中 z 轴负方向指向地面，x 轴正方向指向右侧，y 轴正方向指向前方。 - 深度坐标系 -- VoteNet、H3DNet 等模型使用的坐标系，在该坐标系中 z 轴负方向指向地面，x 轴正方向指向右侧，y 轴正方向指向前方。
``` ```
z 上 y 前 z 上 y 前
^ ^ ^ ^
...@@ -132,7 +137,7 @@ __|____|____|____|_________\ x 右 ...@@ -132,7 +137,7 @@ __|____|____|____|_________\ x 右
### KITTI ### KITTI
KITTI 数据集的原始标注是在相机坐标系下的，详见 [get_label_anno](https://github.com/open-mmlab/mmdetection3d/blob/master/tools/dataset_converters/kitti_data_utils.py)。在 MMDetection3D 中，为了在 KITTI 数据集上训练基于激光雷达的模型，首先将数据从相机坐标系转换到激光雷达坐标，详见 [get_ann_info](https://github.com/open-mmlab/mmdetection3d/blob/master/mmdet3d/datasets/kitti_dataset.py)。对于训练基于视觉的模型，数据保持在相机坐标系不变。 KITTI 数据集的原始标注是在相机坐标系下的，详见 [get_label_anno](https://github.com/open-mmlab/mmdetection3d/blob/master/tools/data_converter/kitti_data_utils.py)。在 MMDetection3D 中，为了在 KITTI 数据集上训练基于激光雷达的模型，首先将数据从相机坐标系转换到激光雷达坐标，详见 [get_ann_info](https://github.com/open-mmlab/mmdetection3d/blob/master/mmdet3d/datasets/kitti_dataset.py)。对于训练基于视觉的模型，数据保持在相机坐标系不变。
在 SECOND 中，框的激光雷达坐标系定义如下（鸟瞰图）： 在 SECOND 中，框的激光雷达坐标系定义如下（鸟瞰图）：
...@@ -169,7 +174,7 @@ ScanNet 的原始数据不是点云而是网格，需要在我们的深度坐标 ...@@ -169,7 +174,7 @@ ScanNet 的原始数据不是点云而是网格，需要在我们的深度坐标
SUN RGB-D 的原始数据不是点云而是 RGB-D 图像。我们通过反投影，可以得到每张图像对应的点云，其在我们的深度坐标系下。但是，数据集的标注并不在我们的系统中，所以需要进行转换。 SUN RGB-D 的原始数据不是点云而是 RGB-D 图像。我们通过反投影，可以得到每张图像对应的点云，其在我们的深度坐标系下。但是，数据集的标注并不在我们的系统中，所以需要进行转换。
将原始标注转换为我们的深度坐标系下的标注的转换过程请参考 [sunrgbd_data_utils.py](https://github.com/open-mmlab/mmdetection3d/blob/master/tools/dataset_converters/sunrgbd_data_utils.py)。 将原始标注转换为我们的深度坐标系下的标注的转换过程请参考 [sunrgbd_data_utils.py](https://github.com/open-mmlab/mmdetection3d/blob/master/tools/data_converter/sunrgbd_data_utils.py)。
### S3DIS ### S3DIS
...@@ -215,7 +220,7 @@ SUN RGB-D 的原始数据不是点云而是 RGB-D 图像。我们通过反投影 ...@@ -215,7 +220,7 @@ SUN RGB-D 的原始数据不是点云而是 RGB-D 图像。我们通过反投影
#### Q1: 与框相关的算子是否适用于所有坐标系类型？ #### Q1: 与框相关的算子是否适用于所有坐标系类型？
否。例如，[用于 RoI-Aware Pooling 的算子](https://github.com/open-mmlab/mmcv/blob/master/mmcv/ops/roiaware_pool3d.py)只适用于深度坐标系和激光雷达坐标系下的框。由于如果从上方看，旋转是顺时针的，所以 KITTI 数据集[这里](https://github.com/open-mmlab/mmdetection3d/blob/master/mmdet3d/core/evaluation/kitti_utils)的评估函数仅适用于相机坐标系下的框。 否。例如，[用于 RoI-Aware Pooling 的算子](https://github.com/open-mmlab/mmcv/blob/master/mmcv/ops/roiaware_pool3d.py)只适用于深度坐标系和激光雷达坐标系下的框。由于如果从上方看，旋转是顺时针的，所以 KITTI 数据集[这里](https://github.com/open-mmlab/mmdetection3d/blob/master/mmdet3d/core/evaluation/kitti_utils.py)的评估函数仅适用于相机坐标系下的框。
对于每个和框相关的算子，我们注明了其所适用的框类型。 对于每个和框相关的算子，我们注明了其所适用的框类型。
......
docs/zh_cn/data_preparation.md → docs/zh_cn/user_guides/dataset_prepare.md
View file @ 009d5d6e
...@@ -121,7 +121,7 @@ python tools/create_data.py nuscenes --root-path ./data/nuscenes --out-dir ./dat ...@@ -121,7 +121,7 @@ python tools/create_data.py nuscenes --root-path ./data/nuscenes --out-dir ./dat
```bash ```bash
python tools/create_data.py lyft --root-path ./data/lyft --out-dir ./data/lyft --extra-tag lyft --version v1.01 python tools/create_data.py lyft --root-path ./data/lyft --out-dir ./data/lyft --extra-tag lyft --version v1.01
python tools/dataset_converters/lyft_data_fixer.py --version v1.01 --root-folder ./data/lyft python tools/data_converter/lyft_data_fixer.py --version v1.01 --root-folder ./data/lyft
``` ```
注意，为了文件结构的清晰性，我们遵从了 Lyft 数据原先的文件夹名称。请按照上面展示出的文件结构对原始文件夹进行重命名。 注意，为了文件结构的清晰性，我们遵从了 Lyft 数据原先的文件夹名称。请按照上面展示出的文件结构对原始文件夹进行重命名。
......
docs/zh_cn/tutorials/index.rst → docs/zh_cn/user_guides/index.rst
View file @ 009d5d6e
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 3
1_exist_data_model.md
2_new_data_model.md
backends_support.md
config.md config.md
customize_dataset.md
data_pipeline.md
customize_models.md
customize_runtime.md
coord_sys_tutorial.md coord_sys_tutorial.md
backends_support.md data_pipeline.md
data_prepare.md
demo.md
index.rst
model_deployment.md
useful_tools.md
docs/zh_cn/useful_tools.md → docs/zh_cn/user_guides/useful_tools.md
View file @ 009d5d6e
...@@ -256,12 +256,12 @@ python tools/model_converters/publish_model.py work_dirs/faster_rcnn/latest.pth ...@@ -256,12 +256,12 @@ python tools/model_converters/publish_model.py work_dirs/faster_rcnn/latest.pth
# 数据集转换 # 数据集转换
`tools/dataset_converters/` 包含转换数据集为其他格式的一些工具。其中大多数转换数据集为基于 pickle 的信息文件，比如 KITTI，nuscense 和 lyft。Waymo 转换器被用来重新组织 waymo 原始数据为 KITTI 风格。用户能够参考它们了解我们转换数据格式的方法。将它们修改为 nuImages 转换器等脚本也很方便。 `tools/data_converter/` 包含转换数据集为其他格式的一些工具。其中大多数转换数据集为基于 pickle 的信息文件，比如 KITTI，nuscense 和 lyft。Waymo 转换器被用来重新组织 waymo 原始数据为 KITTI 风格。用户能够参考它们了解我们转换数据格式的方法。将它们修改为 nuImages 转换器等脚本也很方便。
为了转换 nuImages 数据集为 COCO 格式，请使用下面的指令： 为了转换 nuImages 数据集为 COCO 格式，请使用下面的指令：
```shell ```shell
python -u tools/dataset_converters/nuimage_converter.py --data-root ${DATA_ROOT} --version ${VERSIONS} \ python -u tools/data_converter/nuimage_converter.py --data-root ${DATA_ROOT} --version ${VERSIONS} \
--out-dir ${OUT_DIR} --nproc ${NUM_WORKERS} --extra-tag ${TAG} --out-dir ${OUT_DIR} --nproc ${NUM_WORKERS} --extra-tag ${TAG}
``` ```
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment