aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorManu Mathew2020-07-20 09:11:55 -0500
committerManu Mathew2020-07-20 09:11:55 -0500
commit201e76e5b7a048a35dd83e2ba81357cfd2b61ef8 (patch)
treeaf5afd48d7f760b87e950b80b8dde17d2c80bb17 /README.md
parentac3a6d8def4851550dc97a8284ca5ef2e3af7e45 (diff)
downloadpytorch-mmdetection-201e76e5b7a048a35dd83e2ba81357cfd2b61ef8.tar.gz
pytorch-mmdetection-201e76e5b7a048a35dd83e2ba81357cfd2b61ef8.tar.xz
pytorch-mmdetection-201e76e5b7a048a35dd83e2ba81357cfd2b61ef8.zip
modelzoo doc update
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 7 insertions, 4 deletions
diff --git a/README.md b/README.md
index 81b319b..6a5933c 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
3 3
4This repository is an extension of the popular [mmdetection](https://github.com/open-mmlab/mmdetection) open source repository for object detection training. While mmdetection focuses on a wide variety of models, typically at high complexity, we focus on models that are optimized for speed and accuracy so that they run efficiently on embedded devices. 4This repository is an extension of the popular [mmdetection](https://github.com/open-mmlab/mmdetection) open source repository for object detection training. While mmdetection focuses on a wide variety of models, typically at high complexity, we focus on models that are optimized for speed and accuracy so that they run efficiently on embedded devices.
5 5
6Kindly take time to read through the original documentation of the original [mmdetection](https://github.com/open-mmlab/mmdetection) before attempting to use this repository. 6Kindly take time to read through the documentation of the original [mmdetection](https://github.com/open-mmlab/mmdetection) before attempting to use this repository.
7 7
8 8
9## License 9## License
@@ -13,7 +13,9 @@ Please see [LICENSE](./LICENSE) and [LICENSE.SPDX](./LICENSE.SPDX)
13 13
14## Installation 14## Installation
15 15
16This repository requires mmdetection (mmdet Python package) to be installed. Please refer to [installation instructions for mmdetection](https://github.com/open-mmlab/mmdetection/blob/master/docs/install.md) for installation and dataset preparation. If you get any issues with the master branch of mmdetection, please try after checking out the latest release tag. Note mmdetection also requreis mmcv and several other dependencies to be installed as described in the above URL. 16This repository requires mmdet Python package from mmdetection to be installed. Please refer to [installation instructions for mmdetection](https://github.com/open-mmlab/mmdetection/blob/master/docs/install.md) for installation and also for dataset preparation. If you get any issues with the master branch of mmdetection, please try after checking out the latest release tag.
17
18Note: mmdetection also requreis mmcv and several other dependencies to be installed as described in the above URL.
17 19
18After installing mmdetection, please install [PyTorch-Jacinto-AI-DevKit](https://bitbucket.itg.ti.com/projects/JACINTO-AI/repos/pytorch-jacinto-ai-devkit/browse/) as this repository uses several components from there - especially to define low complexity models and to do Quantization Aware Training (QAT) and Calibration. 20After installing mmdetection, please install [PyTorch-Jacinto-AI-DevKit](https://bitbucket.itg.ti.com/projects/JACINTO-AI/repos/pytorch-jacinto-ai-devkit/browse/) as this repository uses several components from there - especially to define low complexity models and to do Quantization Aware Training (QAT) and Calibration.
19 21
@@ -32,13 +34,14 @@ Several trained models with accuracy report is available at [Jacinto-AI-Detectio
32 34
33## Quantization 35## Quantization
34 36
35Tutorial on how to do [Quantization Aware Training](./docs/det_quantization.md) in Jacinto-AI-MMDetection. 37This tutorial explaines how to do [Quantization Aware Training](./docs/det_quantization.md) of detection models. We also provide sample QAT models.
36 38
37 39
38## Acknowledgement 40## Acknowledgement
39 41
40This is an open source project that is contributed by researchers and engineers from various colleges and companies. We appreciate all the contributors who implement their methods or add new features, as well as users who give valuable feedbacks. 42This is an open source project that is contributed by researchers and engineers from various colleges and companies. We appreciate all the contributors who implement their methods or add new features, as well as users who give valuable feedbacks.
41We wish that the toolbox and benchmark could serve the growing research community by providing a flexible toolkit to reimplement existing methods and develop their own new detectors. 43
44We wish that the toolbox and benchmark could serve the growing research community by providing a flexible toolkit to train existing detectors and also to develop their own new detectors.
42 45
43 46
44## Citation 47## Citation