Commit 3a5ac395 authored by Kai Chen's avatar Kai Chen
Browse files

fix typo and minor revision

parent 49a288f7
...@@ -3,8 +3,8 @@ ...@@ -3,8 +3,8 @@
## Introduction ## Introduction
`mmdetection` is an open source object detection toolbox based on PyTorch. It is mmdetection is an open source object detection toolbox based on PyTorch. It is
a part of the open-mmlab project developed by Multimedia Laboratory, CUHK. a part of the open-mmlab project developed by [Multimedia Laboratory, CUHK](http://mmlab.ie.cuhk.edu.hk/).
### Major features ### Major features
...@@ -14,7 +14,7 @@ a part of the open-mmlab project developed by Multimedia Laboratory, CUHK. ...@@ -14,7 +14,7 @@ a part of the open-mmlab project developed by Multimedia Laboratory, CUHK.
- **Support of multiple frameworks out of box** - **Support of multiple frameworks out of box**
The toolbox directly supports popular detection frameworks, *e.g.* Faster RCNN, Mask RCNN, RetinaNet, etc. (see the release plan for more) The toolbox directly supports popular detection frameworks, *e.g.* Faster RCNN, Mask RCNN, RetinaNet, etc.
- **Efficient** - **Efficient**
...@@ -25,8 +25,8 @@ a part of the open-mmlab project developed by Multimedia Laboratory, CUHK. ...@@ -25,8 +25,8 @@ a part of the open-mmlab project developed by Multimedia Laboratory, CUHK.
This was the codebase of the *MMDet* team, who won the [COCO Detection 2018 challenge](http://cocodataset.org/#detection-leaderboard). This was the codebase of the *MMDet* team, who won the [COCO Detection 2018 challenge](http://cocodataset.org/#detection-leaderboard).
Apart from mmdetection, we also released a library `mmcv` for computer vision research, Apart from mmdetection, we also released a library [mmcv](https://github.com/open-mmlab/mmcv) for computer vision research,
which is heavily depended on by mmdetection. which is heavily depended on by this toolbox.
## License ## License
...@@ -34,8 +34,8 @@ This project is released under the [GPLv3 license](LICENSE). ...@@ -34,8 +34,8 @@ This project is released under the [GPLv3 license](LICENSE).
## Benchmark and model zoo ## Benchmark and model zoo
We provide our baseline results and the comparision with other popular detection projects We provide our baseline results and the comparision with Detectron, the most
such as Detectron. Results and models are available in the [Model zoo](MODEL_ZOO.md). popular detection projects. Results and models are available in the [Model zoo](MODEL_ZOO.md).
## Installation ## Installation
...@@ -106,15 +106,15 @@ To perform evaluation after testing, add `--eval <EVAL_TYPES>`. Supported types ...@@ -106,15 +106,15 @@ To perform evaluation after testing, add `--eval <EVAL_TYPES>`. Supported types
- segm: eval mask AP with the official code provided by COCO. - segm: eval mask AP with the official code provided by COCO.
- keypoints: eval keypoint AP with the official code provided by COCO. - keypoints: eval keypoint AP with the official code provided by COCO.
For example, to evaluate Mask R-CNN with 8 GPUs and save the result as results.pkl. For example, to evaluate Mask R-CNN with 8 GPUs and save the result as `results.pkl`.
```shell ```shell
python tools/test.py configs/mask_rcnn_r50_fpn_1x.py <CHECKPOINT_FILE> --gpus 8 --out results.pkl --eval bbox segm python tools/test.py configs/mask_rcnn_r50_fpn_1x.py <CHECKPOINT_FILE> --gpus 8 --out results.pkl --eval bbox segm
``` ```
Note: Multiple GPU testing cannot achieves linear acceleration. Note: Multiple GPU testing cannot achieve linear acceleration.
We also provide the ability to visualize the results when testing. Add the argument `--show` as below. It is also convenient to visualize the results during testing by adding an argument `--show`.
```shell ```shell
python tools/test.py <CONFIG_FILE> <CHECKPOINT_FILE> --show python tools/test.py <CONFIG_FILE> <CHECKPOINT_FILE> --show
...@@ -123,7 +123,7 @@ python tools/test.py <CONFIG_FILE> <CHECKPOINT_FILE> --show ...@@ -123,7 +123,7 @@ python tools/test.py <CONFIG_FILE> <CHECKPOINT_FILE> --show
## Train a model ## Train a model
`mmdetection` implements distributed training and non-distributed training, mmdetection implements distributed training and non-distributed training,
which uses `MMDistributedDataParallel` and `MMDataParallel` respectively. which uses `MMDistributedDataParallel` and `MMDataParallel` respectively.
We suggest using distributed training even on a single machine, which is faster, We suggest using distributed training even on a single machine, which is faster,
...@@ -131,7 +131,7 @@ and non-distributed training are left for debugging or other purposes. ...@@ -131,7 +131,7 @@ and non-distributed training are left for debugging or other purposes.
### Distributed training ### Distributed training
`mmdetection` potentially supports multiple launch methods, e.g., PyTorch’s built-in launch utility, slurm and MPI. mmdetection potentially supports multiple launch methods, e.g., PyTorch’s built-in launch utility, slurm and MPI.
We provide a training script using the launch utility provided by PyTorch. We provide a training script using the launch utility provided by PyTorch.
......
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