aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md74
1 files changed, 74 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5066e03
--- /dev/null
+++ b/README.md
@@ -0,0 +1,74 @@
1# Jacinto-AI-Detection
2
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.
5
6When we say MMDetection or mmdetection, we refer to the original repository. However, when we say Jacinto-AI-Detection or "this repository", we refer to this extension of mmdetection with speed/accuracy optimized models.
7
8Kindly take time to read through the original documentation of the original [mmdetection](https://github.com/open-mmlab/mmdetection) before attempting to use this repository. This repository requires mmdetection to be installed.
9
10
11## License
12
13This repository is released under the following [LICENSE](./LICENSE).
14
15
16## Installation
17
18Please refer to [mmdetection install.md](https://github.com/open-mmlab/mmdetection/docs/install.md) for installation and dataset preparation.
19
20After installing mmdetection, please install [PyTorch-Jacinto-AI-DevKit](https://bitbucket.itg.ti.com/projects/JACINTO-AI/repos/pytorch-jacinto-ai-devkit/browse/) as our repository uses several components from there - especially to define low complexity models and to Quantization Aware Training (QAT).
21
22
23## Get Started
24
25Please see [getting_started.md](https://github.com/open-mmlab/mmdetection/docs/getting_started.md) for the basic usage of MMDetection. However, some of these may not apply to these repository.
26
27Please see [usage/instructions](https://github.com/open-mmlab/mmdetection/docs/jacinto_ai_detection_usage.md) for training and testing with this repository.
28
29
30## Benchmark and Model Zoo
31
32Several trained models with accuracy report is available at [Jacinto-AI-Detection Model Zoo](docs/jacinto_ai/jacinto_ai_detection_model_zoo.md)
33
34
35## Quantization
36
37Tutorial on how to do [Quantization Aware Training in Jacinto-AI-Detection](docs/jacinto_ai/jacinto_ai_quantization_aware_training.md) in Jacinto-AI-MMDetection.
38
39
40## Acknowledgement
41
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.
43We 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.
44
45
46## Citation
47
48This package/toolbox is an extension of mmdetection (https://github.com/open-mmlab/mmdetection). If you use this package/toolbox or benchmark in your research, please cite that project as well.
49
50```
51@article{PyTorch-Jacinto-AI-Detection,
52 title = {{PyTorch-Jacinto-AI-Detection}: An Extension To Open MMLab Detection Toolbox and Benchmark},
53 author = {Jacinto AI Team, jacinto-ai-devkit@list.ti.com},
54 journal = {https://github.com/TexasInstruments/jacinto-ai-devkit},
55 year={2020}
56}
57```
58```
59@article{mmdetection,
60 title = {{MMDetection}: Open MMLab Detection Toolbox and Benchmark},
61 author = {Chen, Kai and Wang, Jiaqi and Pang, Jiangmiao and Cao, Yuhang and
62 Xiong, Yu and Li, Xiaoxiao and Sun, Shuyang and Feng, Wansen and
63 Liu, Ziwei and Xu, Jiarui and Zhang, Zheng and Cheng, Dazhi and
64 Zhu, Chenchen and Cheng, Tianheng and Zhao, Qijie and Li, Buyu and
65 Lu, Xin and Zhu, Rui and Wu, Yue and Dai, Jifeng and Wang, Jingdong
66 and Shi, Jianping and Ouyang, Wanli and Loy, Chen Change and Lin, Dahua},
67 journal= {arXiv preprint arXiv:1906.07155},
68 year={2019}
69}
70```
71
72
73## Contact
74This extension of MMDetection is part of Jacinto-AI-DevKit and is maintained by the Jacinto AI team: jacinto-ai-devkit@list.ti.com