mirrors/mmengine
1
0
Fork 0
mirror of https://github.com/open-mmlab/mmengine.git synced 2025-06-03 21:54:44 +08:00
Code Issues Projects Releases Wiki Activity

fix typo (#965)

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/en/notes/changelog.md
View File

@ -7,12 +7,13 @@
- Support `Apex` with `ApexOptimWrapper`
- Support analyzing model complexity.
- Add `Lion` optimizer.
- Support using environment variable in the config file.
- Support using environment variables in the config file.
### New Features & Enhancements
- 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
- 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
- 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
@ -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
- 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 `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
- Support model complexity computation by [@tonysy](https://github.com/tonysy) in https://github.com/open-mmlab/mmengine/pull/779
### Docs

2
mmengine/fileio/backends/local_backend.py
View File

@ -381,7 +381,7 @@ class LocalBackend(BaseStorageBackend):
src (str or Path): A directory to be copied.
dst (str or Path): Copy directory to local dst.
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:
str: The destination directory.

8
mmengine/fileio/backends/petrel_backend.py
View File

@ -375,7 +375,7 @@ class PetrelBackend(BaseStorageBackend):
src (str or Path): A directory to be copied.
dst (str or Path): Copy directory to dst.
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:
str: The destination directory.
@ -415,7 +415,7 @@ class PetrelBackend(BaseStorageBackend):
src (str or Path): A local file to be copied.
dst (str or Path): Copy file to dst.
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:
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.
dst (str or Path): Copy directory to local dst.
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:
str: The destination directory.
@ -624,7 +624,7 @@ class PetrelBackend(BaseStorageBackend):
src (str or Path): A file or directory to be copied.
dst (str or Path): Copy a file or directory to dst.
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:
bool: Return False because PetrelBackend does not support create

4
mmengine/fileio/io.py
View File

@ -813,7 +813,7 @@ def load(file,
Defaults to None. It will be deprecated in future. Please use
``backend_args`` instead.
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.
Examples:
@ -886,7 +886,7 @@ def dump(obj,
Defaults to None. It will be deprecated in future. Please use
``backend_args`` instead.
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.
Examples:

4
mmengine/fileio/parse.py
View File

@ -30,7 +30,7 @@ def list_from_file(filename,
Defaults to None. It will be deprecated in future. Please use
``backend_args`` instead.
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.
Examples:
@ -94,7 +94,7 @@ def dict_from_file(filename,
Defaults to None. It will be deprecated in future. Please use
``backend_args`` instead.
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.
Examples:

2
mmengine/hooks/checkpoint_hook.py
View File

@ -81,7 +81,7 @@ class CheckpointHook(Hook):
Defaults to None, which means "epoch_{}.pth" or "iter_{}.pth"
accordingly.
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.
Examples:

2
mmengine/hooks/logger_hook.py
View File

@ -64,7 +64,7 @@ class LoggerHook(Hook):
`runner.visualizer.add_scalars`. Otherwise `step` will be
self.iter. Defaults to True.
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.
Examples:

2
mmengine/runner/checkpoint.py
View File

@ -711,7 +711,7 @@ def save_checkpoint(checkpoint,
Defaults to None. It will be deprecated in future. Please use
`backend_args` instead.
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.
"""
if file_client_args is not None:

2
mmengine/runner/runner.py
View File

@ -2082,7 +2082,7 @@ class Runner:
by_epoch (bool): Whether the scheduled momentum is updated by
epochs. Defaults to True.
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.
"""
if meta is None: