mirror of https://github.com/open-mmlab/mmcv.git
[Docs] Update README and fix typo in docs (#2358)
parent
3c35bab67c
commit
1eef4f5a4e
|
@ -22,6 +22,8 @@
|
|||
[](https://mmcv.readthedocs.io/en/latest/)
|
||||
[](https://mmcv.readthedocs.io/en/latest/get_started/installation.html)
|
||||
[](https://pypi.org/project/mmcv/)
|
||||
[](https://pytorch.org/get-started/previous-versions/)
|
||||
[](https://developer.nvidia.com/cuda-downloads)
|
||||
[](https://pypi.org/project/mmcv)
|
||||
[](https://github.com/open-mmlab/mmcv/actions)
|
||||
[](https://codecov.io/gh/open-mmlab/mmcv)
|
||||
|
@ -131,7 +133,7 @@ mim install mmcv
|
|||
|
||||
## FAQ
|
||||
|
||||
If you face installation problems or runtime issues, you may first refer to this [Frequently Asked Questions](https://mmcv.readthedocs.io/zh_CN/latest/faq.html) to see if there is a solution. If the problem is still not solved, feel free to open an [issue](https://github.com/open-mmlab/mmcv/issues).
|
||||
If you face installation problems or runtime issues, you may first refer to this [Frequently Asked Questions](https://mmcv.readthedocs.io/en/latest/faq.html) to see if there is a solution. If the problem is still not solved, feel free to open an [issue](https://github.com/open-mmlab/mmcv/issues).
|
||||
|
||||
## Citation
|
||||
|
||||
|
|
|
@ -22,6 +22,8 @@
|
|||
[](https://mmcv.readthedocs.io/zh_CN/latest/)
|
||||
[](https://mmcv.readthedocs.io/zh_CN/latest/get_started/installation.html)
|
||||
[](https://pypi.org/project/mmcv/)
|
||||
[](https://pytorch.org/get-started/previous-versions/)
|
||||
[](https://developer.nvidia.com/cuda-downloads)
|
||||
[](https://pypi.org/project/mmcv)
|
||||
[](https://github.com/open-mmlab/mmcv/actions)
|
||||
[](https://codecov.io/gh/open-mmlab/mmcv)
|
||||
|
|
|
@ -12,9 +12,9 @@ Do not install both versions in the same environment, otherwise you may encounte
|
|||
### Install mmcv-full
|
||||
|
||||
```{note}
|
||||
- The following installation steps are for Linux and Windows platforms only. To install mmcv-full on macOS platform, please refer to [build mmcv-full from source](https://mmcv.readthedocs.io/en/latest/get_started/build.html#macos-mmcv-full).
|
||||
- To compile ONNX Runtime custom operators, please refer to [How to build custom operators for ONNX Runtime](https://mmcv.readthedocs.io/en/latest/deployment/onnxruntime_op.html#how-to-build-custom-operators-for-onnx-runtime)
|
||||
- To compile TensorRT customization, please refer to [How to build TensorRT plugins in MMCV](https://mmcv.readthedocs.io/en/latest/deployment/tensorrt_plugin.html#how-to-build-tensorrt-plugins-in-mmcv)
|
||||
- The following installation steps are for Linux and Windows platforms only. To install mmcv-full on macOS platform, please refer to [build mmcv-full from source](build.md#build-on-macos).
|
||||
- To compile ONNX Runtime custom operators, please refer to [How to build custom operators for ONNX Runtime](../deployment/onnxruntime_op.md#how-to-build-custom-operators-for-onnx-runtime)
|
||||
- To compile TensorRT customization, please refer to [How to build TensorRT plugins in MMCV](../deployment/tensorrt_plugin.md#how-to-build-tensorrt-plugins-in-mmcv)
|
||||
```
|
||||
|
||||
Before installing mmcv-full, make sure that PyTorch has been successfully installed following the [PyTorch official installation guide](https://pytorch.org/get-started/locally/#start-locally). This can be verified using the following command
|
||||
|
|
|
@ -12,9 +12,9 @@ MMCV 有两个版本:
|
|||
### 安装 mmcv-full
|
||||
|
||||
```{note}
|
||||
- 下述安装步骤仅适用于 Linux 和 Windows 平台,如需在 macOS 平台安装 mmcv-full,请参考[源码安装 mmcv-full](https://mmcv.readthedocs.io/zh_CN/latest/get_started/build.html#macos-mmcv-full)。
|
||||
- 如需编译 ONNX Runtime 自定义算子,请参考[如何编译ONNX Runtime自定义算子](https://mmcv.readthedocs.io/zh_CN/latest/deployment/onnxruntime_op.html#id1)
|
||||
- 如需编译 TensorRT 自定义,请参考[如何编译MMCV中的TensorRT插件](https://mmcv.readthedocs.io/zh_CN/latest/deployment/tensorrt_plugin.html#id3)
|
||||
- 下述安装步骤仅适用于 Linux 和 Windows 平台,如需在 macOS 平台安装 mmcv-full,请参考[源码安装 mmcv-full](build.md#在-macos-上编译-mmcv-full)。
|
||||
- 如需编译 ONNX Runtime 自定义算子,请参考[如何编译ONNX Runtime自定义算子](../deployment/onnxruntime_op.md#如何编译onnx-runtime自定义算子)
|
||||
- 如需编译 TensorRT 自定义,请参考[如何编译MMCV中的TensorRT插件](../deployment/tensorrt_plugin.md#如何编译mmcv中的tensorrt插件)
|
||||
```
|
||||
|
||||
在安装 mmcv-full 之前,请确保 PyTorch 已经成功安装在环境中,可以参考 [PyTorch 官方安装文档](https://pytorch.org/get-started/locally/#start-locally)。可使用以下命令验证
|
||||
|
|
Loading…
Reference in New Issue