Skip to content

[Docathon][Fix Doc Format No.44] Fix spacing format for UtilBase_cn #7526

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 10, 2025
Merged

[Docathon][Fix Doc Format No.44] Fix spacing format for UtilBase_cn #7526

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
269d403
[Docathon][Fix Doc Format No.44] Fix spacing format for UtilBase_cn
ChandlerIdeaCreator Oct 9, 2025
99ab07c
style: Final fix for codestyle and line endings in Codespace
ChandlerIdeaCreator Oct 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 9 additions & 10 deletions docs/api/paddle/distributed/fleet/UtilBase_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,43 +9,43 @@ UtilBase
方法
::::::::::::
all_reduce(input, mode="sum", comm_world="worker")
'''''''''
''''''''''''''''''''''''''''''''''''''''''''''''''
在指定的通信集合间进行归约操作，并将归约结果返回给集合中每个实例。

**参数**

- **input** (list|tuple|numpy.array) – 归约操作的输入。
- **mode** (str) - 归约操作的模式，包含求和，取最大值和取最小值，默认为求和归约。
- **comm_world** (str) - 归约操作的通信集合，包含：server 集合(``server``)，worker 集合(``worker``)及所有节点集合(``all``)，默认为 worker 集合。
- **comm_world** (str) - 归约操作的通信集合，包含：server 集合 (``server``)，worker 集合 (``worker``) 及所有节点集合 (``all``)，默认为 worker 集合。

**返回**

Numpy.array|None：一个和``input``形状一致的 numpy 数组或 None。
Numpy.array|None：一个和 ``input`` 形状一致的 numpy 数组或 None。

**代码示例**

COPY-FROM: paddle.distributed.fleet.UtilBase.all_reduce

barrier(comm_world="worker")
'''''''''
''''''''''''''''''''''''''''
在指定的通信集合间进行阻塞操作，以实现集合间进度同步。

**参数**

- **comm_world** (str) - 阻塞操作的通信集合，包含：server 集合(``server``)，worker 集合(``worker``)及所有节点集合(``all``)，默认为 worker 集合。
- **comm_world** (str) - 阻塞操作的通信集合，包含：server 集合 (``server``)，worker 集合 (``worker``) 及所有节点集合 (``all``)，默认为 worker 集合。

**代码示例**

COPY-FROM: paddle.distributed.fleet.UtilBase.barrier

all_gather(input, comm_world="worker")
'''''''''
''''''''''''''''''''''''''''''''''''''''
在指定的通信集合间进行聚合操作，并将聚合的结果返回给集合中每个实例。

**参数**

- **input** (int|float) - 聚合操作的输入。
- **comm_world** (str) - 聚合操作的通信集合，包含：server 集合(``server``)，worker 集合(``worker``)及所有节点集合(``all``)，默认为 worker 集合。
- **comm_world** (str) - 聚合操作的通信集合，包含：server 集合 (``server``)，worker 集合 (``worker``) 及所有节点集合 (``all``)，默认为 worker 集合。

**返回**

Expand All @@ -56,7 +56,7 @@ all_gather(input, comm_world="worker")
COPY-FROM: paddle.distributed.fleet.UtilBase.all_gather

get_file_shard(files)
'''''''''
'''''''''''''''''''''
在数据并行的分布式训练中，获取属于当前训练节点的文件列表。

.. code-block:: text
Expand All @@ -77,8 +77,7 @@ get_file_shard(files)
COPY-FROM: paddle.distributed.fleet.UtilBase.get_file_shard

print_on_rank(message, rank_id)
'''''''''

'''''''''''''''''''''''''''''''''
在编号为 `rank_id` 的节点上打印指定信息。

**参数**
Expand Down