Skip to content

[Docathon][Fix Doc Format No.22] fix doc ParallelEnv_cn #7538

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 8 commits into from
Oct 13, 2025
Merged

[Docathon][Fix Doc Format No.22] fix doc ParallelEnv_cn #7538

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
7cebc21
[Docathon][Fix Doc Format No.22] fix doc ParallelEnv_cn
xxiu1 Oct 2, 2025
6f61cb8
[Docathon][Fix Doc Format No.23、24] fix doc parallelize_cn.rst、Strate…
xxiu1 Oct 4, 2025
a505af4
Merge branch 'develop' of https://github.com/PaddlePaddle/docs into f…
xxiu1 Oct 10, 2025
c8e4c7f
Merge branch 'develop' into feature/my-cool-stuff
xxiu1 Oct 10, 2025
72f972d
Merge branch 'develop' into feature/my-cool-stuff
xxiu1 Oct 10, 2025
ceca10e
Merge branch 'develop' into feature/my-cool-stuff
Echo-Nie Oct 10, 2025
b4f96b8
Revert: restore parallelize_cn.rst to upstream/develop version
xxiu1 Oct 11, 2025
534c637
Merge branch 'develop' into feature/my-cool-stuff
Echo-Nie Oct 13, 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
12 changes: 6 additions & 6 deletions docs/api/paddle/distributed/ParallelEnv_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ ParallelEnv
.. py:class:: paddle.distributed.ParallelEnv()

.. note::
不推荐使用这个 API，如果需要获取 rank 和 world_size，建议使用 ``paddle.distributed.get_rank()`` 和 ``paddle.distributed.get_world_size()`` 。
不推荐使用这个 API，如果需要获取 rank 和 world_size，建议使用 ``paddle.distributed.get_rank()`` 和 ``paddle.distributed.get_world_size()`` 。

这个类用于获取动态图模型并行执行所需的环境变量值。

Expand All @@ -24,7 +24,7 @@ rank

当前训练进程的编号。

此属性的值等于环境变量 `PADDLE_TRAINER_ID` 的值。默认值是 0。
此属性的值等于环境变量 ``PADDLE_TRAINER_ID`` 的值。默认值是 0。

**代码示例**

Expand All @@ -35,7 +35,7 @@ world_size

参与训练进程的数量，一般也是训练所使用 GPU 卡的数量。

此属性的值等于环境变量 `PADDLE_TRAINERS_NUM` 的值。默认值为 1。
此属性的值等于环境变量 ``PADDLE_TRAINERS_NUM`` 的值。默认值为 1。

**代码示例**

Expand All @@ -46,7 +46,7 @@ device_id

当前用于并行训练的 GPU 的编号。

此属性的值等于环境变量 `FLAGS_selected_gpus` 的值。默认值是 0。
此属性的值等于环境变量 ``FLAGS_selected_gpus`` 的值。默认值是 0。

**代码示例**

Expand All @@ -57,7 +57,7 @@ current_endpoint

当前训练进程的终端节点 IP 与相应端口，形式为（机器节点 IP:端口号）。例如：127.0.0.1:6170。

此属性的值等于环境变量 `PADDLE_CURRENT_ENDPOINT` 的值。默认值为空字符串""。
此属性的值等于环境变量 ``PADDLE_CURRENT_ENDPOINT`` 的值。默认值为空字符串""。

**代码示例**

Expand All @@ -68,7 +68,7 @@ trainer_endpoints

当前任务所有参与训练进程的终端节点 IP 与相应端口，用于在 NCCL2 初始化的时候建立通信，广播 NCCL ID。

此属性的值等于环境变量 `PADDLE_TRAINER_ENDPOINTS` 的值。默认值为空字符串""。
此属性的值等于环境变量 ``PADDLE_TRAINER_ENDPOINTS`` 的值。默认值为空字符串""。

**代码示例**

Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/distributed/parallelize_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ parallelize
- **mesh** (paddle.distributed.ProcessMesh，可选) - 模型与优化器（如提供）并行所发生的进程空间。最佳用法：在调用本 API 之前，通过
调用 ``paddle.distributed.set_mesh`` 方法来配置 mesh 信息，并将本 API 的 mesh 参数设置为 None。注意，如果您通过本 API 传递
了 mesh 信息，传入的 mesh 会覆盖外部设置的 mesh。
- **config** (dict，可选) - 用来指导并行化的配置。该配置是一个字典，键的值可以从 ``dp_config`` ， ``mp_config`` 与
- **config** (dict，可选) - 用来指导并行化的配置。该配置是一个字典，键的值可以从 ``dp_config``，``mp_config`` 与
Copy link
Collaborator

@Echo-Nie Echo-Nie Oct 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

预览： ParallelEnv_cn

image 由于No.23已经被合入啦，所以不用对这个文件进行修改啦~ 可能需要取消该文件的修改然后重新push一下

Copy link
Contributor Author

@xxiu1 xxiu1 Oct 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

收到，已修改，辛苦老师再看看~

``pp_config`` 中进行选择，分别来指导数据并行、模型并行与流水线并行的并行化。一个合法的 config 可以是： ``{"dp_config":
请参考本文档 dp_config 部分以获取更多内容, "mp_config": 请参考本文档 mp_config 部分以获取更多内容,
"pp_config": 请参考本文档 pp_config 部分以获取更多内容}`` 。
Expand Down