Unverified Commit 487f381f authored by Kai Chen's avatar Kai Chen Committed by GitHub
Browse files

fix docs (#440)

parent 55fadb4c
...@@ -7,7 +7,7 @@ ...@@ -7,7 +7,7 @@
## Introduction ## Introduction
MMCV is a foundational python library for computer vision research and supports many MMCV is a foundational python library for computer vision research and supports many
research projects in MMLAB as below: research projects as below:
- [MMDetection](https://github.com/open-mmlab/mmdetection): Detection toolbox and benchmark - [MMDetection](https://github.com/open-mmlab/mmdetection): Detection toolbox and benchmark
- [MMDetection3D](https://github.com/open-mmlab/mmdetection3d): General 3D object detection toolbox and benchmark - [MMDetection3D](https://github.com/open-mmlab/mmdetection3d): General 3D object detection toolbox and benchmark
...@@ -38,6 +38,8 @@ There are two versions of MMCV: ...@@ -38,6 +38,8 @@ There are two versions of MMCV:
- **mmcv**: lite, without CUDA ops but all other features, similar to mmcv<1.0.0. It is useful when you do not need those CUDA ops. - **mmcv**: lite, without CUDA ops but all other features, similar to mmcv<1.0.0. It is useful when you do not need those CUDA ops.
- **mmcv-full**: comprehensive, with full features and various CUDA ops out of box. It takes longer time to build. - **mmcv-full**: comprehensive, with full features and various CUDA ops out of box. It takes longer time to build.
**Note**: Do not install both versions in the same environment, otherwise you may encounter errors like `ModuleNotFound`. You need to uninstall one before installing the other.
### Install with pip ### Install with pip
a. Install the lite version. a. Install the lite version.
...@@ -48,7 +50,9 @@ pip install mmcv ...@@ -48,7 +50,9 @@ pip install mmcv
b. Install the full version. b. Install the full version.
We provide the pre-built mmcv package with different PyTorch and CUDA versions to simplify the building. Before installing mmcv-full, make sure that PyTorch has been successfully installed following the [official guide](https://pytorch.org/).
We provide pre-built mmcv packages (recommended) with different PyTorch and CUDA versions to simplify the building.
<table class="docutils"><tbody><tr><th width="80"> CUDA </th><th valign="bottom" align="left" width="100">torch 1.5</th><th valign="bottom" align="left" width="100">torch 1.4</th><th valign="bottom" align="left" width="100">torch 1.3</th></tr> <table class="docutils"><tbody><tr><th width="80"> CUDA </th><th valign="bottom" align="left" width="100">torch 1.5</th><th valign="bottom" align="left" width="100">torch 1.4</th><th valign="bottom" align="left" width="100">torch 1.3</th></tr>
<tr><td align="left">10.2</td><td align="left"><details><summary> install </summary><pre><code>pip install mmcv-full==latest+torch1.5.0+cu102 -f https://openmmlab.oss-accelerate.aliyuncs.com/mmcv/dist/index.html <tr><td align="left">10.2</td><td align="left"><details><summary> install </summary><pre><code>pip install mmcv-full==latest+torch1.5.0+cu102 -f https://openmmlab.oss-accelerate.aliyuncs.com/mmcv/dist/index.html
......
...@@ -12,6 +12,7 @@ which can be written in configs or specified via command line arguments. ...@@ -12,6 +12,7 @@ which can be written in configs or specified via command line arguments.
#### Usage #### Usage
A simplest example is A simplest example is
```python ```python
cfg = dict(type='Conv3d') cfg = dict(type='Conv3d')
layer = build_norm_layer(cfg, in_channels=3, out_channels=8, kernel_size=3) layer = build_norm_layer(cfg, in_channels=3, out_channels=8, kernel_size=3)
...@@ -117,7 +118,7 @@ An example json file could be like: ...@@ -117,7 +118,7 @@ An example json file could be like:
} }
``` ```
The default links of the pre-trained models hosted on Open-MMLab AWS could be found [here](../mmcv/model_zoo/open_mmlab.json). The default links of the pre-trained models hosted on OpenMMLab AWS could be found [here](https://github.com/open-mmlab/mmcv/blob/master/mmcv/model_zoo/open_mmlab.json).
You may override default links by putting `open-mmlab.json` under `MMCV_HOME`. If `MMCV_HOME` is not find in the environment, `~/.cache/mmcv` will be used by default. You may `export MMCV_HOME=/your/path` to use your own path. You may override default links by putting `open-mmlab.json` under `MMCV_HOME`. If `MMCV_HOME` is not find in the environment, `~/.cache/mmcv` will be used by default. You may `export MMCV_HOME=/your/path` to use your own path.
......
...@@ -210,7 +210,7 @@ setup( ...@@ -210,7 +210,7 @@ setup(
], ],
url='https://github.com/open-mmlab/mmcv', url='https://github.com/open-mmlab/mmcv',
author='MMCV Authors', author='MMCV Authors',
author_email='chenkaidev@gmail.com', author_email='openmmlab@gmail.com',
setup_requires=['pytest-runner'], setup_requires=['pytest-runner'],
tests_require=['pytest'], tests_require=['pytest'],
install_requires=install_requires, install_requires=install_requires,
......
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