mmyolo

History

Yijie Zheng 71fc5670cb [Docs] Add an ionogram example in MMYOLO application (#643 ) * [Fix] fix the config link for rtmdet_tiny * fir the lint * upload configs * [Docs]Add doc for application examples * [Doc] fix h1 title for ionogram_detection.md * [Fix] update doc links for project/misc/ * Update links for application_examples in README * Update links for application_examples in README * Fix the bad commit caused by a mistake merge. * Fix unnecessary modification on Table of Contents * Add description of dataset preparation * Add description of dataset preparation * Update dataset analysis and pipeline visualization * fix line too long * Update rtmdet_s in the benchmark * fix typo in the doc * Replace local ckpt path with url * Update file tree, check out for spaces * Beautify configs * Beautify configs * Add introduction of annotation tool * Update rtmdet benchmark * Update rtmdet configs * Fix typo * Add English doc * Minor revisio * Fix typo * Revision - check labels Co-authored-by: Range King <RangeKingHZ@gmail.com> * Revision - sentence structure Co-authored-by: Range King <RangeKingHZ@gmail.com> * Revision - fix typo Co-authored-by: Range King <RangeKingHZ@gmail.com> * Revision - parameters and FLOPs Co-authored-by: Range King <RangeKingHZ@gmail.com> * Revision - replace flops with FLOPs Co-authored-by: Range King <RangeKingHZ@gmail.com> * Revision - enhance readability Co-authored-by: Range King <RangeKingHZ@gmail.com> * Revision - fix typo Co-authored-by: Range King <RangeKingHZ@gmail.com> * Revision - correct grammatical errors Co-authored-by: Range King <RangeKingHZ@gmail.com> * Revision - enhance Co-authored-by: Range King <RangeKingHZ@gmail.com> --------- Co-authored-by: Range King <RangeKingHZ@gmail.com>		2023-03-13 11:29:37 +08:00
..
en	[Docs] Add an ionogram example in MMYOLO application (#643 )	2023-03-13 11:29:37 +08:00
zh_cn	[Docs] Add an ionogram example in MMYOLO application (#643 )	2023-03-13 11:29:37 +08:00
README.md	[Docs] Refactor zh-CN docs (#568 )	2023-02-20 15:51:37 +08:00

README.md

Build Documentation

Clone MMYOLO

git clone https://github.com/open-mmlab/mmyolo.git
cd mmyolo

Install the building dependencies of documentation
```
pip install -r requirements/docs.txt
```
Change directory to docs/en or docs/zh_cn
```
cd docs/en  # or docs/zh_cn
```
Build documentation
```
make html
```
Open _build/html/index.html with browser