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
a49985f637
[Docs] Add contributing.md and code_style.md ( #754 )
...
* add contributing.md
* refine
* Fix as comment
2022-12-04 10:52:11 +08:00
910778a94e
[Docs] Fix cannot show `changelog.md` in chinese documents. ( #606 )
...
* [Fix] Fix error path of changelog.md in docs/zh_cn/index.rsts
* Fix stupid commit
* run bash script during build docs
* run bash script during build docs
* run bash script during build docs
* translate notes to 说明
* update auth
2022-10-14 16:56:34 +08:00
13484aae9f
Bump version to v0.2.0 ( #591 )
...
* Bump version to v0.2.0
* Add changelog
* minor refine
* minor refine
* update date
* clean the code
* minor refine
* update release date
* Fix grammar
* Fix grammar
* Fix grammar
* Fix grammar
* Minor refine
* Fix error format in readme
* update date
* minor refine
* minor refine
* minor refine
* minor refine
* refine grammar
2022-10-11 23:08:17 +08:00
ba1c368f94
[Docs] Fix index.rst in docs ( #505 )
...
* [Docs] Fix outdated index
* update index.rst
* fix readme url
2022-09-01 11:34:03 +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
627186d1a2
[Docs] Migrate model from mmcv ( #473 )
...
* migrate model
* fix title error
* refine as comment
* fix as comment
* minor refine
* Fix as comment
* Update docs/zh_cn/migration/migrate_model_from_mmcv.md
* Update docs/zh_cn/migration/migrate_model_from_mmcv.md
Co-authored-by: Qian Zhao <112053249+C1rN09@users.noreply.github.com>
2022-08-31 19:22:21 +08:00
68b6b542eb
[Docs] migrate runner from mmcv. ( #457 )
2022-08-30 21:31:02 +08:00
260d332a8e
[Docs] Add model docs ( #416 )
...
* first commit
* tmp commit
* tmp commit
* tmp
* finish base module
* tmp commit
* tmp commit
* first finish
* minor refine
* clean the code
* delete design
* refine
* minor refine
* fix as comment
* fix as comment
* refine from jupyter notebook
* minor refine
* split model.md to model.md and initialize.md
* minor refine
* minor refine
* make link availiable
* fix as chengqi comment
* fix as chengqi comment
* fix link
* fix as wenwei comment
* Fix as comment
* Fix as comment
* Fix lint
2022-08-30 18:36:20 +08:00
7a75d6d582
[Docs] Add data transform tutorials ( #455 )
...
* [Docs] Add data transform tutorials
* Rename `RandomMultiscaleResize` to `RandomChocieResize`.
* Imporve according to comments
* Add general data pipeline description.
2022-08-30 18:32:51 +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
9728b6aaef
[Docs] Simpify logging tutorials ( #452 )
...
* simpify logging tutorials
* minor refine
* minor refine
* refine index.rst
* fix as comment
* add description of by_epoch
* add log processor description
* minor refine
* minor refine
* Fix as comment
* Fix as comment
2022-08-30 16:22:15 +08:00
15905bdcc0
[Docs] Describe how to migrate hook from mmcv ( #451 )
...
* Add a doc to explain how to migrate hook from mmcv
* update style
* update format
* Add functional changes of hooks
* fix table style
* refine
* fix typo
2022-08-30 15:07:06 +08:00
dcab0f5055
[Docs] Add resume training examples ( #407 )
...
* [Docs] Add resume training examples
* refine
* rename filename
* minor refinement
* fix comments
* resolve comments
* resolve comments
2022-08-29 14:47:31 +08:00
6c607bd26f
[Docs] Simplify hook docs ( #428 )
...
* Move the design of hook to design/hook.md
* add relative links in docs
* update docstring of hooks
* refine checkpointhook docs
* refine
* fix comments
* refine
* add logging.md link in hook.md
* resolve comments
* fix typo
2022-08-23 16:20:47 +08:00
5e17dd7cd4
[Docs] Add speed training examples ( #408 )
...
* [Docs] Add speed training examples
* refine
* refine
* rename filename
* minor refine
2022-08-23 11:55:18 +08:00
10330cde9d
[Docs] Add installation docs ( #406 )
...
* Add installation docs
* fix typo
2022-08-19 10:48:45 +08:00
7367df7ea7
Update docs of data element ( #180 )
...
* refine docs of data element
* update
* resolve comments
2022-04-20 13:16:31 +08:00
e146233546
fix documentation ( #91 )
2022-03-06 14:36:46 +08:00
7313173405
[Docs] Add hooks tutorial ( #38 )
...
* [Docs] Add hooks tutorial
* improve the description about hooks
* Add OptimizerHook usages
* fix comments
* fix comments
* fix comments
* fix comments
* fix typo
* refine description
* refactor
* refactor
* add a sentence to improve docs
* briefly introduce the hook of pytorch
* refactor the order of sections
* improve the description about hooks
* improve
* fix comments
* update priorities
* improve description
* refactor title
* fix typo
* reorder priority of hook
* fix typo
* fix comments
* remove the distributed argument from SyncBuffersHook
2022-03-01 11:57:29 +08:00
cccd20a636
[Feature] Add Registry ( #11 )
2022-02-16 21:45:39 +08:00
27dd617532
[Docs] Add registry tutorial ( #3 )
...
* [Docs] Configure the documentation
* fix the format
* introduce the usage of default_scope
* add Chinese documentation
* move docs configure to another pr
* clean pr
* refactor registry docs
* fix typo
* fix typo
* reorg
* add more examples
* reslove comments
* reslove comments
* reslove comments
Co-authored-by: ZwwWayne <wayne.zw@outlook.com>
2022-02-15 13:12:16 +08:00
e88ae3a2c5
[Docs] Add the structure of the documentation ( #12 )
...
* [Docs] Configure the documentation
* delete mypy.ini
2022-02-12 22:14:15 +08:00
Qian Zhao
Mashiro
Zaida Zhou
Ma Zerun
Wenwei Zhang