mmengine/docs/zh_cn/api.rst

Registry
--------
.. automodule:: mmengine.registry
    :members:

Config
--------
.. automodule:: mmengine.config
    :members:

Runner
--------
.. automodule:: mmengine.runner
    :members:

Hook
--------
.. automodule:: mmengine.hooks
    :members:

Optimizer
----------
.. automodule:: mmengine.optim
    :members:

Data
--------
.. automodule:: mmengine.data
    :members:

Distributed
-----------
.. automodule:: mmengine.dist
    :members:

Logging
--------
.. automodule:: mmengine.logging
[Feature] Add Registry (#11) 2022-02-16 21:45:39 +08:00			`Registry`
			`--------`
			`.. automodule:: mmengine.registry`
			`:members:`
[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
fix documentation (#91) 2022-03-06 14:36:46 +08:00			`Config`
			`--------`
			`.. automodule:: mmengine.config`
			`:members:`

[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			`Runner`
			`--------`
			`.. automodule:: mmengine.runner`
			`:members:`

fix documentation (#91) 2022-03-06 14:36:46 +08:00			`Hook`
			`--------`
			`.. automodule:: mmengine.hooks`
			`:members:`

			`Optimizer`
			`----------`
			`.. automodule:: mmengine.optim`
			`:members:`

[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			`Data`
			`--------`
			`.. automodule:: mmengine.data`
			`:members:`
[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
			`Distributed`
			`-----------`
			`.. automodule:: mmengine.dist`
			`:members:`
fix documentation (#91) 2022-03-06 14:36:46 +08:00
			`Logging`
			`--------`
			`.. automodule:: mmengine.logging`