This commit is contained in:
Zaida Zhou 2023-02-27 17:13:38 +08:00 committed by GitHub
parent 6a56ca78e3
commit cb7e04d3cf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 15 additions and 16 deletions

View File

@ -7,12 +7,13 @@
- Support `Apex` with `ApexOptimWrapper` - Support `Apex` with `ApexOptimWrapper`
- Support analyzing model complexity. - Support analyzing model complexity.
- Add `Lion` optimizer. - Add `Lion` optimizer.
- Support using environment variable in the config file. - Support using environment variables in the config file.
### New Features & Enhancements ### New Features & Enhancements
- Support model complexity computation by [@tonysy](https://github.com/tonysy) in https://github.com/open-mmlab/mmengine/pull/779 - Support model complexity computation by [@tonysy](https://github.com/tonysy) in https://github.com/open-mmlab/mmengine/pull/779
- Add Lion optimizer by [@zhouzaida](https://github.com/zhouzaida) in https://github.com/open-mmlab/mmengine/pull/952 - Add Lion optimizer by [@zhouzaida](https://github.com/zhouzaida) in https://github.com/open-mmlab/mmengine/pull/952
- Support `Apex` with `ApexOptimWrapper` by [@xcnick](https://github.com/xcnick) in https://github.com/open-mmlab/mmengine/pull/742
- Support using environment variable in config file. by [@jbwang1997](https://github.com/jbwang1997) in https://github.com/open-mmlab/mmengine/pull/744 - Support using environment variable in config file. by [@jbwang1997](https://github.com/jbwang1997) in https://github.com/open-mmlab/mmengine/pull/744
- Improve registry infer_scope by [@zhouzaida](https://github.com/zhouzaida) in https://github.com/open-mmlab/mmengine/pull/334 - Improve registry infer_scope by [@zhouzaida](https://github.com/zhouzaida) in https://github.com/open-mmlab/mmengine/pull/334
- Support configuring `timeout` in dist configuration by [@apacha](https://github.com/apacha) in https://github.com/open-mmlab/mmengine/pull/877 - Support configuring `timeout` in dist configuration by [@apacha](https://github.com/apacha) in https://github.com/open-mmlab/mmengine/pull/877
@ -30,9 +31,7 @@
- Backend_args should not be modified by get_file_backend by [@zhouzaida](https://github.com/zhouzaida) in https://github.com/open-mmlab/mmengine/pull/897 - Backend_args should not be modified by get_file_backend by [@zhouzaida](https://github.com/zhouzaida) in https://github.com/open-mmlab/mmengine/pull/897
- Support update `np.ScalarType` data in message_hub by [@HAOCHENYE](https://github.com/HAOCHENYE) in https://github.com/open-mmlab/mmengine/pull/898 - Support update `np.ScalarType` data in message_hub by [@HAOCHENYE](https://github.com/HAOCHENYE) in https://github.com/open-mmlab/mmengine/pull/898
- Support rendering Chinese character in `Visualizer` by [@KevinNuNu](https://github.com/KevinNuNu) in https://github.com/open-mmlab/mmengine/pull/887 - Support rendering Chinese character in `Visualizer` by [@KevinNuNu](https://github.com/KevinNuNu) in https://github.com/open-mmlab/mmengine/pull/887
- Support `Apex` with `ApexOptimWrapper` by [@xcnick](https://github.com/xcnick) in https://github.com/open-mmlab/mmengine/pull/742
- Fix the bug of `DefaultOptimWrapperConstructor` when the shared parameters do not require the grad by [@HIT-cwh](https://github.com/HIT-cwh) in https://github.com/open-mmlab/mmengine/pull/903 - Fix the bug of `DefaultOptimWrapperConstructor` when the shared parameters do not require the grad by [@HIT-cwh](https://github.com/HIT-cwh) in https://github.com/open-mmlab/mmengine/pull/903
- Support model complexity computation by [@tonysy](https://github.com/tonysy) in https://github.com/open-mmlab/mmengine/pull/779
### Docs ### Docs

View File

@ -381,7 +381,7 @@ class LocalBackend(BaseStorageBackend):
src (str or Path): A directory to be copied. src (str or Path): A directory to be copied.
dst (str or Path): Copy directory to local dst. dst (str or Path): Copy directory to local dst.
backend_args (dict, optional): Arguments to instantiate the backend_args (dict, optional): Arguments to instantiate the
preifx of uri corresponding backend. Defaults to None. prefix of uri corresponding backend. Defaults to None.
Returns: Returns:
str: The destination directory. str: The destination directory.

View File

@ -375,7 +375,7 @@ class PetrelBackend(BaseStorageBackend):
src (str or Path): A directory to be copied. src (str or Path): A directory to be copied.
dst (str or Path): Copy directory to dst. dst (str or Path): Copy directory to dst.
backend_args (dict, optional): Arguments to instantiate the backend_args (dict, optional): Arguments to instantiate the
preifx of uri corresponding backend. Defaults to None. prefix of uri corresponding backend. Defaults to None.
Returns: Returns:
str: The destination directory. str: The destination directory.
@ -415,7 +415,7 @@ class PetrelBackend(BaseStorageBackend):
src (str or Path): A local file to be copied. src (str or Path): A local file to be copied.
dst (str or Path): Copy file to dst. dst (str or Path): Copy file to dst.
backend_args (dict, optional): Arguments to instantiate the backend_args (dict, optional): Arguments to instantiate the
preifx of uri corresponding backend. Defaults to None. prefix of uri corresponding backend. Defaults to None.
Returns: Returns:
str: If dst specifies a directory, the file will be copied into dst str: If dst specifies a directory, the file will be copied into dst
@ -540,7 +540,7 @@ class PetrelBackend(BaseStorageBackend):
src (str or Path): A directory to be copied. src (str or Path): A directory to be copied.
dst (str or Path): Copy directory to local dst. dst (str or Path): Copy directory to local dst.
backend_args (dict, optional): Arguments to instantiate the backend_args (dict, optional): Arguments to instantiate the
preifx of uri corresponding backend. Defaults to None. prefix of uri corresponding backend. Defaults to None.
Returns: Returns:
str: The destination directory. str: The destination directory.
@ -624,7 +624,7 @@ class PetrelBackend(BaseStorageBackend):
src (str or Path): A file or directory to be copied. src (str or Path): A file or directory to be copied.
dst (str or Path): Copy a file or directory to dst. dst (str or Path): Copy a file or directory to dst.
backend_args (dict, optional): Arguments to instantiate the backend_args (dict, optional): Arguments to instantiate the
preifx of uri corresponding backend. Defaults to None. prefix of uri corresponding backend. Defaults to None.
Returns: Returns:
bool: Return False because PetrelBackend does not support create bool: Return False because PetrelBackend does not support create

View File

@ -813,7 +813,7 @@ def load(file,
Defaults to None. It will be deprecated in future. Please use Defaults to None. It will be deprecated in future. Please use
``backend_args`` instead. ``backend_args`` instead.
backend_args (dict, optional): Arguments to instantiate the backend_args (dict, optional): Arguments to instantiate the
preifx of uri corresponding backend. Defaults to None. prefix of uri corresponding backend. Defaults to None.
New in v0.2.0. New in v0.2.0.
Examples: Examples:
@ -886,7 +886,7 @@ def dump(obj,
Defaults to None. It will be deprecated in future. Please use Defaults to None. It will be deprecated in future. Please use
``backend_args`` instead. ``backend_args`` instead.
backend_args (dict, optional): Arguments to instantiate the backend_args (dict, optional): Arguments to instantiate the
preifx of uri corresponding backend. Defaults to None. prefix of uri corresponding backend. Defaults to None.
New in v0.2.0. New in v0.2.0.
Examples: Examples:

View File

@ -30,7 +30,7 @@ def list_from_file(filename,
Defaults to None. It will be deprecated in future. Please use Defaults to None. It will be deprecated in future. Please use
``backend_args`` instead. ``backend_args`` instead.
backend_args (dict, optional): Arguments to instantiate the backend_args (dict, optional): Arguments to instantiate the
preifx of uri corresponding backend. Defaults to None. prefix of uri corresponding backend. Defaults to None.
New in v0.2.0. New in v0.2.0.
Examples: Examples:
@ -94,7 +94,7 @@ def dict_from_file(filename,
Defaults to None. It will be deprecated in future. Please use Defaults to None. It will be deprecated in future. Please use
``backend_args`` instead. ``backend_args`` instead.
backend_args (dict, optional): Arguments to instantiate the backend_args (dict, optional): Arguments to instantiate the
preifx of uri corresponding backend. Defaults to None. prefix of uri corresponding backend. Defaults to None.
New in v0.2.0. New in v0.2.0.
Examples: Examples:

View File

@ -81,7 +81,7 @@ class CheckpointHook(Hook):
Defaults to None, which means "epoch_{}.pth" or "iter_{}.pth" Defaults to None, which means "epoch_{}.pth" or "iter_{}.pth"
accordingly. accordingly.
backend_args (dict, optional): Arguments to instantiate the backend_args (dict, optional): Arguments to instantiate the
preifx of uri corresponding backend. Defaults to None. prefix of uri corresponding backend. Defaults to None.
New in v0.2.0. New in v0.2.0.
Examples: Examples:

View File

@ -64,7 +64,7 @@ class LoggerHook(Hook):
`runner.visualizer.add_scalars`. Otherwise `step` will be `runner.visualizer.add_scalars`. Otherwise `step` will be
self.iter. Defaults to True. self.iter. Defaults to True.
backend_args (dict, optional): Arguments to instantiate the backend_args (dict, optional): Arguments to instantiate the
preifx of uri corresponding backend. Defaults to None. prefix of uri corresponding backend. Defaults to None.
New in v0.2.0. New in v0.2.0.
Examples: Examples:

View File

@ -711,7 +711,7 @@ def save_checkpoint(checkpoint,
Defaults to None. It will be deprecated in future. Please use Defaults to None. It will be deprecated in future. Please use
`backend_args` instead. `backend_args` instead.
backend_args (dict, optional): Arguments to instantiate the backend_args (dict, optional): Arguments to instantiate the
preifx of uri corresponding backend. Defaults to None. prefix of uri corresponding backend. Defaults to None.
New in v0.2.0. New in v0.2.0.
""" """
if file_client_args is not None: if file_client_args is not None:

View File

@ -2082,7 +2082,7 @@ class Runner:
by_epoch (bool): Whether the scheduled momentum is updated by by_epoch (bool): Whether the scheduled momentum is updated by
epochs. Defaults to True. epochs. Defaults to True.
backend_args (dict, optional): Arguments to instantiate the backend_args (dict, optional): Arguments to instantiate the
preifx of uri corresponding backend. Defaults to None. prefix of uri corresponding backend. Defaults to None.
New in v0.2.0. New in v0.2.0.
""" """
if meta is None: if meta is None: