Commit Graph

8 Commits (3a35b6f95614701f997ff8ea171cb97f01c74569)

Author SHA1 Message Date
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
Ma Zerun fd0f5cce92
[Docs] Add model-pages in Model Zoo (#480)
* Add model-pages

* Add shortname in configs

* Use link directly instead of `switch_language.md`

* Auto collapse model-zoo pages.

* Fix link in RegVGG

* Add link replace

* fix lint
2021-10-14 15:26:47 +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 1d6d142b42
[Docs] Use PyTorch style docs theme (#457)
* Change docs theme to pytorch-theme

* Update docs rst

* Fix docs title level.

* Add static resources

* Fix lint
2021-09-23 22:21:03 +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 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