From e22740b1d6953d75a0acecce4455d23800b1f018 Mon Sep 17 00:00:00 2001 From: zhouzaida Date: Tue, 2 Nov 2021 23:37:56 +0800 Subject: [PATCH] add note --- README.md | 2 ++ README_zh-CN.md | 2 ++ docs/get_started/installation.md | 6 +++++- docs_zh_CN/get_started/installation.md | 10 ++++++++-- 4 files changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ebff1905c..19792519a 100644 --- a/README.md +++ b/README.md @@ -174,6 +174,8 @@ For more details, please refer the the following tables. +**Note**: The pre-built packages provided above do not include all versions of mmcv-full, we can click on the corresponding links to see the supported versions. For example, if you click [cu102-torch1.8.0](https://download.openmmlab.com/mmcv/dist/cu102/torch1.8.0/index.html), you can see that `cu102-torch1.8.0` only provides 1.3.0 and above versions of mmcv-full. + Another way is to compile locally by running ```python diff --git a/README_zh-CN.md b/README_zh-CN.md index 0d90d7973..22b941b61 100644 --- a/README_zh-CN.md +++ b/README_zh-CN.md @@ -171,6 +171,8 @@ pip install mmcv-full==1.3.9 -f https://download.openmmlab.com/mmcv/dist/cu111/t +**注意**：以上提供的预编译包并不囊括所有的 mmcv-full 版本，我们可以点击对应链接查看支持的版本。例如，点击 [cu102-torch1.8.0](https://download.openmmlab.com/mmcv/dist/cu102/torch1.8.0/index.html)，可以看到 `cu102-torch1.8.0` 只提供了 1.3.0 及以上的 mmcv-full 版本。 + 除了使用预编译包之外，另一种方式是在本地进行编译，直接运行下述命令 ```python diff --git a/docs/get_started/installation.md b/docs/get_started/installation.md index 2f43db3ae..a1e603528 100644 --- a/docs/get_started/installation.md +++ b/docs/get_started/installation.md @@ -48,7 +48,7 @@ to install ``mmcv-full==1.3.9`` with ``CUDA 11.1`` and ``PyTorch 1.9.0``, use th pip install mmcv-full==1.3.9 -f https://download.openmmlab.com/mmcv/dist/cu111/torch1.9.0/index.html ``` -```{tip} +```{note} mmcv-full is only compiled on PyTorch 1.x.0 because the compatibility usually holds between 1.x.0 and 1.x.1. If your PyTorch version is 1.x.1, you can install mmcv-full compiled with PyTorch 1.x.0 and it usually works well. @@ -142,6 +142,10 @@ For more details, please refer the the following tables. +```{note} +The pre-built packages provided above do not include all versions of mmcv-full, we can click on the corresponding links to see the supported versions. For example, if you click [cu102-torch1.8.0](https://download.openmmlab.com/mmcv/dist/cu102/torch1.8.0/index.html), you can see that `cu102-torch1.8.0` only provides 1.3.0 and above versions of mmcv-full. +``` + Another way is to compile locally by running ```python diff --git a/docs_zh_CN/get_started/installation.md b/docs_zh_CN/get_started/installation.md index dd408c444..bb91bd1d9 100644 --- a/docs_zh_CN/get_started/installation.md +++ b/docs_zh_CN/get_started/installation.md @@ -5,7 +5,9 @@ MMCV 有两个版本： - **mmcv-full**: 完整版，包含所有的特性以及丰富的开箱即用的 CUDA 算子。注意完整版本可能需要更长时间来编译。 - **mmcv**: 精简版，不包含 CUDA 算子但包含其余所有特性和功能，类似 MMCV 1.0 之前的版本。如果你不需要使用 CUDA 算子的话，精简版可以作为一个考虑选项。 -**注意**: 请不要在同一个环境中安装两个版本，否则可能会遇到类似 `ModuleNotFound` 的错误。在安装一个版本之前，需要先卸载另一个。`如果CUDA可用，强烈推荐安装mmcv-full`。 +```{warning} +请不要在同一个环境中安装两个版本，否则可能会遇到类似 `ModuleNotFound` 的错误。在安装一个版本之前，需要先卸载另一个。`如果CUDA可用，强烈推荐安装mmcv-full`。 +``` a. 安装完整版 @@ -27,7 +29,7 @@ pip install mmcv-full -f https://download.openmmlab.com/mmcv/dist/{cu_version}/{ pip install mmcv-full -f https://download.openmmlab.com/mmcv/dist/cu111/torch1.9.0/index.html ``` -```{tip} +```{note} PyTorch 在 1.x.0 和 1.x.1 之间通常是兼容的，故 mmcv-full 只提供 1.x.0 的编译包。如果你 的 PyTorch 版本是 1.x.1，你可以放心地安装在 1.x.0 版本编译的 mmcv-full。例如，如果你的 PyTorch 版本是 1.8.1、CUDA 版本是 11.1，你可以使用以下命令安装 mmcv-full。 @@ -136,6 +138,10 @@ pip install mmcv-full==1.3.9 -f https://download.openmmlab.com/mmcv/dist/cu111/t +```{note} +以上提供的预编译包并不囊括所有的 mmcv-full 版本，我们可以点击对应链接查看支持的版本。例如，点击 [cu102-torch1.8.0](https://download.openmmlab.com/mmcv/dist/cu102/torch1.8.0/index.html)，可以看到 `cu102-torch1.8.0` 只提供了 1.3.0 及以上的 mmcv-full 版本。 +``` + 除了使用预编译包之外，另一种方式是在本地进行编译，直接运行下述命令 ```python