Commit Graph

35 Commits (8a407ca214eb7c224a3e651f5b475780299fbce2)

Author SHA1 Message Date
Zaida Zhou 67acdbe245
[Docs] Add a document about debug tricks (#938)
* fix typo

* [Docs] Add debug skills

* minor fix

* refine

* rename debug_skills to debug_tricks

* refine

* Update docs/en/common_usage/debug_tricks.md
2023-02-21 21:40:35 +08:00
Zaida Zhou 4861f034a7
[Docs] Count FLOPs and parameters (#939)
* [Docs] Count FLOPs and parameters

* add the doc to index.rst

* fix table in HTML

* fix

* fix

* fix indent

* refine
2023-02-21 21:16:18 +08:00
Mashiro 346989464c
[Docs] Add the document for the transition between IterBasedTraining and EpochBasedTraining (#926)
* Add epoch 2 iter

* Add epoch 2 iter

* Refine chinese docs

* Add example for training CIFAR10 by iter

* minor refine

* Fix as comment

* Fix as comment

* Refine description

* Fix as comment

* minor refine

* Refine description

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

* Translate to en

* Adjust indent

---------

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
2023-02-21 21:12:38 +08:00
Songyang Zhang aee2f6a688
[Feature] Support model complexity computation (#779)
* [Feature] Add support model complexity computation

* [Fix] fix lint error

* [Feature] update print_helper

* Update docstring

* update api, docs, fix lint

* fix lint

* update doc and add test

* update docstring

* update docstring

* update test

* Update mmengine/analysis/print_helper.py

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

* Update mmengine/analysis/print_helper.py

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

* Update mmengine/analysis/print_helper.py

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

* Update mmengine/analysis/print_helper.py

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

* Update mmengine/analysis/print_helper.py

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

* Update mmengine/analysis/print_helper.py

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

* Update mmengine/analysis/print_helper.py

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

* Update mmengine/analysis/print_helper.py

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

* Update mmengine/analysis/print_helper.py

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

* Update mmengine/analysis/print_helper.py

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

* Update mmengine/analysis/print_helper.py

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

* Update mmengine/analysis/print_helper.py

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

* Update mmengine/analysis/print_helper.py

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

* Update mmengine/analysis/print_helper.py

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

* Update mmengine/analysis/complexity_analysis.py

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

* Update docs/en/advanced_tutorials/model_analysis.md

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

* Update docs/en/advanced_tutorials/model_analysis.md

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

* update docs

* update docs

* update docs and docstring

* update docs

* update test withj mmlogger

* Update mmengine/analysis/complexity_analysis.py

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

* Update tests/test_analysis/test_activation_count.py

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

* Apply suggestions from code review

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

* update test according to review

* Apply suggestions from code review

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

* fix lint

* fix test

* Apply suggestions from code review

* fix API document

* Update analysis.rst

* rename variables

* minor refinement

* Apply suggestions from code review

* fix lint

* replace tabulate with existing rich

* Apply suggestions from code review

* indent

* Update mmengine/analysis/complexity_analysis.py

* Update mmengine/analysis/complexity_analysis.py

* Update mmengine/analysis/complexity_analysis.py

---------

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
Co-authored-by: zhouzaida <zhouzaida@163.com>
2023-02-20 15:00:28 +08:00
Zaida Zhou 502edec0b6
[Docs] how to set the interval parameter (#917)
* [Docs] how to set the interval parameter

* fix link

* fix

* fix

* refine

* refine

* Update docs/zh_cn/common_usage/set_interval.md

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

* Update index.rst

---------

Co-authored-by: Qian Zhao <112053249+C1rN09@users.noreply.github.com>
2023-02-14 11:42:49 +08:00
Zaida Zhou 74fcaea0ab
[Docs] Introduce how to set random seed (#914)
* [Docs] Introduce how to set random seed

* add a comment
2023-02-13 16:14:48 +08:00
Zaida Zhou 4749682885
[Docs] Move examples to a new directory (#911)
* [Docs] Move examples to a new directory

* fix typo
2023-02-07 17:03:35 +08:00
Mashiro 50465a2002
[Docs] Add Chinese documentation for inferencer (#884)
* [Feature] Add BaseInferencer (#773)

* Update BaseInferencer

* Fix ci

* Fix CI and rename iferencer to infer

* Fix CI

* Add renamed file

* Add test file

* Adjust interface sequence

* refine preprocess

* Update unit test

Update unit test

* Update unit test

* Fix unit test

* Fix as comment

* Minor refine

* Fix docstring and support load image from different backend

* Support load collate_fn from downstream repos, refine dispatch

* Minor refine

* Fix lint

* refine grammar

* Remove FileClient

* Refine docstring

* add rich

* Add list_models

* Add list_models

* Remove backend args

* Minor refine

* Fix typos in docs and type hints (#787)

* [Fix] Add _inputs_to_list (#795)

* Add preprocess inputs

* Add type hint

* update api/infer in index.rst

* rename preprocess_inputs to _inputs_to_list

* Fix doc format

* Update infer.py

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

* [Fix] Fix alias type (#801)

* [Enhance] Support loading model config from checkpoint (#864)

* first commit

* [Enhance] Support build model from weight

* minor refine

* Fix type hint

* refine comments

* Update docstring

* refine as comment

* Add  method

* Refine docstring

* Fix as comment

* refine comments

* Refine warning message

* Fix unit test and refine comments

* add infer.md

* minor refine

* minor refine

* minor refine

* Apply suggestions from code review

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

* Fix conflicts and minor refine

* minor refine

* Fix as comment

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
Co-authored-by: Tong Gao <gaotongxiao@gmail.com>
2023-01-16 16:31:11 +08:00
Mashiro 2d8f2be375
[Feature] Add BaseInferencer (#874)
* [Feature] Add BaseInferencer (#773)

* Update BaseInferencer

* Fix ci

* Fix CI and rename iferencer to infer

* Fix CI

* Add renamed file

* Add test file

* Adjust interface sequence

* refine preprocess

* Update unit test

Update unit test

* Update unit test

* Fix unit test

* Fix as comment

* Minor refine

* Fix docstring and support load image from different backend

* Support load collate_fn from downstream repos, refine dispatch

* Minor refine

* Fix lint

* refine grammar

* Remove FileClient

* Refine docstring

* add rich

* Add list_models

* Add list_models

* Remove backend args

* Minor refine

* Fix typos in docs and type hints (#787)

* [Fix] Add _inputs_to_list (#795)

* Add preprocess inputs

* Add type hint

* update api/infer in index.rst

* rename preprocess_inputs to _inputs_to_list

* Fix doc format

* Update infer.py

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

* [Fix] Fix alias type (#801)

* [Enhance] Support loading model config from checkpoint (#864)

* first commit

* [Enhance] Support build model from weight

* minor refine

* Fix type hint

* refine comments

* Update docstring

* refine as comment

* Add  method

* Refine docstring

* Fix as comment

* refine comments

* Refine warning message

* Fix unit test and refine comments

* replace MODULE2PACKAGE to MODULE2PAKCAGE

* Fix typo and syntax error in docstring

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
Co-authored-by: Tong Gao <gaotongxiao@gmail.com>
2023-01-16 16:01:06 +08:00
Mashiro a9b6753fbe
Make TTAModel compatible with FSDP (#611)
* Add build_runner_with_tta and PrepareTTAHook

* rename hook file

* support build tta runner with runner type

* add unit test

* Add build_runner_with_tta to index.rst

* minor refine

* Add runner test cast

* Fix unit test

* fix unit test

* tmp save

* pop None if key does not exist

* Fix is_model_wrapper and force register class in test_runner

* [Fix] Fix is_model_wrapper

* destroy group after ut

* register module in testcase

* pass through unit test

* fix as comment

* remove breakpoint

* remove mmengine/testing/runner_test_cast.py

* minor refine

* minor refine

* minor refine

* set default data preprocessor for model

* minor refine

* minor refine

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

* fix lint

* Fix unit test

* replace  with  in ImgDataPreprocessor

* Fix as comment

* add inference tutorial in advanced tutorial

* update index.rst

* add tta example

* refine tta tutorial

* Add english tutorial

* add note for build_runner_with_tta

* Fix as comment

* add examples

* remove chinese comment

* Update docs/en/advanced_tutorials/test_time_augmentation.md

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

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
Co-authored-by: RangiLyu <lyuchqi@gmail.com>
2022-12-27 21:39:43 +08:00
Xiangxu-0103 e1f61252d4
[Docs] fix typo (#841)
* Update README.md

* Update index.rst
2022-12-20 15:45:15 +08:00
Mashiro bda8c940d2 [Docs] translate the mangermixin tutorial (#711)
* [Docs] translate the mangermixin tutorial

* Fix as comment

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

* Minor refine

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

* Remove blank block

* fix lint

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 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
Mashiro 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
Mashiro 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
Mashiro 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
Zaida Zhou 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
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
Mashiro 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
Mashiro 68b6b542eb
[Docs] migrate runner from mmcv. (#457) 2022-08-30 21:31:02 +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
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