Commit Graph

15 Commits (63f3afb8a81c78ad3eb396cf9d3c989c4838b230)

Author SHA1 Message Date
Mashiro 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
Ma Zerun 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
Zaida Zhou 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
Mashiro 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
Zaida Zhou 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
Zaida Zhou 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
Zaida Zhou 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
Zaida Zhou 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
Zaida Zhou 10330cde9d
[Docs] Add installation docs (#406)
* Add installation docs

* fix typo
2022-08-19 10:48:45 +08:00
Wenwei Zhang 7367df7ea7
Update docs of data element (#180)
* refine docs of data element

* update

* resolve comments
2022-04-20 13:16:31 +08:00
Zaida Zhou e146233546
fix documentation (#91) 2022-03-06 14:36:46 +08:00
Zaida Zhou 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
Zaida Zhou cccd20a636
[Feature] Add Registry (#11) 2022-02-16 21:45:39 +08:00
Zaida Zhou 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
Zaida Zhou e88ae3a2c5
[Docs] Add the structure of the documentation (#12)
* [Docs] Configure the documentation

* delete mypy.ini
2022-02-12 22:14:15 +08:00