c712070c90
[Docs] Resolve warnings in sphinx build ( #915 )
...
* add ZeroOptimizer to optim
* resolve `duplicate label` warnings
* upgrade docutils && shpinx to resolve `unknown directive or role` warnings
* fix typo
* resolve literal_block && heading warnings
* resolve json literal_block warnings
* resolve python literal_block warnings
* resolve bunches of reference warnings
* resolve bunches of docstring warnings
* resolve warnings in autosummary
* resolve remaining warnings in en docs
* resolve heading warnings in zh_cn docs
* resolve remaining warnings in zh_cn docs
* fix as comments
* fix as comments
2023-02-08 20:36:57 +08:00
2cb71d93b3
[Docs] Update README ( #835 )
...
* Update link
* update zh version of readme
* fix typo
* Update README_zh-CN.md
* Update README_zh-CN.md
* Update README_zh-CN.md
* fix minor typo
* Update README_zh-CN.md
* Update README_zh-CN.md
* update docs
* Update infer.md
* Update README.md
* minor refinement
---------
Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
2023-02-05 13:01:47 +08:00
f10b5cefd9
[Docs] Clear the documentations about Python3.6 ( #865 )
2023-01-06 15:40:35 +08:00
af0e29094b
[Doc] Adjust docs structure ( #646 )
...
* adjust docs structure
* en caption rename
* Update docs/en/index.rst
Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
* Update docs/en/index.rst
Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
* Update docs/zh_cn/index.rst
Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
2022-12-06 17:22:02 +08:00
0dd0a22e75
[Docs] Add gif to 15 min tutorial ( #748 )
...
* add gif
* replace gif
* minor refine
* replace gif with higher resolution
2022-12-04 11:21:40 +08:00
09a195b24c
[Docs] Fix Chinese docs whitespaces ( #521 )
...
* change pre-commit-config
* modify docs with pre-commit hook
* change pre-commit-config-zh-cn
* fallback readme.md
Co-authored-by: HAOCHENYE <21724054@zju.edu.cn>
2022-10-17 14:20:00 +08:00
58d8a41966
[Fix] MacOS to macOS ( #500 )
2022-09-01 11:16:39 +08:00
458f6d684e
[Docs] Refactor docs structure ( #494 )
...
* [WIP] Refactor-docs-structure
* [Docs] Check link and fix rst (#498 )
* check link
* fix rst
* Fix conf.py
* Fix lint
* minor refine
* minor refine
* modify zh_readme and index.rst
* add migration exampls get_started design to en
* add tutorials to en
* correct chinese doc link
* Apply suggestions from code review
* Update docs/en/advanced_tutorials/distributed.md
Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>
2022-08-31 21:18:55 +08:00
3f5e08fa4a
[Docs] Make API of docs clearer ( #469 )
...
* [Docs] Make API of docs clearer
* minor fix
* fix md format
2022-08-30 16:27:20 +08:00
89b56b240a
[Doc]: Add mmengine demo and do some modifications for it. ( #363 )
...
* Update demo in get started tutorial
* Update demo tutorial
* Refactor the pytorch demo
* Add outline and titles to the demo tutorial.
* Move file and change title
* Add shuffle in dataloader arguments.
* Improve according to comments
2022-08-29 16:19:11 +08:00
4be57e5ebb
[Doc]: Add introduction of mmengine in get_started.md ( #481 )
...
* add introduction of mmengine in get_started.md
* resolve comments
* resolve comments
* resolve comments
* resolve comments
* resolve comments
* resolve comments
* update figs
2022-08-29 16:17:59 +08:00
10330cde9d
[Docs] Add installation docs ( #406 )
...
* Add installation docs
* fix typo
2022-08-19 10:48:45 +08:00
Qian Zhao
Xiang Xu
Mashiro
古月闻星
Zaida Zhou
Ma Zerun
Wenwei Zhang