Unverified Commit 8de2a289 authored by Tai-Wang's avatar Tai-Wang Committed by GitHub
Browse files

[Doc] Update the getting_started documentation (#1775)

* Update faq.md

* Update getting_started.md

* Update the pytorch version

* Update faq.md

* Update mmcv installation scripts

* Update mmcv names

* Update installation scripts
parent c872a8ec
...@@ -48,8 +48,8 @@ Otherwise, you should refer to the step-by-step installation instructions in the ...@@ -48,8 +48,8 @@ Otherwise, you should refer to the step-by-step installation instructions in the
```shell ```shell
pip install openmim pip install 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'
git clone https://github.com/open-mmlab/mmdetection3d.git -b dev-1.x git clone https://github.com/open-mmlab/mmdetection3d.git -b dev-1.x
cd mmdetection3d cd mmdetection3d
pip install -e . pip install -e .
...@@ -60,13 +60,13 @@ pip install -e . ...@@ -60,13 +60,13 @@ pip install -e .
```shell ```shell
pip install -U openmim pip install -U openmim
mim install mmengine mim install mmengine
mim install mmcv>=2.0.0rc0 mim install 'mmcv>=2.0.0rc0'
``` ```
**Step 1.** Install [MMDetection](https://github.com/open-mmlab/mmdetection). **Step 1.** Install [MMDetection](https://github.com/open-mmlab/mmdetection).
```shell ```shell
mim install mmdet>=3.0.0rc0 mim install 'mmdet>=3.0.0rc0'
``` ```
Optionally, you could also build MMDetection from source in case you want to modify the code: Optionally, you could also build MMDetection from source in case you want to modify the code:
...@@ -263,10 +263,10 @@ conda install -c pytorch pytorch torchvision -y ...@@ -263,10 +263,10 @@ conda install -c pytorch pytorch torchvision -y
# install mmengine and mmcv # install mmengine and mmcv
pip install openmim pip install openmim
mim install mmengine mim install mmengine
mim install mmcv>=2.0.0rc0 mim install 'mmcv>=2.0.0rc0'
# install mmdetection # install mmdetection
mim install mmdet>=3.0.0rc0 mim install 'mmdet>=3.0.0rc0'
# install mmdetection3d # install mmdetection3d
git clone https://github.com/open-mmlab/mmdetection3d.git -b dev-1.x git clone https://github.com/open-mmlab/mmdetection3d.git -b dev-1.x
......
...@@ -8,7 +8,7 @@ We list some potential troubles encountered by users and developers, along with ...@@ -8,7 +8,7 @@ We list some potential troubles encountered by users and developers, along with
The required versions of MMEngine, MMCV and MMDetection for different versions of MMDetection3D are as below. Please install the correct version of MMEngine, MMCV and MMDetection to avoid installation issues. The required versions of MMEngine, MMCV and MMDetection for different versions of MMDetection3D are as below. Please install the correct version of MMEngine, MMCV and MMDetection to avoid installation issues.
| MMDetection3D version | MMEngine version | MMCV version | MMDetection version | | MMDetection3D version | MMEngine version | MMCV version | MMDetection version |
| :-------------------: | :----------------------: | :---------------------: | :----------------------: | | :-------------------: | :----------------------: | :---------------------: | :----------------------: |
| dev-1.x | mmengine>=0.1.0, \<0.2.0 | mmcv>=2.0.0rc0, \<2.1.0 | mmdet>=3.0.0rc0, \<3.1.0 | | dev-1.x | mmengine>=0.1.0, \<0.2.0 | mmcv>=2.0.0rc0, \<2.1.0 | mmdet>=3.0.0rc0, \<3.1.0 |
| v1.1.0rc0 | mmengine>=0.1.0, \<0.2.0 | mmcv>=2.0.0rc0, \<2.1.0 | mmdet>=3.0.0rc0, \<3.1.0 | | v1.1.0rc0 | mmengine>=0.1.0, \<0.2.0 | mmcv>=2.0.0rc0, \<2.1.0 | mmdet>=3.0.0rc0, \<3.1.0 |
......
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