Skip to content

Commit

Permalink
Update version and README (#10091)
Browse files Browse the repository at this point in the history
  • Loading branch information
hhaAndroid authored Apr 6, 2023
1 parent 3a6a49d commit 32f43e5
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 14 deletions.
8 changes: 4 additions & 4 deletions docs/en/get_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ We recommend that users follow our best practices to install MMDetection. Howeve
```shell
pip install -U openmim
mim install mmengine
mim install "mmcv>=2.0.0rc1"
mim install "mmcv>=2.0.0"
```

**Note:** In MMCV-v2.x, `mmcv-full` is rename to `mmcv`, if you want to install `mmcv` without CUDA ops, you can use `mim install "mmcv-lite>=2.0.0rc1"` to install the lite version.
Expand Down Expand Up @@ -137,7 +137,7 @@ To install MMCV with pip instead of MIM, please follow [MMCV installation guides
For example, the following command installs MMCV built for PyTorch 1.12.x and CUDA 11.6.

```shell
pip install "mmcv>=2.0.0rc1" -f https://download.openmmlab.com/mmcv/dist/cu116/torch1.12.0/index.html
pip install "mmcv>=2.0.0" -f https://download.openmmlab.com/mmcv/dist/cu116/torch1.12.0/index.html
```

#### Install on CPU-only platforms
Expand Down Expand Up @@ -179,7 +179,7 @@ thus we only need to install MMEngine, MMCV, and MMDetection with the following
```shell
!pip3 install openmim
!mim install mmengine
!mim install "mmcv>=2.0.0rc1,<2.1.0"
!mim install "mmcv>=2.0.0,<2.1.0"
```

**Step 2.** Install MMDetection from the source.
Expand All @@ -195,7 +195,7 @@ thus we only need to install MMEngine, MMCV, and MMDetection with the following
```python
import mmdet
print(mmdet.__version__)
# Example output: 3.0.0rc0, or an another version.
# Example output: 3.0.0, or an another version.
```

```{note}
Expand Down
4 changes: 2 additions & 2 deletions docs/en/notes/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ Compatible MMDetection, MMEngine, and MMCV versions are shown as below. Please c

| MMDetection version | MMCV version | MMEngine version |
| :-----------------: | :---------------------: | :----------------------: |
| main | mmcv>=2.0.0rc4, \<2.1.0 | mmengine>=0.7.1, \<1.0.0 |
| 3.x | mmcv>=2.0.0rc4, \<2.1.0 | mmengine>=0.7.1, \<1.0.0 |
| main | mmcv>=2.0.0, \<2.1.0 | mmengine>=0.7.1, \<1.0.0 |
| 3.x | mmcv>=2.0.0, \<2.1.0 | mmengine>=0.7.1, \<1.0.0 |
| 3.0.0rc6 | mmcv>=2.0.0rc4, \<2.1.0 | mmengine>=0.6.0, \<1.0.0 |
| 3.0.0rc5 | mmcv>=2.0.0rc1, \<2.1.0 | mmengine>=0.3.0, \<1.0.0 |
| 3.0.0rc4 | mmcv>=2.0.0rc1, \<2.1.0 | mmengine>=0.3.0, \<1.0.0 |
Expand Down
2 changes: 1 addition & 1 deletion docs/en/user_guides/label_studio.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Install MMCV:

```shell
pip install -U openmim
mim install "mmcv>=2.0.0rc0"
mim install "mmcv>=2.0.0"
# Installing mmcv will automatically install mmengine
```

Expand Down
8 changes: 4 additions & 4 deletions docs/zh_cn/get_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ conda install pytorch torchvision cpuonly -c pytorch
```shell
pip install -U openmim
mim install mmengine
mim install "mmcv>=2.0.0rc1"
mim install "mmcv>=2.0.0"
```

**注意:** 在 MMCV-v2.x 中,`mmcv-full` 改名为 `mmcv`,如果你想安装不包含 CUDA 算子精简版,可以通过 `mim install "mmcv-lite>=2.0.0rc1"` 来安装。
Expand Down Expand Up @@ -136,7 +136,7 @@ MMCV 包含 C++ 和 CUDA 扩展,因此其对 PyTorch 的依赖比较复杂。M
例如,下述命令将会安装基于 PyTorch 1.12.x 和 CUDA 11.6 编译的 MMCV。

```shell
pip install "mmcv>=2.0.0rc1" -f https://download.openmmlab.com/mmcv/dist/cu116/torch1.12.0/index.html
pip install "mmcv>=2.0.0" -f https://download.openmmlab.com/mmcv/dist/cu116/torch1.12.0/index.html
```

#### 在 CPU 环境中安装
Expand Down Expand Up @@ -176,7 +176,7 @@ MMDetection 可以在 CPU 环境中构建。在 CPU 模式下,可以进行模
```shell
!pip3 install openmim
!mim install mmengine
!mim install "mmcv>=2.0.0rc1,<2.1.0"
!mim install "mmcv>=2.0.0,<2.1.0"
```

**步骤 2.** 使用源码安装 MMDetection。
Expand All @@ -192,7 +192,7 @@ MMDetection 可以在 CPU 环境中构建。在 CPU 模式下,可以进行模
```python
import mmdet
print(mmdet.__version__)
# 预期输出:3.0.0rc0 或其他版本号
# 预期输出:3.0.0 或其他版本号
```

```{note}
Expand Down
4 changes: 2 additions & 2 deletions docs/zh_cn/notes/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ export DYNAMO_CACHE_SIZE_LIMIT = 4

| MMDetection 版本 | MMCV 版本 | MMEngine 版本 |
| :--------------: | :---------------------: | :----------------------: |
| main | mmcv>=2.0.0rc4, \<2.1.0 | mmengine>=0.7.1, \<1.0.0 |
| 3.x | mmcv>=2.0.0rc4, \<2.1.0 | mmengine>=0.7.1, \<1.0.0 |
| main | mmcv>=2.0.0, \<2.1.0 | mmengine>=0.7.1, \<1.0.0 |
| 3.x | mmcv>=2.0.0, \<2.1.0 | mmengine>=0.7.1, \<1.0.0 |
| 3.0.0rc6 | mmcv>=2.0.0rc4, \<2.1.0 | mmengine>=0.6.0, \<1.0.0 |
| 3.0.0rc5 | mmcv>=2.0.0rc1, \<2.1.0 | mmengine>=0.3.0, \<1.0.0 |
| 3.0.0rc4 | mmcv>=2.0.0rc1, \<2.1.0 | mmengine>=0.3.0, \<1.0.0 |
Expand Down
2 changes: 1 addition & 1 deletion docs/zh_cn/user_guides/label_studio.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ pip install torch==1.10.1 torchvision==0.11.2 torchaudio==0.10.1

```shell
pip install -U openmim
mim install "mmcv>=2.0.0rc0"
mim install "mmcv>=2.0.0"
# 安装 mmcv 的过程中会自动安装 mmengine
```

Expand Down

0 comments on commit 32f43e5

Please sign in to comment.