Skip to content

GitLab

You need to sign in or sign up before continuing.
Commit 13ba0dca authored by Xiangxu-0103's avatar Xiangxu-0103 Committed by ZwwWayne
Browse files

[Docs] Update getting started (#2076) 

* Update getting_started.md

* Update getting_started.md
parent 0f825f7c
Hide whitespace changes
Inline Side-by-side
Showing with 73 additions and 74 deletions
docs/en/getting_started.md
View file @ 13ba0dca
# Prerequisites # Prerequisites
In this section we demonstrate how to prepare an environment with PyTorch. In this section we demonstrate how to prepare an environment with PyTorch.
MMDection3D works on Linux, Windows (experimental support) and macOS and requires the following packages: MMDetection3D works on Linux, Windows (experimental support) and macOS and requires the following packages:
- Python 3.6+ - Python 3.6+
- PyTorch 1.6+ - PyTorch 1.6+
- CUDA 9.2+ (If you build PyTorch from source, CUDA 9.0 is also compatible) - CUDA 9.2+ (If you build PyTorch from source, CUDA 9.0 is also compatible)
- GCC 5+ - GCC 5+
- [MMEngine](https://mmengine.readthedocs.io/en/latest/#installation) - [MMEngine](https://mmengine.readthedocs.io/en/latest/#installation)
- [MMCV](https://mmcv.readthedocs.io/en/latest/#installation) - [MMCV](https://mmcv.readthedocs.io/en/2.x/#installation)
```{note} ```{note}
If you are experienced with PyTorch and have already installed it, just skip this part and jump to the [next section](#installation). Otherwise, you can follow these steps for the preparation. If you are experienced with PyTorch and have already installed it, just skip this part and jump to the [next section](#installation). Otherwise, you can follow these steps for the preparation.
...@@ -49,7 +49,7 @@ Assuming that you already have CUDA 11.0 installed, here is a full script for qu ...@@ -49,7 +49,7 @@ Assuming that you already have CUDA 11.0 installed, here is a full script for qu
Otherwise, you should refer to the step-by-step installation instructions in the next section. Otherwise, you should refer to the step-by-step installation instructions in the next section.
```shell ```shell
pip install openmim pip install -U openmim
mim install mmengine mim install mmengine
mim install 'mmcv>=2.0.0rc0' mim install 'mmcv>=2.0.0rc0'
mim install 'mmdet>=3.0.0rc0' mim install 'mmdet>=3.0.0rc0'
...@@ -100,10 +100,10 @@ pip install -v -e . # or "python setup.py develop" ...@@ -100,10 +100,10 @@ pip install -v -e . # or "python setup.py develop"
Note: Note:
1. The git commit id will be written to the version number with step 4, e.g. 0.6.0+2e7045c. The version will also be saved in trained models. 1. The git commit id will be written to the version number with step 3, e.g. `0.6.0+2e7045c`. The version will also be saved in trained models.
It is recommended that you run step d each time you pull some updates from github. If C++/CUDA codes are modified, then this step is compulsory. It is recommended that you run step 3 each time you pull some updates from github. If C++/CUDA codes are modified, then this step is compulsory.
> Important: Be sure to remove the `./build` folder if you reinstall mmdet with a different CUDA/PyTorch version. > Important: Be sure to remove the `./build` folder if you reinstall mmdet3d with a different CUDA/PyTorch version.
```shell ```shell
pip uninstall mmdet3d pip uninstall mmdet3d
...@@ -118,7 +118,7 @@ Note: ...@@ -118,7 +118,7 @@ Note:
4. Some dependencies are optional. Simply running `pip install -v -e .` will only install the minimum runtime requirements. To use optional dependencies like `albumentations` and `imagecorruptions` either install them manually with `pip install -r requirements/optional.txt` or specify desired extras when calling `pip` (e.g. `pip install -v -e .[optional]`). Valid keys for the extras field are: `all`, `tests`, `build`, and `optional`. 4. Some dependencies are optional. Simply running `pip install -v -e .` will only install the minimum runtime requirements. To use optional dependencies like `albumentations` and `imagecorruptions` either install them manually with `pip install -r requirements/optional.txt` or specify desired extras when calling `pip` (e.g. `pip install -v -e .[optional]`). Valid keys for the extras field are: `all`, `tests`, `build`, and `optional`.
We have supported `spconv 2.0`. If the user has installed `spconv 2.0`, the code will use `spconv 2.0` first, which will take up less GPU memory than using the default `mmcv spconv`. Users can use the following commands to install `spcon v2.0`: We have supported `spconv 2.0`. If the user has installed `spconv 2.0`, the code will use `spconv 2.0` first, which will take up less GPU memory than using the default `mmcv spconv`. Users can use the following commands to install `spconv 2.0`:
```bash ```bash
pip install cumm-cuxxx pip install cumm-cuxxx
...@@ -156,7 +156,7 @@ Examples: ...@@ -156,7 +156,7 @@ Examples:
python demo/pcd_demo.py demo/data/kitti/000008.bin configs/second/second_hv_secfpn_8xb6-80e_kitti-3d-car.py checkpoints/second_hv_secfpn_8xb6-80e_kitti-3d-car_20200620_230238-393f000c.pth python demo/pcd_demo.py demo/data/kitti/000008.bin configs/second/second_hv_secfpn_8xb6-80e_kitti-3d-car.py checkpoints/second_hv_secfpn_8xb6-80e_kitti-3d-car_20200620_230238-393f000c.pth
``` ```
If you want to input a `.ply` file, you can use the following function and convert it to `.bin` format. Then you can use the converted `.bin` file to generate demo. If you want to input a `.ply` file, you can use the following function and convert it to `.bin` format. Then you can use the converted `.bin` file to run demo.
Note that you need to install `pandas` and `plyfile` before using this script. This function can also be used for data preprocessing for training `ply data`. Note that you need to install `pandas` and `plyfile` before using this script. This function can also be used for data preprocessing for training `ply data`.
```python ```python
...@@ -182,7 +182,7 @@ Examples: ...@@ -182,7 +182,7 @@ Examples:
convert_ply('./test.ply', './test.bin') convert_ply('./test.ply', './test.bin')
``` ```
If you have point clouds in other format (`.off`, `.obj`, etc.), you can use `trimesh` to convert them into `ply`. If you have point clouds in other format (`.off`, `.obj`, etc.), you can use `trimesh` to convert them into `.ply`.
```python ```python
import trimesh import trimesh
...@@ -219,7 +219,7 @@ Installing CUDA runtime libraries is enough if you follow our best practices, be ...@@ -219,7 +219,7 @@ Installing CUDA runtime libraries is enough if you follow our best practices, be
To install MMEngine with pip instead of MIM, please follow [MMEngine installation guides](https://mmengine.readthedocs.io/en/latest/get_started/installation.html). To install MMEngine with pip instead of MIM, please follow [MMEngine installation guides](https://mmengine.readthedocs.io/en/latest/get_started/installation.html).
For example, you can install MMEngine by the following command. For example, you can install MMEngine by the following command:
```shell ```shell
pip install mmengine pip install mmengine
...@@ -229,9 +229,9 @@ pip install mmengine ...@@ -229,9 +229,9 @@ pip install mmengine
MMCV contains C++ and CUDA extensions, thus depending on PyTorch in a complex way. MIM solves such dependencies automatically and makes the installation easier. However, it is not a must. MMCV contains C++ and CUDA extensions, thus depending on PyTorch in a complex way. MIM solves such dependencies automatically and makes the installation easier. However, it is not a must.
To install MMCV with pip instead of MIM, please follow [MMCV installation guides](https://mmcv.readthedocs.io/en/latest/get_started/installation.html). This requires manually specifying a find-url based on PyTorch version and its CUDA version. To install MMCV with pip instead of MIM, please follow [MMCV installation guides](https://mmcv.readthedocs.io/en/2.x/get_started/installation.html). This requires manually specifying a find-url based on PyTorch version and its CUDA version.
For example, the following command install mmcv built for PyTorch 1.10.x and CUDA 11.3. For example, the following command install MMCV built for PyTorch 1.10.x and CUDA 11.3:
```shell ```shell
pip install mmcv -f https://download.openmmlab.com/mmcv/dist/cu113/torch1.10/index.html pip install mmcv -f https://download.openmmlab.com/mmcv/dist/cu113/torch1.10/index.html
...@@ -239,14 +239,14 @@ pip install mmcv -f https://download.openmmlab.com/mmcv/dist/cu113/torch1.10/ind ...@@ -239,14 +239,14 @@ pip install mmcv -f https://download.openmmlab.com/mmcv/dist/cu113/torch1.10/ind
### Using MMDetection3D with Docker ### Using MMDetection3D with Docker
We provide a [Dockerfile](https://github.com/open-mmlab/mmdetection3d/blob/master/docker/Dockerfile) to build an image. We provide a [Dockerfile](https://github.com/open-mmlab/mmdetection3d/blob/dev-1.x/docker/Dockerfile) to build an image.
```shell ```shell
# build an image with PyTorch 1.6, CUDA 10.1 # build an image with PyTorch 1.6, CUDA 10.1
docker build -t mmdetection3d -f docker/Dockerfile . docker build -t mmdetection3d -f docker/Dockerfile .
``` ```
Run it with Run it with:
```shell ```shell
docker run --gpus all --shm-size=8g -it -v {DATA_DIR}:/mmdetection3d/data mmdetection3d docker run --gpus all --shm-size=8g -it -v {DATA_DIR}:/mmdetection3d/data mmdetection3d
...@@ -254,19 +254,19 @@ docker run --gpus all --shm-size=8g -it -v {DATA_DIR}:/mmdetection3d/data mmdete ...@@ -254,19 +254,19 @@ docker run --gpus all --shm-size=8g -it -v {DATA_DIR}:/mmdetection3d/data mmdete
### A from-scratch setup script ### A from-scratch setup script
Here is a full script for setting up MMdetection3D with conda. Here is a full script for setting up MMDetection3D with conda.
```shell ```shell
# We recommend to install python=3.8 since the waymo-open-dataset-tf-2-6-0 requires python>=3.7 # We recommend to install python=3.8 since the waymo-open-dataset-tf-2-6-0 requires python>=3.7
# If you want to install python<3.7, make sure to install waymo-open-dataset-tf-2-x-0 (x<=4) # If you want to install python<3.7, make sure to install waymo-open-dataset-tf-2-x-0 (x<=4)
conda create -n open-mmlab python=3.8 -y conda create -n openmmlab python=3.8 -y
conda activate open-mmlab conda activate openmmlab
# install latest PyTorch prebuilt with the default prebuilt CUDA version (usually the latest) # install latest PyTorch prebuilt with the default prebuilt CUDA version (usually the latest)
conda install -c pytorch pytorch torchvision -y conda install -c pytorch pytorch torchvision -y
# install mmengine and mmcv # install mmengine and mmcv
pip install openmim pip install -U openmim
mim install mmengine mim install mmengine
mim install 'mmcv>=2.0.0rc0' mim install 'mmcv>=2.0.0rc0'
......
docs/zh_cn/getting_started.md
View file @ 13ba0dca
# 依赖 # 依赖
在本节中，我们将展示如何使用 PyTorch 准备环境。MMDetection3D 可以安装在 Linux, MacOS,（实验性支持 Windows）的平台上，它具体需要下列安装包: 在本节中，我们将展示如何使用 PyTorch 准备环境。MMDetection3D 支持在 Linux，Windows（实验性支持），MacOS 上运行，它具体需要下列安装包：
- Python 3.6+ - Python 3.6+
- PyTorch 1.6+ - PyTorch 1.6+
- CUDA 9.2+（如果你从源码编译 PyTorch, CUDA 9.0 也是兼容的。） - CUDA 9.2+（如果您从源码编译 PyTorch，CUDA 9.0 也是兼容的）
- GCC 5+ - GCC 5+
- [MMEngine](https://mmengine.readthedocs.io/zh_CN/latest/#installation) - [MMEngine](https://mmengine.readthedocs.io/zh_CN/latest/#installation)
- [MMCV](https://mmcv.readthedocs.io/zh_CN/latest/#installation) - [MMCV](https://mmcv.readthedocs.io/zh_CN/2.x/#installation)
```{note} ```{note}
如果你已经装了 pytorch，可以跳过这一部分，然后转到[下一章节](#安装)。如果没有，可以参照以下步骤安装环境。 如果您对 PyTorch 有经验并且已经安装了它，您可以直接跳转到[下一小节](#安装)。否则，您可以按照下述步骤进行准备。
``` ```
**步骤 0.** 从[官网](https://docs.conda.io/en/latest/miniconda.html)下载并安装 Miniconda。 **步骤 0.** 从[官方网站](https://docs.conda.io/en/latest/miniconda.html)下载并安装 Miniconda。
**步骤 1.** 使用 conda 新建虚拟环境，并进入该虚拟环境。 **步骤 1.** 创建并激活一个 conda 环境。
```shell ```shell
# 鉴于 waymo-open-dataset-tf-2-6-0 要求 python>=3.7，我们推荐安装 python3.8 # 鉴于 waymo-open-dataset-tf-2-6-0 要求 python>=3.7，我们推荐安装 python=3.8
# 如果您想要安装 python<3.7，之后须确保安装 waymo-open-dataset-tf-2-x-0 (x<=4) # 如果您想要安装 python<3.7，之后需确保安装 waymo-open-dataset-tf-2-x-0 (x<=4)
conda create --name openmmlab python=3.8 -y conda create --name openmmlab python=3.8 -y
conda activate openmmlab conda activate openmmlab
``` ```
**步骤 2.** 基于 [PyTorch 官网](https://pytorch.org/)安装 PyTorch，例如： **步骤 2.** 基于 [PyTorch 官方说明](https://pytorch.org/get-started/locally/)安装 PyTorch，例如：
GPU 环境下： 在 GPU 平台上：
```shell ```shell
conda install pytorch torchvision -c pytorch conda install pytorch torchvision -c pytorch
``` ```
CPU 环境下： 在 CPU 平台上：
```shell ```shell
conda install pytorch torchvision cpuonly -c pytorch conda install pytorch torchvision cpuonly -c pytorch
...@@ -40,14 +40,14 @@ conda install pytorch torchvision cpuonly -c pytorch ...@@ -40,14 +40,14 @@ conda install pytorch torchvision cpuonly -c pytorch
# 安装 # 安装
我们建议用户参照我们的最佳实践 MMDetection3D。不过，整个过程也是可定制化的，具体可参照[自定义安装章节](#%E8%87%AA%E5%AE%9A%E4%B9%89%E5%AE%89%E8%A3%85) 我们推荐用户参照我们的最佳实践安装 MMDetection3D。不过，整个过程也是可定制化的，更多信息请参考[自定义安装](#%E8%87%AA%E5%AE%9A%E4%B9%89%E5%AE%89%E8%A3%85)章节。
## 最佳实践 ## 最佳实践
如果你已经成功安装 CUDA 11.0，那么你可以使用这个快速安装命令进行 MMDetection3D 的安装。否则，则参考下一小节的详细安装流程。 假设您已经安装了 CUDA 11.0，此处提供了一个完整的脚本来使用 conda 快速安装 MMDetection3D。否则，您需要参考下一小节的详细安装说明。
```shell ```shell
pip install openmim pip install -U openmim
mim install mmengine mim install mmengine
mim install 'mmcv>=2.0.0rc0' mim install 'mmcv>=2.0.0rc0'
mim install 'mmdet>=3.0.0rc0' mim install 'mmdet>=3.0.0rc0'
...@@ -56,7 +56,7 @@ cd mmdetection3d ...@@ -56,7 +56,7 @@ cd mmdetection3d
pip install -e . pip install -e .
``` ```
**步骤 0.** 通过 [MIM](https://github.com/open-mmlab/mim) 安装 [MMEngine](https://github.com/open-mmlab/mmengine) 和 [MMCV](https://github.com/open-mmlab/mmcv)。 **步骤 0.** 使用 [MIM](https://github.com/open-mmlab/mim) 安装 [MMEngine](https://github.com/open-mmlab/mmengine) 和 [MMCV](https://github.com/open-mmlab/mmcv)。
```shell ```shell
pip install -U openmim pip install -U openmim
...@@ -70,14 +70,14 @@ mim install 'mmcv>=2.0.0rc0' ...@@ -70,14 +70,14 @@ mim install 'mmcv>=2.0.0rc0'
mim install 'mmdet>=3.0.0rc0' mim install 'mmdet>=3.0.0rc0'
``` ```
同时，如果你想修改这部分的代码，也可以通过以下命令从源码编译 MMDetection： 此外，如果您想修改这部分的代码，也可以从源码编译 MMDetection：
```shell ```shell
git clone https://github.com/open-mmlab/mmdetection.git -b dev-3.x git clone https://github.com/open-mmlab/mmdetection.git -b dev-3.x
# "-b dev-3.x" 表示切换到 `dev-3.x` 分支。 # "-b dev-3.x" 表示切换到 `dev-3.x` 分支。
cd mmdetection cd mmdetection
pip install -v -e . pip install -v -e .
# "-v" 表示更详细的信息输出 # "-v" 指详细说明，或更多的输出
# "-e" 表示以可编辑的模式安装项目 # "-e" 表示以可编辑的模式安装项目
# 因此本地对代码做的任何修改都会生效，而无需重新安装。 # 因此本地对代码做的任何修改都会生效，而无需重新安装。
``` ```
...@@ -90,7 +90,7 @@ git clone https://github.com/open-mmlab/mmdetection3d.git -b dev-1.x ...@@ -90,7 +90,7 @@ git clone https://github.com/open-mmlab/mmdetection3d.git -b dev-1.x
cd mmdetection3d cd mmdetection3d
``` ```
**步骤 4.** 安装依赖包和 MMDetection3D。 **步骤 3.** 安装依赖包和 MMDetection3D。
```shell ```shell
pip install -v -e . # 或者 "python setup.py develop" pip install -v -e . # 或者 "python setup.py develop"
...@@ -98,9 +98,9 @@ pip install -v -e . # 或者 "python setup.py develop" ...@@ -98,9 +98,9 @@ pip install -v -e . # 或者 "python setup.py develop"
注意： 注意：
1. Git 的 commit id 在步骤 d 将会被写入到版本号当中，例 0.6.0+2e7045c。版本号将保存在训练的模型里。推荐在每一次执行步骤 4 时，从 github 上获取最新的更新。如果基于 C++/CUDA 的代码被修改了，请执行以下步骤； 1. Git 的 commit id 在步骤 3 将会被写入到版本号当中，例如 `0.6.0+2e7045c`。版本号将保存在训练的模型里。我们推荐您每次从 github 上获取更新后都执行一次步骤 3。如果修改了 C++/CUDA 代码，那么执行该步骤是必要的。
> 重要: 如果你重装了不同版本的 CUDA 或者 PyTorch 的 mmdet，请务必移除 `./build` 文件。 > 重要：如果您使用了不同版本的 CUDA/PyTorch 重新安装 mmdet3d，需要移除 `./build` 文件夹。
```shell ```shell
pip uninstall mmdet3d pip uninstall mmdet3d
...@@ -108,39 +108,39 @@ pip install -v -e . # 或者 "python setup.py develop" ...@@ -108,39 +108,39 @@ pip install -v -e . # 或者 "python setup.py develop"
find . -name "*.so" | xargs rm find . -name "*.so" | xargs rm
``` ```
2. 按照上述说明，MMDetection3D 安装在 `dev` 模式下，因此在本地对代码做的任何修改都会生效，无需重新安装； 2. 按照上述说明，MMDetection3D 安装在 `dev` 模式下，因此在本地对代码做的任何修改都会生效，而无需重新安装（除非您提交了 commits 并且想要更新版本号）。
3. 如果希望使用 `opencv-python-headless` 而不是 `opencv-python`，可以在安装 MMCV 之前安装； 3. 如果您希望使用 `opencv-python-headless` 而不是 `opencv-python`，您可以在安装 MMCV 之前安装它。
4. 一些安装依赖是可以选择的。例如只需要安装最低运行要求的版本，则可以使用 `pip install -v -e .` 命令。如果希望使用可选择的像 `albumentations` 和 `imagecorruptions` 这种依赖项，可以使用 `pip install -r requirements/optional.txt` 进行手动安装，或者在使用 `pip` 时指定所需的附加功能（例如 `pip install -v -e .[optional]`），支持附加功能的有效键值包括 `all`、`tests`、`build` 以及 `optional`。 4. 一些安装依赖是可选的。简单地运行 `pip install -v -e .` 将会安装最低运行要求的版本。如果想要使用一些可选依赖项，例如 `albumentations` 和 `imagecorruptions`，可以使用 `pip install -r requirements/optional.txt` 进行手动安装，或者在使用 `pip` 时指定所需的附加功能（例如 `pip install -v -e .[optional]`），支持附加功能的有效键值包括 `all`、`tests`、`build` 以及 `optional`。
我们已经支持 `spconv 2.0`。如果用户已经安装 `spconv 2.0`，代码会默认使用 `spconv 2.0`。它可以比原生 `mmcv spconv` 使用更少的内存。用户可以使用下列的命令来安装 `spconv 2.0`. 我们已经支持 `spconv 2.0`。如果用户已经安装 `spconv 2.0`，代码会默认使用 `spconv 2.0`，它会比原生 `mmcv spconv` 使用更少的 GPU 内存。用户可以使用下列的命令来安装 `spconv 2.0`：
```bash ```bash
pip install cumm-cuxxx pip install cumm-cuxxx
pip install spconv-cuxxx pip install spconv-cuxxx
``` ```
`xxx` 表示 CUDA 的版本。 `xxx` 表示环境中的 CUDA 版本。
例如，使用 CUDA 10.2, 对应命令是 `pip install cumm-cu102 && pip install spconv-cu102`。 例如，使用 CUDA 10.2，对应命令是 `pip install cumm-cu102 && pip install spconv-cu102`。
支持的 CUDA 版本包括 10.2，11.1，11.3 和 11.4。用户可以通过源码编译来在这些版本上安装。具体细节请参考 [spconv v2.x](https://github.com/traveller59/spconv)。 支持的 CUDA 版本包括 10.2，11.1，11.3 和 11.4。用户也可以通过源码编译来安装。更多细节请参考[spconv v2.x](https://github.com/traveller59/spconv)。
我们同时也支持 `Minkowski Engine` 来作为稀疏卷积的后端。如果需要，可以参照[安装指南](https://github.com/NVIDIA/MinkowskiEngine#installation)或使用 `pip` 来安装： 我们也支持 `Minkowski Engine` 作为稀疏卷积的后端。如果需要，请参考[安装指南](https://github.com/NVIDIA/MinkowskiEngine#installation) 或者使用 `pip` 来安装：
```shell ```shell
conda install openblas-devel -c anaconda conda install openblas-devel -c anaconda
pip install -U git+https://github.com/NVIDIA/MinkowskiEngine -v --no-deps --install-option="--blas_include_dirs=/opt/conda/include" --install-option="--blas=openblas" pip install -U git+https://github.com/NVIDIA/MinkowskiEngine -v --no-deps --install-option="--blas_include_dirs=/opt/conda/include" --install-option="--blas=openblas"
``` ```
5. 我们的代码目前不能在只有 CPU 的环境（CUDA 不可用）下编译运行。 5. 我们的代码目前不能在只有 CPU 的环境（CUDA 不可用）下编译。
## 验证 ## 验证
### 通过点云样例程序来验证 ### 使用点云样例来验证
我们提供了一些样例脚本去测试单个样本，预训练的模型可以从[模型库](model_zoo.md)中下载. 运行如下命令可以去测试点云场景下一个单模态的 3D 检测算法。 我们提供了一些样例脚本去测试单个样本。预训练的模型可以从[模型库](model_zoo.md)中下载。运行如下命令可以去测试点云场景下一个单模态的 3D 检测算法：
```shell ```shell
python demo/pcd_demo.py ${PCD_FILE} ${CONFIG_FILE} ${CHECKPOINT_FILE} [--device ${GPU_ID}] [--score-thr ${SCORE_THR}] [--out-dir ${OUT_DIR}] python demo/pcd_demo.py ${PCD_FILE} ${CONFIG_FILE} ${CHECKPOINT_FILE} [--device ${GPU_ID}] [--score-thr ${SCORE_THR}] [--out-dir ${OUT_DIR}]
...@@ -152,8 +152,7 @@ python demo/pcd_demo.py ${PCD_FILE} ${CONFIG_FILE} ${CHECKPOINT_FILE} [--device ...@@ -152,8 +152,7 @@ python demo/pcd_demo.py ${PCD_FILE} ${CONFIG_FILE} ${CHECKPOINT_FILE} [--device
python demo/pcd_demo.py demo/data/kitti/000008.bin configs/second/second_hv_secfpn_8xb6-80e_kitti-3d-car.py checkpoints/second_hv_secfpn_8xb6-80e_kitti-3d-car_20200620_230238-393f000c.pth python demo/pcd_demo.py demo/data/kitti/000008.bin configs/second/second_hv_secfpn_8xb6-80e_kitti-3d-car.py checkpoints/second_hv_secfpn_8xb6-80e_kitti-3d-car_20200620_230238-393f000c.pth
``` ```
如果你想输入一个 `.ply` 格式的文件，你可以使用如下函数将它转换为 `.bin` 的文件格式。然后就可以使用转化成 `.bin` 格式的文件去运行样例程序。 如果您想输入一个 `.ply` 文件，您可以使用如下函数将它转换成 `.bin` 格式。然后您可以使用转化的 `.bin` 文件来运行样例。请注意在使用此脚本之前，您需要安装 `pandas` 和 `plyfile`。这个函数也可以用于训练 `ply 数据`时作为数据预处理来使用。
请注意在使用此脚本前，你需要先安装 `pandas` 和 `plyfile`。这个函数也可使用在数据预处理当中，为了能够直接训练 `ply data`。
```python ```python
import numpy as np import numpy as np
...@@ -178,7 +177,7 @@ def convert_ply(input_path, output_path): ...@@ -178,7 +177,7 @@ def convert_ply(input_path, output_path):
convert_ply('./test.ply', './test.bin') convert_ply('./test.ply', './test.bin')
``` ```
如果你有其他格式的点云文件 (例：`.off`，`.obj`)，你可以使用 `trimesh` 将它们转化成 `.ply`。 如果您有其他格式的点云数据（`.off`，`.obj` 等），您可以使用 `trimesh` 将它们转化成 `.ply`。
```python ```python
import trimesh import trimesh
...@@ -200,22 +199,22 @@ to_ply('./test.obj', './test.ply', 'obj') ...@@ -200,22 +199,22 @@ to_ply('./test.obj', './test.ply', 'obj')
### CUDA 版本 ### CUDA 版本
当安装 PyTorch 的时候，你需要去指定 CUDA 的版本。如果你不清楚如何选择 CUDA 的版本，可以参考我们如下的建议： 在安装 PyTorch 时，您需要指定 CUDA 的版本。如果您不清楚应该选择哪一个，请遵循我们的建议：
- 对于 Ampere 的 NVIDIA GPU, 比如 GeForce 30 series 和 NVIDIA A100, CUDA 11 是必须的。 - 对于 Ampere 架构的 NVIDIA GPU，例如 GeForce 30 系列以及 NVIDIA A100，CUDA 11 是必需的。
- 对于老款的 NVIDIA GPUs, CUDA 11 是可编译的，但是 CUDA 10.2 提供更好的可编译性，并且更轻量。 - 对于较早的 NVIDIA GPU，CUDA 11 是向后兼容的，但 CUDA 10.2 提供更好的兼容性，并且更轻量。
请确保 GPU 驱动版本大于最低需求。更多信息请参考此[表格](https://docs.nvidia.com/cuda/cuda-toolkit-release-notes/index.html#cuda-major-component-versions__table-cuda-toolkit-driver-versions)。 请确保 GPU 驱动版本满足最低的版本需求。更多信息请参考此[表格](https://docs.nvidia.com/cuda/cuda-toolkit-release-notes/index.html#cuda-major-component-versions__table-cuda-toolkit-driver-versions)。
```{note} ```{note}
如果你参照最佳实践，你只需要安装 CUDA runtime libraries。这是因为没有代码需要在本地通过 CUDA 编译。然而如果你需要编译 MMCV 源码，或者编译其他 CUDA 代码，你需要基于 NVIDIA [website](https://developer.nvidia.com/cuda-downloads) 安装完整的 CUDA toolkit，并且要保证它的版本跟 PyTorch 匹配。比如在 `conda install` 指令里指定 cudatoolkit 版本。 如果您遵循我们的最佳实践，您只需要安装 CUDA 运行库，这是因为不需要在本地编译 CUDA 代码。但如果您希望从源码编译 MMCV，或者开发其他 CUDA 算子，那么您需要从 NVIDIA 的[官网](https://developer.nvidia.com/cuda-downloads)安装完整的 CUDA 工具链，并且该版本应该与 PyTorch 的 CUDA 版本相匹配，比如在 `conda install` 指令里指定 cudatoolkit 版本。
``` ```
### 不通过 MIM 安装 MMEngine ### 不通过 MIM 安装 MMEngine
如果想要使用 pip 而不是 MIM 安装 MMEngine, 请参考 [MMEngine 安装指南](https://mmengine.readthedocs.io/zh_CN/latest/get_started/installation.html)。 如果想要使用 pip 而不是 MIM 安装 MMEngine，请参考 [MMEngine 安装指南](https://mmengine.readthedocs.io/zh_CN/latest/get_started/installation.html)。
例如，你可以通过以下指令安装 MMEngine。 例如，您可以通过以下指令安装 MMEngine：
```shell ```shell
pip install mmengine pip install mmengine
...@@ -223,22 +222,22 @@ pip install mmengine ...@@ -223,22 +222,22 @@ pip install mmengine
### 不通过 MIM 安装 MMCV ### 不通过 MIM 安装 MMCV
MMCV 包含一些 C++ 和 CUDA 扩展，因此以复杂的方式依赖于 PyTorch。MIM 会自动解决此类依赖关系并使安装更容易。但是，这不是必须的。 MMCV 包含 C++ 和 CUDA 拓展，因此其对 PyTorch 的依赖更复杂。MIM 会自动解决此类依赖关系并使安装更容易。但这不是必需的。
如果想要使用 pip 而不是 MIM 安装 MMCV，请参考 [MMCV 安装指南](https://mmcv.readthedocs.io/zh_CN/latest/get_started/installation.html)。这需要根据 PyTorch 版本及其 CUDA 版本手动指定 find-url。 如果想要使用 pip 而不是 MIM 安装 MMCV，请参考 [MMCV 安装指南](https://mmcv.readthedocs.io/zh_CN/2.x/get_started/installation.html)。这需要用指定 url 的形式手动指定对应的 PyTorch 和 CUDA 版本。
例如，下面的脚本安装 的 mmcv 是对应的 PyTorch 1.10.x 和 CUDA 11.3。 例如，下述指令将会安装基于 PyTorch 1.10.x 和 CUDA 11.3 编译的 MMCV：
```shell ```shell
pip install mmcv -f https://download.openmmlab.com/mmcv/dist/cu113/torch1.10/index.html pip install mmcv -f https://download.openmmlab.com/mmcv/dist/cu113/torch1.10/index.html
``` ```
### 通过 Docker 安装 MMDetection3D ### 通过 Docker 使用 MMDetection3D
我们提供了 [Dockerfile](https://github.com/open-mmlab/mmdetection3d/blob/master/docker/Dockerfile) 来建立一个镜像。 我们提供了 [Dockerfile](https://github.com/open-mmlab/mmdetection3d/blob/dev-1.x/docker/Dockerfile) 来一个镜像。
```shell ```shell
# 基于 PyTorch 1.6, CUDA 10.1 生成 docker 的镜像 # 基于 PyTorch 1.6，CUDA 10.1 构建镜像
docker build -t mmdetection3d -f docker/Dockerfile . docker build -t mmdetection3d -f docker/Dockerfile .
``` ```
...@@ -248,21 +247,21 @@ docker build -t mmdetection3d -f docker/Dockerfile . ...@@ -248,21 +247,21 @@ docker build -t mmdetection3d -f docker/Dockerfile .
docker run --gpus all --shm-size=8g -it -v {DATA_DIR}:/mmdetection3d/data mmdetection3d docker run --gpus all --shm-size=8g -it -v {DATA_DIR}:/mmdetection3d/data mmdetection3d
``` ```
## 从零开始的安装脚本 ### 从零开始的安装脚本
以下是一个基于 conda 安装 MMdetection3D 的脚本 以下是一个基于 conda 安装 MMDetection3D 的完整脚本。
```shell ```shell
# 鉴于 waymo-open-dataset-tf-2-6-0 要求 python>=3.7，我们推荐安装 python3.8 # 鉴于 waymo-open-dataset-tf-2-6-0 要求 python>=3.7，我们推荐安装 python=3.8
# 如果您想要安装 python<3.7，之后须确保安装 waymo-open-dataset-tf-2-x-0 (x<=4) # 如果您想要安装 python<3.7，之后需确保安装 waymo-open-dataset-tf-2-x-0 (x<=4)
conda create -n open-mmlab python=3.8 -y conda create -n openmmlab python=3.8 -y
conda activate open-mmlab conda activate openmmlab
# 使用默认的预编译 CUDA 版本（通常是最新的）安装最新的 PyTorch # 使用默认的预编译 CUDA 版本（通常是最新的）安装最新的 PyTorch
conda install -c pytorch pytorch torchvision -y conda install -c pytorch pytorch torchvision -y
# 安装 mmengine and mmcv # 安装 mmengine 和 mmcv
pip install openmim pip install -U openmim
mim install mmengine mim install mmengine
mim install 'mmcv>=2.0.0rc0' mim install 'mmcv>=2.0.0rc0'
...@@ -277,4 +276,4 @@ pip install -e . ...@@ -277,4 +276,4 @@ pip install -e .
## 故障排除 ## 故障排除
如果在安装过程中遇到什么问题，可以先参考 [FAQ](notes/faq.md) 页面。如果没有找到对应的解决方案，你也可以在 Github [提一个 issue](https://github.com/open-mmlab/mmdetection3d/issues/new/choose)。 如果在安装过程中遇到一些问题，请先参考 [FAQ](notes/faq.md) 页面。如果没有找到对应的解决方案，您也可以在 GitHub [提一个 issue](https://github.com/open-mmlab/mmdetection3d/issues/new/choose)。
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