Commit Graph

108 Commits (8a407ca214eb7c224a3e651f5b475780299fbce2)

Author SHA1 Message Date
Zaida Zhou fc9518e2c1
[Feature] Add Lion optimizer (#952) 2023-02-23 11:24:50 +08:00
Qian Zhao 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
Xin Li bb11f4d392
[Docs] Translate optim_wrapper.md (#833)
* init

* Update docs/en/tutorials/optim_wrapper.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/tutorials/optim_wrapper.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/tutorials/optim_wrapper.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/tutorials/optim_wrapper.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/tutorials/optim_wrapper.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/tutorials/optim_wrapper.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/tutorials/optim_wrapper.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/tutorials/optim_wrapper.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/tutorials/optim_wrapper.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/tutorials/optim_wrapper.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/tutorials/optim_wrapper.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/tutorials/optim_wrapper.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/tutorials/optim_wrapper.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/tutorials/optim_wrapper.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/tutorials/optim_wrapper.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/tutorials/optim_wrapper.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/tutorials/optim_wrapper.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/tutorials/optim_wrapper.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/tutorials/optim_wrapper.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/tutorials/optim_wrapper.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/tutorials/optim_wrapper.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/tutorials/optim_wrapper.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/tutorials/optim_wrapper.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/tutorials/optim_wrapper.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/tutorials/optim_wrapper.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* update link in the Chinese version

* Update docs/en/tutorials/optim_wrapper.md

* Apply suggestions from code review

* Update docs/en/tutorials/optim_wrapper.md

* merge&remove redundant spaces

* Update docs/en/tutorials/optim_wrapper.md

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* update flat_decay_mult

* Apply suggestions from code review

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>
Co-authored-by: Qian Zhao <112053249+C1rN09@users.noreply.github.com>
Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
2022-12-22 10:44:23 +08:00
RangiLyu 3582b4c787
[Enhance] Support setting decay multiplier for flatten parameter (#771)
* [Fix] Fix bias decay mult of depth-wise conv.

* support flatten param weight decay multiplier

* add unit tests

* REMOVE TODO

* update doc
2022-12-16 17:37:22 +08:00
Timothy be0bc3a0ef
[Docs] Fix typos (#814)
* Update model.md

* Update model.md

* Update model.md

* Update evaluation.md

* Update param_scheduler.md

* Update hook.md

* Fix lint issue

* fix lint issues

Co-authored-by: shanmo <shanmo1412@gmail.com>
2022-12-11 17:12:29 +08:00
Mashiro af408786a2 [Docs] Translate model tutorial (#738)
* translate model first time

* Update docs/en/tutorials/model.md

Co-authored-by: Qian Zhao <112053249+C1rN09@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Qian Zhao <112053249+C1rN09@users.noreply.github.com>
Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
2022-12-06 17:22:02 +08:00
Qian Zhao 7f11b5d1f0 [Docs] Translate runner tutorial (#724)
* partially translated the runner tutorial

* more translation done

* finish translation

* minor refine

* minor refine of chinese doc

* Apply suggestions from code review

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* fix as comments

* Apply suggestions from code review

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>
Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
2022-12-06 17:22:02 +08:00
Mashiro bfe7d2d467 [Docs] Refactor model.md (#674)
* Refactor model.md

* minor refine

* Fix as comment

* Fix error link

* Fix as comment

* Fix as comment

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* replace Dataloader with DataLoader

* minor refine

* resolve conflict

* fix render code block

* Fix error link

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
2022-12-06 17:22:02 +08:00
Qian Zhao 6482845671 [Doc] Refactor runner tutorial (#657)
* refactor runner tutorial

* remove watermark in picture

* fix as comments

* remove toc in runner tutorial

* Apply suggestions from code review

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* Update docs/zh_cn/tutorials/runner.md

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
Yining Li 1323251c02 [Doc] Refine evaluation docs (#701)
* refine evaluation docs

* fix link

* Update docs/zh_cn/design/evaluation.md

Co-authored-by: Qian Zhao <112053249+C1rN09@users.noreply.github.com>

* Update docs/zh_cn/tutorials/evaluation.md

Co-authored-by: RangiLyu <lyuchqi@gmail.com>

* Update docs/zh_cn/tutorials/evaluation.md

Co-authored-by: RangiLyu <lyuchqi@gmail.com>

* resolve comments

* Apply suggestions from code review

* Update docs/zh_cn/tutorials/evaluation.md

Co-authored-by: Qian Zhao <112053249+C1rN09@users.noreply.github.com>
Co-authored-by: RangiLyu <lyuchqi@gmail.com>
Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
2022-12-06 17:22:02 +08:00
Mashiro 9033c70a3e [Docs] Refine `optim_wrapper.md` (#676)
* refine optim_wrapper.md

* minor refine

* Minore refine
2022-12-06 17:22:02 +08:00
RangiLyu 66ba4f749d [Doc] Update scheduler doc (#670)
* [Doc] Update scheduler doc.

* Update docs/zh_cn/tutorials/param_scheduler.md

* Update docs/zh_cn/tutorials/param_scheduler.md

* Update docs/zh_cn/tutorials/param_scheduler.md

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
2022-12-06 17:22:02 +08:00
Qian Zhao bcbfa20c8b [Doc] Add dataset & dataloader tutorial (#696)
* dataset tutorial abstract

* complete dataloader & dataset tutorial

* minor fix

* minor fix

* resolve comments

* rename some link to be more specific

* add warning to manually constructed sampler

* fix as comments
2022-12-06 17:22:02 +08:00
Zaida Zhou fed4a9224b [Docs] Refine hook docs (#704) 2022-12-06 17:22:02 +08:00
Qian Zhao 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
Xiangxu-0103 a530c0d671
[Docs] Refine docs/zh_cn/tutorials (#694) 2022-11-09 14:27:45 +08:00
Sanbu ed20a9cba5
[Docs] Fix metric typo (#675) 2022-11-06 21:58:47 +08:00
Yanhong Zeng 618a063ddc
[Docs] Fix docstring and documentation used for hub.get_model (#659)
* fix docstring and documentation used for hub.get_model

* fix config name in test_hub

* fix docstring mentioned faster-rcnn in utils
2022-11-02 10:16:56 +08:00
Tau d312bc40b0
[Doc] Refine chinese doc (#516)
* refine chinese doc

* remove  in title

* Update docs/zh_cn/tutorials/param_scheduler.md

* fix link

* remove files from building docs

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
Co-authored-by: zhouzaida <zhouzaida@163.com>
2022-10-21 19:35:51 +08:00
Mashiro 6073d9ebd8
[Enhance] add documents for `clip_grad` , and support clip grad by value. (#513)
* [Enhance] add documents for , and support clip grad by value

* refine docstring

* fix as comment

* Fix as comment

* minor refine

* minor refine

* remove error comment for clip grad

* refine docstring
2022-10-18 18:02:46 +08:00
Qian Zhao 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
Xiangxu-0103 276ca24edc
[Docs] Fix typo in docs/zh_cn/tutorials/config.md (#596) 2022-10-12 15:00:28 +08:00
Qian Zhao c5bddea13e
[Docs] Fix typo in docs/zh_cn/tutorials/model.md (#598) 2022-10-12 14:32:21 +08:00
vansin 1f63d2436c
[Doc] delete the error comment in docs (#514) 2022-10-08 11:34:35 +08:00
Zhengfei-0311 4e5c40b51b
[Doc]: Update config.md (#562)
* Update config.md

* Update config.md
2022-10-08 11:20:52 +08:00
Zaida Zhou a5eb179153
[Docs] Fix the docstring of model sub-package (#573) 2022-10-08 11:19:30 +08:00
Shaun 925f18347a
[Doc]: fix spell error (#548) 2022-09-26 14:33:46 +08:00
古月闻星 00bb73b8e3
[Fix] max_epoch to max_iters (#503) 2022-09-01 00:03:23 +08:00
Zaida Zhou 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
liukuikun 1fea82aad5
[Docs] update data element tutorials (#431)
* structure tutorials

* refine data element docs

* modify introduce

* fix comment

* fix comment

* fix comment
2022-08-31 20:39:08 +08:00
Mashiro 5a9ac09f28
[Doc]: Fix docs and docstring of config (#497) 2022-08-31 20:01:35 +08:00
古月闻星 980243018f
[Fix] fix runner docs (#495)
* [Fix] fix the typo

* [Fix] add the missing argument
2022-08-31 18:59:25 +08:00
Mashiro fbd31d2041
[Docs] Refine config docs. (#432)
* tmp commit

* refine docstring

* minor refine

* fix as comment

* add tutorial for merge_from_dict

* minor refine

* minor refine

* export md by jupyter

* temp add ipnb

* refine the docs

* remote ipynb

* fix as comment

* add change _base_.variable

* Fix as comment

* minor refine

* Fix as comment

* Fix as comment

* minor refine
2022-08-30 18:39:19 +08:00
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
yancong 7e423cf23f
[Docs] Add fileio tutorials (#420)
* docs(zh_cn/tutorials): add fileio tutorials

* Update docs/zh_cn/tutorials/fileio.md

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
2022-08-29 22:58:49 +08:00
Wencheng Wu f2df9efefb
[Fix] Fix typo in docs. (#485) 2022-08-29 22:39:42 +08:00
Yining Li 0bb9591f07
[Docs] refine metric/evaluator docs (#442)
* refine metric/evaluator doc

* resolve comments

* resolve comments
2022-08-29 16:23:24 +08:00
Ma Zerun 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
Zaida Zhou 2f09342663
[Docs] Refine registry docs (#443)
* [Docs] Refine registry docs

* explain how to use _scope_

* refine
2022-08-29 14:50:48 +08:00
Mashiro d68fd5a654
[Docs] Add docs for `OptimWrapper` (#411)
* add optimizer wrapper docs

* remove optimizer.md

* minor refine

* Fix as comment

* minor refine

* tmp save ipynb

* add default constructor docs

* remove ipynb

* fix as comment

* remove color charactor

* fix as comment
2022-08-28 17:11:58 +08:00
Tao Gong 54e7812926
[Doc]: Explain the priority of dataset.metainfo in basedataset.md (#476)
* Update basedataset.md

* Update basedataset.md

* Update basedataset.md

* Update basedataset.md

* Slight rephrase

Co-authored-by: Wenwei Zhang <40779233+ZwwWayne@users.noreply.github.com>
2022-08-26 16:34:04 +08:00
Haian Huang(深度眸) 4bd00bc85c
[Docs] Add visualizer docs (#418)
* Add Visualizer tutorials

* Add Visualizer designs

* update

* update

* update

* fix commit

* add demo image

* simplify code according to #440 and add some results picture

* replace image url

* update

Co-authored-by: liukuikun <liukuikun@sensetime.com>
2022-08-26 10:01:04 +08:00
Mashiro 8770c6c7fc
[Refactor] Refactor data flow to make the interface more natural (#468)
* [Refactor]: modify interface of Visualizer.add_datasample (#365)

* [Refactor] Refactor data flow: refine `data_preprocessor`. (#359)

* refine data_preprocessor

* remove unused BATCH_DATA alias

* Fix type hints

* rename move_data to cast_data

* [Refactor] Refactor data flow: collate data in `collate_fn` of `DataLoader`  (#323)

* acollate data in dataloader

* fix docstring

* refine comment

* fix as comment

* refactor default collate and psedo collate

* foramt test file

* fix docstring

* fix as comment

* rename elem to data_item

* minor fix

* fix as comment

* [Refactor] Refactor data flow: `data_batch` argument of `Evaluator.process is a `dict` (#360)

* refine evaluator and metric

* compatible with new default collate

* replace default collate with pseudo

* Handle data_batch in metric

* fix unit test

* fix unit test

* fix unit test

* minor refine

* make data_batch optional

make data_batch optional

* rename outputs to predictions

* fix ut

* rename predictions to outputs

* fix docstring

* fix docstring

* fix unit test

* make outputs and data_batch to kwargs

* fix unit test

* keep signature of metric

* fix ut

* rename pred_sample arguments to data_sample(Visualizer)

* fix loop and ut

* [refactor]: Refactor model dataflow (#398)

* [Refactor] Refactor data flow: refine `data_preprocessor`. (#359)

* refine data_preprocessor

* remove unused BATCH_DATA alias

* Fix type hints

* rename move_data to cast_data

* refactor model data flow

tmp_commt

tmp commit

* make val_cfg and test_cfg optional

* roll back runner

* pass test mmdet

* fix as comment

fix as comment

fix ci in DataPreprocessor

* fix ut

* fix ut

* fix rebase main

* [Fix]: Fix test val ddp (#462)

* [Fix] Fix docstring and type hint of data flow (#463)

* Fix docstring of data flow

* change signature of hook

* fix unit test

* resolve conflicts

* fix lint
2022-08-24 22:04:55 +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
Tao Gong 7fc0a51aae
[Doc]: Update the tutorials of basedataset (#445)
* modify the tutorials of basedataset

* tmp commit
2022-08-23 11:54:38 +08:00
RangiLyu 5e1ef1dd6c
[Docs] Update runner documents. (#430)
* [Doc] Update runner documents.

* update

* fix link

* update

* update

* Update import manner of Runner

Co-authored-by: Wenwei Zhang <40779233+ZwwWayne@users.noreply.github.com>
2022-08-22 11:30:49 +08:00
yancong d6bf587d68
[Docs] Modify distributed tutorials (#421)
* docs: modify distributed tutorials

* docs: modify distributed tutorials

* docs(zh_cn/tutorials): fix wrong modifications in distributed.md
2022-08-21 14:58:25 +08:00