fix documentation (#91)
Zaida Zhou
GitHub
parent
c6a8d72c5e
commit
e146233546
|
|
@ -3,12 +3,36 @@ Registry
|
|||
.. automodule:: mmengine.registry
|
||||
:members:
|
||||
|
||||
Config
|
||||
--------
|
||||
.. automodule:: mmengine.config
|
||||
:members:
|
||||
|
||||
Hook
|
||||
--------
|
||||
.. automodule:: mmengine.hooks
|
||||
:members:
|
||||
|
||||
Optimizer
|
||||
----------
|
||||
.. automodule:: mmengine.optim
|
||||
:members:
|
||||
|
||||
Data
|
||||
--------
|
||||
.. automodule:: mmengine.data
|
||||
:members:
|
||||
|
||||
Dataset
|
||||
--------
|
||||
.. automodule:: mmengine.dataset
|
||||
:members:
|
||||
|
||||
Distributed
|
||||
-----------
|
||||
.. automodule:: mmengine.dist
|
||||
:members:
|
||||
|
||||
Logging
|
||||
--------
|
||||
.. automodule:: mmengine.logging
|
||||
|
|
|
|||
|
|
@ -3,6 +3,21 @@ Registry
|
|||
.. automodule:: mmengine.registry
|
||||
:members:
|
||||
|
||||
Config
|
||||
--------
|
||||
.. automodule:: mmengine.config
|
||||
:members:
|
||||
|
||||
Hook
|
||||
--------
|
||||
.. automodule:: mmengine.hooks
|
||||
:members:
|
||||
|
||||
Optimizer
|
||||
----------
|
||||
.. automodule:: mmengine.optim
|
||||
:members:
|
||||
|
||||
Data
|
||||
--------
|
||||
.. automodule:: mmengine.data
|
||||
|
|
@ -12,3 +27,7 @@ Distributed
|
|||
-----------
|
||||
.. automodule:: mmengine.dist
|
||||
:members:
|
||||
|
||||
Logging
|
||||
--------
|
||||
.. automodule:: mmengine.logging
|
||||
|
|
|
|||
|
|
@ -3,12 +3,21 @@
|
|||
您可以在页面左下角切换中英文文档。
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:maxdepth: 1
|
||||
:caption: 教程
|
||||
|
||||
tutorials/registry.md
|
||||
tutorials/config.md
|
||||
tutorials/runner.md
|
||||
tutorials/hook.md
|
||||
tutorials/optimizer.md
|
||||
tutorials/param_scheduler.md
|
||||
tutorials/abstract_data_interface.md
|
||||
tutorials/basedataset.md
|
||||
tutorials/evaluator.md
|
||||
tutorials/distributed.md
|
||||
tutorials/logging.md
|
||||
tutorials/visualizer.md
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
|
|
|||
|
|
@ -15,33 +15,33 @@ PyTorch 提供了一套基础的通信原语用于多进程之间张量的通信
|
|||
|
||||
## 分布式初始化
|
||||
|
||||
- init_dist： 是分布式训练的启动函数，目前支持 pytorch，slurm，MPI 3 种分布式启动方式，同时允许设置通信的后端，默认使用 NCCL。
|
||||
- [init_dist](https://mmengine.readthedocs.io/zh/latest//api.html#mmengine.dist.init_dist)： 是分布式训练的启动函数，目前支持 pytorch，slurm，MPI 3 种分布式启动方式，同时允许设置通信的后端，默认使用 NCCL。
|
||||
|
||||
## 分布式信息获取与控制
|
||||
|
||||
分布式信息的获取与控制函数没有参数，这些函数兼容非分布式训练的情况，功能如下
|
||||
|
||||
- [get_world_size](todo: add API link)：获取当前进程组的进程总数，非分布式情况下返回 1
|
||||
- [get_rank](todo: add API link)：获取当前进程对应的全局 rank 数，非分布式情况下返回 0
|
||||
- [get_backend](todo: add API link)：获取当前通信使用的后端，非分布式情况下返回 None
|
||||
- [get_local_rank](todo: add API link)：获取当前进程对应到当前机器的 rank 数，非分布式情况下返回 0
|
||||
- [get_local_size](todo: add API link)：获取当前进程所在机器的总进程数，非分布式情况下返回 0
|
||||
- [get_dist_info](todo: add API link)：获取当前任务的进程总数和当前进程对应到全局的 rank 数，非分布式情况下 word_size = 1，rank = 0
|
||||
- [is_main_process](todo: add API link)：判断是否为 0 号主进程，非分布式情况下返回 True
|
||||
- [master_only](todo: add API link)：函数装饰器，用于修饰只需要全局 0 号进程（rank 0 而不是 local rank 0）执行的函数
|
||||
- [barrier](todo: add API link)：同步所有进程到达相同位置
|
||||
- [get_world_size](https://mmengine.readthedocs.io/zh/latest//api.html#mmengine.dist.get_world_size)：获取当前进程组的进程总数，非分布式情况下返回 1
|
||||
- [get_rank](https://mmengine.readthedocs.io/zh/latest//api.html#mmengine.dist.get_rank)：获取当前进程对应的全局 rank 数，非分布式情况下返回 0
|
||||
- [get_backend](https://mmengine.readthedocs.io/zh/latest//api.html#mmengine.dist.get_backend)：获取当前通信使用的后端，非分布式情况下返回 None
|
||||
- [get_local_rank](https://mmengine.readthedocs.io/zh/latest//api.html#mmengine.dist.get_local_rank)：获取当前进程对应到当前机器的 rank 数，非分布式情况下返回 0
|
||||
- [get_local_size](https://mmengine.readthedocs.io/zh/latest//api.html#mmengine.dist.get_local_size)：获取当前进程所在机器的总进程数，非分布式情况下返回 0
|
||||
- [get_dist_info](https://mmengine.readthedocs.io/zh/latest//api.html#mmengine.dist.get_dist_info)：获取当前任务的进程总数和当前进程对应到全局的 rank 数，非分布式情况下 word_size = 1，rank = 0
|
||||
- [is_main_process](https://mmengine.readthedocs.io/zh/latest//api.html#mmengine.dist.is_main_process)：判断是否为 0 号主进程，非分布式情况下返回 True
|
||||
- [master_only](https://mmengine.readthedocs.io/zh/latest//api.html#mmengine.dist.master_only)：函数装饰器，用于修饰只需要全局 0 号进程（rank 0 而不是 local rank 0）执行的函数
|
||||
- [barrier](https://mmengine.readthedocs.io/zh/latest//api.html#mmengine.dist.barrier)：同步所有进程到达相同位置
|
||||
|
||||
## 分布式通信函数
|
||||
|
||||
通信函数 （Collective functions），主要用于进程间数据的通信，基于 PyTorch 原生的 all_reduce，all_gather，gather，broadcast 接口，MMEngine 提供了如下接口，兼容非分布式训练的情况，并支持更丰富数据类型的通信。
|
||||
|
||||
- [all_reduce](todo: add API link): 对进程间 tensor 进行 AllReduce 操作
|
||||
- [all_gather](todo: add API link)：对进程间 tensor 进行 AllGather 操作
|
||||
- [gather](todo: add API link)：将进程的 tensor 收集到一个目标 rank
|
||||
- [broadcast](todo: add API link)：对某个进程的 tensor 进行广播
|
||||
- [sync_random_seed](todo: add API link)：同步进程之间的随机种子
|
||||
- [broadcast_object_list](todo: add API link)：支持 object list 的广播，可以基于 broadcast 接口实现
|
||||
- [all_reduce_dict](todo: add API link)：对 dict 中的内容进行 all_reduce 操作，基于 broadcast 和 all_reduce 接口实现
|
||||
- [all_gather_object](todo: add API link)：基于 all_gather 实现对任意可以 Python 序列化对象的 all_tather 操作
|
||||
- [gather_object](todo: add API link)：将 group 里每个 rank 的 data gather 到一个目标 rank，且支持多种方式
|
||||
- [collect_results](todo: add API link)：支持基于 CPU 或者 GPU 对不同进程间的列表数据进行收集·
|
||||
- [all_reduce](https://mmengine.readthedocs.io/zh/latest//api.html#mmengine.dist.all_reduce): 对进程间 tensor 进行 AllReduce 操作
|
||||
- [all_gather](https://mmengine.readthedocs.io/zh/latest//api.html#mmengine.dist.all_gather)：对进程间 tensor 进行 AllGather 操作
|
||||
- [gather](https://mmengine.readthedocs.io/zh/latest//api.html#mmengine.dist.gather)：将进程的 tensor 收集到一个目标 rank
|
||||
- [broadcast](https://mmengine.readthedocs.io/zh/latest//api.html#mmengine.dist.broadcast)：对某个进程的 tensor 进行广播
|
||||
- [sync_random_seed](https://mmengine.readthedocs.io/zh/latest//api.html#mmengine.dist.sync_random_seed)：同步进程之间的随机种子
|
||||
- [broadcast_object_list](https://mmengine.readthedocs.io/zh/latest//api.html#mmengine.dist.broadcast_object_list)：支持 object list 的广播，可以基于 broadcast 接口实现
|
||||
- [all_reduce_dict](https://mmengine.readthedocs.io/zh/latest//api.html#mmengine.dist.all_reduce_dict)：对 dict 中的内容进行 all_reduce 操作，基于 broadcast 和 all_reduce 接口实现
|
||||
- [all_gather_object](https://mmengine.readthedocs.io/zh/latest//api.html#mmengine.dist.all_gather_object)：基于 all_gather 实现对任意可以 Python 序列化对象的 all_tather 操作
|
||||
- [gather_object](https://mmengine.readthedocs.io/zh/latest//api.html#mmengine.dist.gather_object)：将 group 里每个 rank 的 data gather 到一个目标 rank，且支持多种方式
|
||||
- [collect_results](https://mmengine.readthedocs.io/zh/latest//api.html#mmengine.dist.collect_results)：支持基于 CPU 或者 GPU 对不同进程间的列表数据进行收集·
|
||||
|
|
|
|||
Loading…
Reference in New Issue