106 Commits

Author SHA1 Message Date
Zaida Zhou
a06bb7782b
[Docs] Add readthedocs.yml (#501)
* [Docs] Add readthedocs.yml

* include torch in readthedocs.yml

* add torch torchvision in docs.txt
2022-08-31 23:34:25 +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
Yining Li
5349908e9b
use image without watermark (#496) 2022-08-31 20:01:16 +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
古月闻星
980243018f
[Fix] fix runner docs (#495)
* [Fix] fix the typo

* [Fix] add the missing argument
2022-08-31 18:59:25 +08:00
Mashiro
68b6b542eb
[Docs] migrate runner from mmcv. (#457) 2022-08-30 21:31:02 +08:00
Yifei Yang
63f3afb8a8
[Docs] add an example for gan training (#453)
* add an example for gan training

* remove data element

* fix as comments

* add type_as

* fix as comment

* refine

* fix as comment

* add more descriptions

* fix as comment

* fix a api
2022-08-30 21:06:35 +08:00
Zaida Zhou
a5284165c6
Add the distributed training script (#487)
* Add the distributed training script

* fix md format
2022-08-30 19:05:51 +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
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
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
Ma Zerun
d6aa85fb36
[Docs] Add data transform migration docs (#460)
* [Docs] Add data transform migration docs

* Imporve according to comments
2022-08-29 22:39:19 +08:00
RangiLyu
58229636b5
[Docs] Cross library import examples. (#461)
* [Docs] cross library import examples.

* update

* resolve comments
2022-08-29 22:37:51 +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
Wenwei Zhang
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
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
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
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
RangiLyu
18a0338c91
[Docs] How to migrate scheduler. (#456)
* [Doc] Migrate scheduler.

* [Doc] Migrate scheduler.

* update

* resolve comments

* resolve comments
2022-08-26 11:35:33 +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
7e1d7af2d9
[Refactor] Refactor code structure (#395)
* Rename data to structure

* adjust the way to import module

* adjust the way to import module

* rename Structure to Data Structures in docs api

* rename structure to structures

* support using some modules of mmengine without torch

* fix circleci config

* fix circleci config

* fix registry ut

* minor fix

* move init method from model/utils to model/weight_init.py

* move init method from model/utils to model/weight_init.py

* move sync_bn to model

* move functions depending on torch to dl_utils

* format import

* fix logging ut

* add weight init in model/__init__.py

* move get_config and get_model to mmengine/hub

* move log_processor.py to mmengine/runner

* fix ut

* Add TimeCounter in dl_utils/__init__.py
2022-08-24 19:14:07 +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
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
Haian Huang(深度眸)
ca282aee9e
[Doc]: add save_gpu_memory docs (#419)
* Add save_gpu_memory docs

* update

* fix comment

* fix comment
2022-08-22 18:10:28 +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
RangiLyu
38ab4bec5e
[Docs] Update scheduler doc. (#439)
* [Docs] Update scheduler doc.

* update
2022-08-19 11:09:57 +08:00
Zaida Zhou
10330cde9d
[Docs] Add installation docs (#406)
* Add installation docs

* fix typo
2022-08-19 10:48:45 +08:00
Zaida Zhou
f5cb45dc33
[Doc]: fix typo in installation command (#433) 2022-08-16 15:42:27 +08:00
Zaida Zhou
26342f3586
[Docs] Add the steps to build docs (#409) 2022-08-15 11:47:08 +08:00
Zaida Zhou
6501d21eab
[Fix]: fix mdformat version to support python3.6 (#315) 2022-06-21 16:32:58 +08:00
Zaida Zhou
e76517c63a
[Doc]: Update hooks docs (#317) 2022-06-21 15:13:53 +08:00
Zaida Zhou
d09af9ead4
[Doc]: update root registries in docs (#316) 2022-06-21 15:12:49 +08:00
Tao Gong
45f5859b50
[Doc]: refactor docs for basedataset (#318) 2022-06-21 14:58:10 +08:00
Mashiro
44538e56c5
[Doc]: refine logging doc (#320) 2022-06-21 14:55:21 +08:00
Alex Yang
5016332588
[Feat] support registering function (#302) 2022-06-14 14:50:24 +08:00
RangiLyu
70c4ea191f
[Refactor]: Modify val_interval and val_begin to be the attributes of TrainLoop. (#274)
* Modify val_interval and val_begin to be the attributes of TrainLoop.

* update doc

* fix lint

* type hint
2022-06-06 11:13:25 +08:00
RangiLyu
4705e1fe3d
[Enhance] Add RuntimeInfoHook to update runtime information. (#254)
* [Enhance] Add RuntimeInfoHook to update runtime information.

* move lr to runtime info

* docstring

* resolve comments

* update ut and doc
2022-05-26 14:35:37 +08:00
Haian Huang(深度眸)
c197bdf359
[Feature] Profiling tools (#241)
* Add profiling tools

* fix docstr

* fix docstr

* update

* fix bug

* update

* update

* fix error

* fix mypy

* uodate

* merge main

* fix UT
2022-05-25 10:55:07 +08:00