17 Commits

Author SHA1 Message Date
Ma Zerun
ca997c5a79
Update schedule.md 2021-11-22 14:18:01 +08:00
Ma Zerun
7977dc8e2d
[Improvement] Rename config files according to the config name standard. (#508)
* Update tnt config

* Rename config files

* Update docs

* Update metafile in dev_scripts

* Fix some files

* Remove fp16 metafile and README.

* Fix names in metafiles.
2021-11-19 14:20:35 +08:00
Ezra-Yu
771d10548c
[Docs] Add schedule and runtime tutorial docs (#499)
* add cn tutorials/config.md

* add heads api and doc title link

* Update tutorials index

* Update tutorials index

* Update config.md

* add english version

* Update config.md

* add custom_runtime

* Update docs

* modify title

* modify en to zh_CN in chinses docs

* Update Readme

* fix punctuations

* Update docs/tutorials/customize_runtime.md

Co-authored-by: Ma Zerun <mzr1996@163.com>

* Update docs/tutorials/customize_runtime.md

Co-authored-by: Ma Zerun <mzr1996@163.com>

* split to schedule and runtime

* fix lint

* improve docs after review

* fix TOC

* imporve expersion

* fix an error

* Imporve schedule.md

* Improve runtime.md

* Improve chinese docs.

* Fix toc-tree

* fix en link and add a case of gradient clipping

* fix wrong word

Co-authored-by: Ma Zerun <mzr1996@163.com>
2021-11-17 18:12:54 +08:00
Ma Zerun
54ef176235
[Docs] Add English Colab tutorials. (#497)
* Add English-version Colab tutorials

* Revise Chinese-version Colab tutorials.

* Add colab tutorials menu on readthedocs page.

* Fix lint
2021-10-26 17:40:24 +08:00
Ezra-Yu
3a35b6f956
[Docs] Add tutuorial for config. (#487)
* add cn tutorials/config.md

* add heads api and doc title link

* Update tutorials index

* Update tutorials index

* Update config.md

* add english version

* Update config.md

* Update docs

* Update css

* Update docs/tutorials/config.md

Co-authored-by: Ma Zerun <mzr1996@163.com>

* Update docs_zh-CN/tutorials/config.md

Co-authored-by: Ma Zerun <mzr1996@163.com>

* modify according to suggestion

* Use GitHub style `code` css

* change some mmcv API link to CN version

* remove default in default_runtime

Co-authored-by: mzr1996 <mzr1996@163.com>
2021-10-26 16:43:33 +08:00
Ezra-Yu
9dbe58bf8e
[Feature] Add pipeline visualization tools. (#406)
* add vis

* add tool vis-pipeline

* add docs

* Update docs

* pre-commit

* enhence english expression

* Add `BaseImshowContextmanager` and `ImshowInfosContextManager` to reuse
matplotlib figure.

* Use context manager to implement `imshow_infos`

* Add unit tests.

* More general base context manager.

* unit tests for context manager.

* Improve docstring.

* Fix context manager exit cannot close figure when matplotlib>=3.4.0

* Fix unit tests

* fix lint

* fix lint

* add adaptive

* add adaptive

* update adaptive

* add GAP

* improve doc and docstring

* add visualization in doc index

* Update doc

* Update doc

* Update doc

* Update doc

* Update doc

* Update doc

* update docs and docstring

* add progressbar

* add progressbar

* add images

* add images

* Delete .DS_Store

* replace images

* replace images and modify rgb2bgr

* add picture size

* mv pictures

* update img display

* add doc_zh-CN images

* Update vis_pipeline.py

* Update visualization.md

* Update visualization.md

* fix lint

* Improve docs.

Co-authored-by: mzr1996 <mzr1996@163.com>
2021-10-20 10:28:21 +08:00
Ezra-Yu
0381309921
[Docs] Update Chinese Colab tutorials. (#483)
* fix *.ipynb

* fix *.ipynb

* fix lint
2021-10-15 17:37:12 +08:00
Ma Zerun
6fba107840
[Refactor] Use context manager to reuse matplotlib figures. (#432)
* Add `BaseImshowContextmanager` and `ImshowInfosContextManager` to reuse
matplotlib figure.

* Use context manager to implement `imshow_infos`

* Add unit tests.

* More general base context manager.

* unit tests for context manager.

* Improve docstring.

* Fix context manager exit cannot close figure when matplotlib>=3.4.0

* Fix unit tests

* Support inline backend in visualization.
2021-09-30 13:59:27 +08:00
Ma Zerun
8b7d38b243
[Docs] Update getting_started.md and install.md and rewrite finetune.md (#466)
* Disable auto line-wrap in docs.

* Add model_zoo.md and CONTRIBUTING.md in docs.

* Revise getting_started.md and install.md

* Rewrite finetune.md

* Fix typo

* Imporve `finetune.md`

* Fix `GitHub` link

* Fix a small typo.
2021-09-28 18:05:50 +08:00
Ma Zerun
c92eefbb4a
[Docs] Fix Open in colab link in Colab tutorials. (#377) 2021-07-27 19:57:21 +08:00
WRH
19ff0d198c
[Docs] Add chinese ipynb tutorial (#306)
* add chinese ipynb

* Update Chinese Colab tutorials.

* Update colab docs to ensure deterministic.

* Add `open in colab` button.

Co-authored-by: mzr1996 <mzr1996@163.com>
2021-07-27 13:58:27 +08:00
Ma Zerun
d04ebc1eb5
[Docs] Add API Reference in the docs (#342)
* Add API inference in the docs and fix readthedocs config.

* Replace some relative link in docs.

* Format docstring for reStructuredText syntax.

* Fix vit paper link

* Fix docstring of `show_results` function in `BaseClassifier`.
2021-07-14 15:06:50 +08:00
Ma Zerun
42b99be9b2
[Docs] rearrange docs and add multiple translation docs. (#320)
* Move tools docs to `tools` folder.

* Fix link error in model_serving.md

* Fix typo in CONTRIBUTING.md

* Add Chinese translation of CONTRIBUTING.md

* Add translation of `onnx2tensorrt.md`, `pytorch2onnx.md`,
`model_serving.md` and `pytorch2torchscript.md`.

* Improve tools docs.

* Add docs about installing mmcls via mim.
2021-06-30 20:53:09 +08:00
Ma Zerun
4524327a4a
[Docs] Fix typo, improve and add Chinese translation of data_pipeline.md and new_modules.md (#265)
* Improve docs, including `new_modules.md` and `data_pipeline.md`

* Add Chinese docs `new_modules.md` and `data_pipeline.md`
2021-05-29 10:48:31 +08:00
Ma Zerun
a06827bc08
Build chinese translation in readthedocs (#267)
* change document layout

* Add Chinese docs build file

* Add switch language option
2021-05-29 10:00:37 +08:00
mzr1996
9e93feabac
[Docs] Fix error in new_dataset.md and add Chinese translation of finture.md, new_dataset.md (#243)
* Fix error in new_dataset.md

* Add Chinese Translation of finture.md, new_dataset.md
2021-05-10 17:17:37 +08:00
mzr1996
3d87474c71
Add Chinese Readme and docs (#221)
* Add Citation in README

Add Citation and mmgeneration in README

* Merge inference and test section in getting_start.md and other small chagne.

* Fix code type in install.md

* Add Chinese Readme

* README and docs improvement.
2021-04-26 13:58:18 +08:00