Commit Graph

279 Commits (d9fee4fbb11e70207a0edf57502dc535fa726eb5)

Author SHA1 Message Date
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
Jiazhen Wang a976257ca9
[Enhance] Support Custom LogProcessor (#251)
* support custom log processor

* supplementary docs

* format code
2022-05-24 17:17:35 +08:00
RangiLyu 11688507ba
[Fix] Fix some bugs in hooks and runner. (#242)
* [Fix] Fix some bugs in hooks and runner.

* fix markdown

* fix latex formula

* resolve comments
2022-05-20 17:18:24 +08:00
Zaida Zhou 86ffc19c9c
Add pyupgrade pre-commit hook (#232)
* Add pyupgrade pre-commit hook

* fix ut

* remove comments
2022-05-19 17:56:31 +08:00
Zaida Zhou f5867f8442
Replace markdownlint with mdformat to avoid installing ruby (#233)
* Replace markdownlint with mdformat to avoid installing ruby

* fix circleci
2022-05-17 20:52:22 +08:00
Tao Gong 92b94e8e60
[Docs] Add docs for custom dataset wrapper (#222)
* add docs for custom dataset wrapper

* Update basedataset.md
2022-05-10 15:14:39 +08:00
Mashiro 452b3656a1
[Fix] Fix dump config without self.filename (#202)
* fix config

* add docstring and unit test

* update tutorial

* update tutorial

* fix markdown format

* fix markdown format
2022-04-27 19:43:12 +08:00
Wenwei Zhang 3c8806e4c6
Add docs about get started (#197)
* add docs about get started

* refine
2022-04-26 13:56:23 +08:00
Mashiro e0d00c5bdd
[Fix] resolve conflict betweem adapt and main. (#198)
* [Docs] Refine registry documentation (#186)

* [Docs] Refine registry documentation

* reslove comments

* minor refinement

* Refine Visualizer docs (#177)

* Refine Visualizer docs

* update

* update

* update featmap

* update docs

* update visualizer docs

* [Refactor] Refine LoggerHook (#155)

* rename global accessible and intergration get_sintance and create_instance

* move ManagerMixin to utils

* fix as docstring and seporate get_instance to get_instance and get_current_instance

* fix lint

* fix docstring, rename and move test_global_meta

* rename LogBuffer to HistoryBuffer, rename MessageHub methods, MessageHub support resume

* refine MMLogger timestamp, update unit test

* MMLogger add logger_name arguments

* Fix docstring

* Add LogProcessor and some unit test

* update unit test

* complete LogProcessor unit test

* refine LoggerHook

* solve circle import

* change default logger_name to mmengine

* refactor eta

* Fix docstring comment and unitt test

* Fix with runner

* fix docstring

fix docstring

* fix docstring

* Add by_epoch attribute to LoggerHook and fix docstring

* Please mypy and fix comment

* remove \ in MMLogger

* Fix lint

* roll back pre-commit-hook

* Fix hook unit test

* Fix comments

* remove \t in log and add docstring

* Fix as comment

* should not accept other arguments if corresponding instance has been created

* fix logging ddp file saving

* fix logging ddp file saving

* move log processor to logging

* move log processor to logging

* remove current datalaoder

* fix docstring

* fix unit test

* add learing rate in messagehub

* Support output training/validation/testing message after iterations/epochs

* fix docstring

* Fix IterBasedRunner log string

* Fix IterBasedRunner log string

* Support parse validation loss in log processor

* [Enhancement] Add PolyParamScheduler, PolyMomentum and PolyLR (#188)

* [Enhancement] Add PolyParamScheduler, PolyMomentum and PolyLR

* min_lr -> eta_min, refined docstr

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
Co-authored-by: Haian Huang(深度眸) <1286304229@qq.com>
Co-authored-by: Tong Gao <gaotongxiao@gmail.com>
2022-04-26 00:37:16 +08:00
ZwwWayne 4f5c0cd273 Merge branch 'main' of github.com:open-mmlab/mmengine into adapt 2022-04-22 13:52:48 +08:00
Tao Gong a3b8d4ea56
Refactor docs of basedataset (#175)
* refactor docs of basedataset

* fix ci

* fix comments

* fix comments

* fix comments

* fix comments

* fix comments

* set default value of ann_file to ''

* fix comments
2022-04-22 13:51:57 +08:00
ZwwWayne ae3b857480 Merge branch 'adapt' of github.com:open-mmlab/mmengine into adapt 2022-04-22 13:48:14 +08:00
Yining Li d2e4c6b683
[Doc] Update docs of metrics and evaluator (#183)
* update docs of metrics and evaluator

* rename file

* resolve comments
2022-04-22 13:02:04 +08:00
Zaida Zhou 53101a1ab1
[Docs] Refine hook documentation (#181)
* Modify hook documentation

* reslove comments
2022-04-20 13:28:26 +08:00
RangiLyu ecf816e1e9
[Doc] Refine runner doc. (#178)
* [Doc] Refine runner doc.

* resolve comments
2022-04-20 13:26:47 +08:00
Mashiro 55713207b0
[Refactor] Refactor logging tutorial docs (#179)
* Refactor logging tutorial docs

* Add logging flow description

* fix docstring as comment

fix docstring as comment

* fix logging tutorial
2022-04-20 13:22:40 +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
liukuikun 5f8f36e6a5
refactor visualization (#147)
* [WIP] add inline

* refactor vis module

* [Refactor] according review

* [Fix] fix comment

* fix some error

* Get sub visualizer be Visualizer.get_instance

* fix conflict

* fix lint

* fix unit test

* fix mypy

* fix comment

* fix lint

* update docstr

* update

* update instancedata

* remove replace __mro__ with issubclass

Co-authored-by: PJLAB\huanghaian <1286304229@qq.com>
Co-authored-by: HAOCHENYE <21724054@zju.edu.cn>
2022-04-15 15:56:06 +08:00
RangiLyu 2d80367893
[Refactor] Refactor Evaluator to Metric. (#152)
* [Refactor] Refactor Evaluator to Metric.

* update

* fix lint

* fix doc

* fix lint

* resolve comments

* resolve comments

* remove collect_device from evaluator

* rename
2022-04-01 15:06:38 +08:00
RangiLyu 25014af3c3
[Refactor] Refactor default_scope in Registry. (#158) 2022-04-01 09:13:55 +08:00
liukuikun 7e246b6f65
[Enhancement] refactor base data element (#143)
* [Enhancement] refactor base data elment

* fix comment

* fix comment

* fix pop not existing key without error
2022-03-31 18:21:45 +08:00
Mashiro 1048584147
[Enhancement] Refine GlobalAccessble (#144)
* rename global accessible and intergration get_sintance and create_instance

* move ManagerMixin to utils

* fix as docstring and seporate get_instance to get_instance and get_current_instance

* fix lint

* fix docstring, rename and move test_global_meta

* fix manager's runtime error description

fix manager's runtime error description

* Add comments

* Add comments
2022-03-26 21:21:25 +08:00
Zaida Zhou e4859030af
[Docs] Update registry documentation (#133) 2022-03-25 11:29:34 +08:00
Zaida Zhou aee6d7a769
[Docs] Improve type hint style (#125) 2022-03-25 11:26:05 +08:00
Zaida Zhou 248ad9aee8
[Feature] Add Runner and Loop (#86)
* [Feature] Add Runner and Loop

* refine docstring

* refine docstring

* refine __init__ of Runner

* add Runner.save_checkpoint

* add comment for data_batch

* rename validation_cfg to val_cfg

* update branch

* update branch

* discard wear reference

* set seed for torch in dataloader worker

* refine comments

* reorder methods

* import module in __init__.py

* add runner.load_checkpoint

* rename attributes

* fix indent

* fix indent

* add comment for LOOPS

* add example for methods

* add example for methods

* refine examples

* add Runner.resume and refactor register_hooks

* remove type hint of runner in CheckpointHook

* rename before_run to before_train

* remove collate

* add before_run after_run for loop.run

* dummy collate_fn

* add more unit tests

* move call_hook('before_run') to runner

* minor fix

* add comments for collate_fn

* fix type hint

* refactor logic to load or resume checkpoint

* fix typo

* add comments for IterBasedTrainLoop

* refactor unit tests

* fix unit tests

* refactor

* fix setup_env

* refine

* minor fix

* Merge branch 'main' of github.com:open-mmlab/mmengine into zzd/add-runner

* minor fix

* minor fix

* refine

* refactor unit tests

* fix unit tests

* add launcher property

* add logger, message_hub and writer unit tests

* add cur_dataloader attribute for runner

* fix IterBasedTrainLoop

* add torch.no_grad decorator

* add master_only decorator for save_checkpoint

* add before_test_epoch in TestLoop

* refactor load_or_resume method

* refine docstring

* fix typo

* build_dataloader can handle dataset object

* add dump_config for runner

* collate_fn should not a lambda function

* minor fix

* refine docstring

* fix unit tests

* improve comments

* refine unit tests

* rename collate_fn to pseduo_collate

* add 'TODO' tag
2022-03-14 13:19:29 +08:00
Yining Li 61fecabea6
[Feature] Update evaluator prefix (#114)
* update evaluator prefix

* update docstring and comments

* update doc
2022-03-10 17:25:20 +08:00
Haian Huang(深度眸) 98097bb73e
[Update] Refine visualization docs (#107)
* refine visualization

* refine visualization

* epdate

* update

* update

* update

* fix comment
2022-03-09 20:43:29 +08:00
RangiLyu be6f18988e
Update type hint and unit tests of evaluator. (#110)
* update type hint and ut for evaluator

* update doc

* fix
2022-03-08 16:04:46 +08:00
Yining Li cfccabc657
[Feature] Support metric prefix in BaseEvaluator (#82)
* support metric prefix in BaseEvaluator

* update docs

* use class attribute default_prefix
2022-03-08 15:12:11 +08:00
liukuikun 7acaca1445
Visualizer (#67)
* [WIP] Visualizer

* add draw featmap

* update docstring

* update docstring

* update docstring

* fix comment

* fix comment

* fix comment

* fix comment

* fix comment
2022-03-07 22:06:32 +08:00
Zaida Zhou e146233546
fix documentation (#91) 2022-03-06 14:36:46 +08:00
Zaida Zhou c6a8d72c5e
[Feature] Add distributed module (#59)
* [Feature] Add distributed module

* fix IS_DIST error

* all_reduce_dict does operations in-place

* support 'mean' operation

* provide local group process

* add tmpdir argument for collect_results

* add unit tests

* refactor unit tests

* simplify steps to create multiple processes

* minor fix

* describe the different of *gather* in mmengine and pytorch

* minor fix

* add unit tests for nccl

* test nccl backend in multiple gpu

* add get_default_group function to handle different torch versions

* minor fix

* [Feature] Add distributed module

* fix IS_DIST error

* all_reduce_dict does operations in-place

* support 'mean' operation

* provide local group process

* add tmpdir argument for collect_results

* add unit tests

* refactor unit tests

* simplify steps to create multiple processes

* minor fix

* describe the different of *gather* in mmengine and pytorch

* minor fix

* add unit tests for nccl

* test nccl backend in multiple gpu

* add get_default_group function to handle different torch versions

* minor fix

* minor fix

* handle torch1.5

* handle torch1.5

* minor fix

* fix typo

* refactor unit tests

* nccl does not support gather and gather_object

* fix gather

* fix collect_results_cpu

* fix collect_results and refactor unit tests

* fix collect_results unit tests

* handle torch.cat in torch1.5

* refine docstring

* refine docstring

* fix comments

* fix comments
2022-03-05 22:03:32 +08:00
Wenwei Zhang 817eb89ac2
Add user docs for get_config/get_models (#83)
* add user docs for get_config/get_models

* resolve comments
2022-03-05 17:46:27 +08:00
Miao Zheng 43dcc5648f
[Fix] Typo in Logging doc (#81) 2022-03-04 19:44:31 +08:00
RangiLyu ee95ce2488
[Doc] Add runner tutorial. (#55)
* [Doc] Add runner tutorial.

* update

* add advanced doc

* refine and add flow chart

* update

* update
2022-03-01 15:58:34 +08:00
Yuan Liu 2d3e91248c
[Feature]: Add sampler seed hook (#64)
* [Feature]: Add sampler seed hook

* [Fix]: Add call with to UT
2022-03-01 15:38:01 +08:00
Yining Li 42448425b3
[Feature] Add evaluator unittest (#46)
* add evaluator unittest

* update composed evaluator cfg

* add building function

* resolve comments

* resolve comments

* resolve comments

* fix evaluator doc
2022-03-01 12:00:19 +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
Mashiro 84b8106aae
[Docs] Add logging doc (#39)
* first commit

* add logging doc

* add logging doc

* Fix lint

* Fix typo

* add logging

* update docs

* update logging.md

* update logging.md

* scale img

* update logging docs

* Fix as comment

* Fix as comment

* Fix as comment

* Fix as comment

Fix as comment

* add introduction to current=True

* Fix as comment

Fix as comment

* Fix as comment

* Fix as comment
2022-03-01 11:54:43 +08:00
Haian Huang(深度眸) 492b2f2fa8
[Feature] Add MMDataParallel and MMDistributedDataParallel (#44)
* add mmddp

* update

* update code

* update unittest

* fix comment
2022-02-26 10:21:20 +08:00
Wenwei Zhang 95172781f2
Add user doc of distributed primitives (#45)
* add user doc of distributed primitives

* resolve comments

* update
2022-02-25 15:38:43 +08:00
Yining Li 92de63eed7
[Docs] Add evaluator docs (#33)
* add evaluator docs

* resolve comments

* resolve comments
2022-02-25 14:43:16 +08:00
RangiLyu d0bcb83e41
[Feature]: Add evaluator base class. (#41)
* [Feature]: Add evaluator base class.

* solve comments

* update

* fix
2022-02-24 23:41:42 +08:00
liukuikun 9437ebea67
[Feat]: Add abstract data structure (#29)
* [WIP] abstract-data-structure

* update docs

* update

* update BaseDataSample

* fix comment and coverage 100%

* update and add _set_field

* update

* split  into base_data_element and base_data_sample

* update

* update

* update

* fix typo
2022-02-22 21:45:32 +08:00
Mashiro e1f11fa595
[FIx] Fix basedataset doc (#40)
* Fix BaseDataset docs

* Fix basedataset doc
2022-02-22 21:44:16 +08:00
Mashiro ada6660c65
[Feature] add base dataset (#32)
* basedataset first commit

* add base dataset

* add dataset

* add basedataset

* Fix test dataset

* Fix mypy and test

* Fix mypy and test

* remove unused code

* Update mmengine/dataset/base_dataset.py

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

* Update mmengine/dataset/base_dataset.py

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

* add more corner cases in unittest

* fix lint

* Fix as comment

* Fix lint

* update unitest

* Type hint Dick to dict

* rename max_refetch

* Fix as comment

* Fix typo

* Fix as comment

* BaseDataset is no more an abstrac Class, change UT and docs

* Fix as comment

* Fix as comment and refactor type error

* Add comment for full init

* Fix as comment and modify dataset_wrapper

* Fix as comment and modify dataset_wrapper

* Fix as comment

* Fix as comment

* Fix as comment

* Fix as comment

* Fix as comment

* Fix as comment

* Fix as comment

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
Co-authored-by: Tao Gong <gongtao950513@gmail.com>
2022-02-22 14:01:06 +08:00
Ma Zerun f0451a38f0
[Feature] Add data sampler (#30)
* Add DefaultSampler and InfiniteSampler

* Add unit test

* Add samplers to API reference

* Update docstring

* Improve according to comments

* Rename `num_replicas` to `world_size`

* Update docstring.

* Update mmengine/data/sampler.py

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

* Update mmengine/data/sampler.py

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

* Fix typo in unit test

Co-authored-by: Wenwei Zhang <40779233+ZwwWayne@users.noreply.github.com>
Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
2022-02-21 13:08:55 +08:00
RangiLyu 7353778b7c
[Feature]: Add optimzier and constructor. (#25)
* [Feature]: Add optimzier and constructor.

* refactor unit tests

* add optimizer doc

* add parrots wrapper

* add parrots wrapper

* solve comments

* resolve comments
2022-02-19 14:09:37 +08:00
Haian Huang(深度眸) e908959c31
[Docs] add visualizer docs (#16)
* add visualizer

* update

* update

* update

* update

* update

* fix lint

* fix commit

* fix commit

* fix commit

* fix commit

* refine

* refine

* update

* update

* update

* update

* update
2022-02-17 22:33:52 +08:00
Wenwei Zhang 41e1191cbc
add unit tests of data abstract interface (#21)
* add unit tests of data abstract interface

* update

* update

* update docs of data element

* a draft of UT of datasample, to be finished

* update datasample test

* updata

* update

* fix comments

* fix comments

* fix comments

Co-authored-by: liukuikun <liukuikun@sensetime.com>
2022-02-16 23:19:18 +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
Tao Gong 9b6dd78e2f
[Docs] Add docs for BaseDataset (#7)
* add docs for BaseDataset

* update docs

* update docs

* update basedataset.md

* resolve all comments

* update

* update

* refine base dataset doc

* resolve all comments

* update

* update

* update

* update

* update

* update

* update

Co-authored-by: MeowZheng <meowzheng@outlook.com>
2022-02-14 23:27:43 +08:00
Wenwei Zhang 019c2f5cc9
Add user documentation for abstract data interfaces (#9)
* update isort

* update

* update comments

* update

* update

* update

* fix bug in use cases

* resolve all comments

* add description of basedatasample

* rename meta_info to metainfo as meta is an adj.

* update

* resolve comments

* clean set data

* finished doc

* rephrase

* update

* resolve comments

* more clear organization

* rephrase

* rephrase

* replace 基础数据元素 by 数据元素

* rephrase
2022-02-14 16:24:18 +08:00
RangiLyu 53fe85cc81
[Doc] Add scheduler user doc. (#2)
* [Doc] Add scheduler user doc.

* reslove comments

* add chinese doc

* add update en doc

* resolve comments

* resolve comments

* update parameter scheduler

* resolve comments

* tmp remove en doc

* resolve comments

* resolve comments

* resolve comments

Co-authored-by: Kai Chen <chenkaidev@gmail.com>
2022-02-14 16:17:35 +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
Mashiro 3f3dd5b0bd
[Docs] add config docs (#6)
* add config user doc

* add config user doc

* Fix typo

* fix typo

* reference mmcv

* fix typo

* fix typo

* Restructuring config.md

* Update introduction

Co-authored-by: Kai Chen <chenkaidev@gmail.com>

* Fix

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

* Update docs/zh_cn/tutorials/config.md

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

* Fix title level

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

* refactor the doc

* remove **bold** on titles

* Fix python comment

* Fix python comment

* Update docs/zh_cn/tutorials/config.md

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

Co-authored-by: Kai Chen <chenkaidev@gmail.com>
Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
2022-02-12 21:35:05 +08:00