Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Update Installation Guides #2171

Merged
merged 2 commits into from
Apr 6, 2023
Merged

[Docs] Update Installation Guides #2171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6cda946
update installation
Tau-J Apr 6, 2023
bb1a04e
updaste
Tau-J Apr 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions README_CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,8 +321,7 @@ MMPose 是一款由不同学校和公司共同贡献的开源项目。我们感
扫描下方的二维码可关注 OpenMMLab 团队的 [知乎官方账号](https://www.zhihu.com/people/openmmlab)，联络 OpenMMLab [官方微信小助手](https://user-images.githubusercontent.com/25839884/205872898-e2e6009d-c6bb-4d27-8d07-117e697a3da8.jpg)或加入 OpenMMLab 团队的 [官方交流 QQ 群](https://jq.qq.com/?_wv=1027&k=K0QI8ByU)

<div align="center">
<img src="https://user-images.githubusercontent.com/25839884/205870927-39f4946d-8751-4219-a4c0-740117558fd7.jpg" height="400"><img src="https://user-images.githubusercontent.com/25839884/205872898-e2e6009d-c6bb-4d27-8d07-117e697a3da8.jpg" height="400"><img src="https://user-images.githubusercontent.com/25839884/203904835-62392033-02d4-4c73-a68c-c9e4c1e2b07f.jpg
" height="400">
<img src="https://user-images.githubusercontent.com/25839884/205870927-39f4946d-8751-4219-a4c0-740117558fd7.jpg" height="400"><img src="https://user-images.githubusercontent.com/25839884/205872898-e2e6009d-c6bb-4d27-8d07-117e697a3da8.jpg" height="400"><img src="https://user-images.githubusercontent.com/25839884/203904835-62392033-02d4-4c73-a68c-c9e4c1e2b07f.jpg" height="400">
</div>

我们会在 OpenMMLab 社区为大家
Expand Down
12 changes: 6 additions & 6 deletions docs/en/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,13 +59,13 @@ conda install pytorch torchvision cpuonly -c pytorch
```shell
pip install -U openmim
mim install mmengine
mim install "mmcv>=2.0.0rc4"
mim install "mmcv>=2.0.0"
```

Note that some of the demo scripts in MMPose require [MMDetection](https://github.com/open-mmlab/mmdetection) (mmdet) for human detection. If you want to run these demo scripts with mmdet, you can easily install mmdet as a dependency by running:

```shell
mim install "mmdet>=3.0.0rc6"
mim install "mmdet>=3.0.0"
```

## Best Practices
Expand All @@ -89,7 +89,7 @@ pip install -v -e .
To use mmpose as a dependency or third-party package, install it with pip:

```shell
mim install "mmpose>=1.0.0rc1"
mim install "mmpose>=1.0.0"
```

## Verify the installation
Expand Down Expand Up @@ -173,7 +173,7 @@ To install MMCV with pip instead of MIM, please follow [MMCV installation guides
For example, the following command install mmcv built for PyTorch 1.10.x and CUDA 11.3.

```shell
pip install 'mmcv>=2.0.0rc1' -f https://download.openmmlab.com/mmcv/dist/cu113/torch1.10/index.html
pip install 'mmcv>=2.0.0' -f https://download.openmmlab.com/mmcv/dist/cu113/torch1.10/index.html
```

### Install on CPU-only platforms
Expand All @@ -192,7 +192,7 @@ thus we only need to install MMEngine, MMCV and MMPose with the following comman
```shell
!pip3 install openmim
!mim install mmengine
!mim install "mmcv>=2.0.0rc1"
!mim install "mmcv>=2.0.0"
```

**Step 2.** Install MMPose from the source.
Expand All @@ -208,7 +208,7 @@ thus we only need to install MMEngine, MMCV and MMPose with the following comman
```python
import mmpose
print(mmpose.__version__)
# Example output: 1.0.0rc0
# Example output: 1.0.0
```

```{note}
Expand Down
12 changes: 6 additions & 6 deletions docs/zh_cn/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,13 @@ 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"
```

请注意，MMPose 中的一些推理示例脚本需要使用 [MMDetection](https://github.com/open-mmlab/mmdetection) (mmdet) 检测人体。如果您想运行这些示例脚本，可以通过运行以下命令安装 mmdet:

```shell
mim install "mmdet>=3.0.0rc0"
mim install "mmdet>=3.0.0"
```

## 最佳实践
Expand All @@ -88,7 +88,7 @@ pip install -v -e .
如果只是希望调用 MMPose 的接口，或者在自己的项目中导入 MMPose 中的模块。直接使用 mim 安装即可。

```shell
mim install "mmpose>=1.0.0rc0"
mim install "mmpose>=1.0.0"
```

## 验证安装
Expand Down Expand Up @@ -180,7 +180,7 @@ MMCV 包含 C++ 和 CUDA 扩展，因此其对 PyTorch 的依赖比较复杂。M
举个例子，如下命令将会安装基于 PyTorch 1.10.x 和 CUDA 11.3 编译的 mmcv。

```shell
pip install 'mmcv>=2.0.0rc1' -f https://download.openmmlab.com/mmcv/dist/cu113/torch1.10/index.html
pip install 'mmcv>=2.0.0' -f https://download.openmmlab.com/mmcv/dist/cu113/torch1.10/index.html
```

### 在 CPU 环境中安装
Expand All @@ -198,7 +198,7 @@ MMPose 可以仅在 CPU 环境中安装，在 CPU 模式下，您可以完成训
```shell
!pip3 install openmim
!mim install mmengine
!mim install "mmcv>=2.0.0rc1"
!mim install "mmcv>=2.0.0"
```

**第 2 步** 从源码安装 mmpose
Expand All @@ -214,7 +214,7 @@ MMPose 可以仅在 CPU 环境中安装，在 CPU 模式下，您可以完成训
```python
import mmpose
print(mmpose.__version__)
# 预期输出： 1.0.0rc0
# 预期输出： 1.0.0
```

```{note}
Expand Down