UtilBase

class paddle.distributed.fleet.UtilBase [源代码]

分布式训练工具类，主要提供集合通信、文件系统操作等接口。

all_reduce ( input, mode=’sum’, comm_world=’worker’ )

在指定的通信集合间进行归约操作，并将归约结果返回给集合中每个实例。

参数：

  • input (list|numpy.array) – 归约操作的输入。

  • mode (str) - 归约操作的模式，包含求和，取最大值和取最小值，默认为求和归约。

  • comm_world (str) - 归约操作的通信集合，包含: server集合(“server”)，worker集合(“worker”)及所有节点集合(“all”)，默认为worker集合。

返回：

  • Numpy.array|None: 一个和 input 形状一致的numpy数组或None.

代码示例:

  1. # Save the following code in `train.py` , and then execute the command `fleetrun --server_num 2 --worker_num 2 train.py` .
  2. import paddle.distributed.fleet as fleet
  3. from paddle.distributed.fleet import PaddleCloudRoleMaker
  4. import sys
  5. import numpy as np
  6. import os
  8. os.environ["PADDLE_WITH_GLOO"] = "2"
  10. def train():
  11.     role = PaddleCloudRoleMaker(
  12.         is_collective=False,
  13.         init_gloo=True,
  14.         path="./tmp_gloo")
  15.     fleet.init(role)
  17.     if fleet.is_server():
  18.         input = [1, 2]
  19.         output = fleet.util.all_reduce(input, "sum", "server")
  20.         print(output)
  21.         # [2, 4]
  22.     elif fleet.is_worker():
  23.         input = np.array([3, 4])
  24.         output = fleet.util.all_reduce(input, "sum", "worker")
  25.         print(output)
  26.         # [6, 8]
  27.     output = fleet.util.all_reduce(input, "sum", "all")
  28.     print(output)
  29.     # [8, 12]
  30. if __name__ == "__main__":
  31.     train()

barrier ( comm_world=’worker’ )

在指定的通信集合间进行阻塞操作，以实现集合间进度同步。

参数：

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

代码示例:

  1. # Save the following code in `train.py` , and then execute the command `fleetrun --server_num 2 --worker_num 2 train.py` .
  3. import paddle.distributed.fleet as fleet
  4. from paddle.distributed.fleet import PaddleCloudRoleMaker
  5. import sys
  6. import os
  8. os.environ["PADDLE_WITH_GLOO"] = "2"
  10. def train():
  11.     role = PaddleCloudRoleMaker(
  12.         is_collective=False,
  13.         init_gloo=True,
  14.         path="./tmp_gloo")
  15.     fleet.init(role)
  17.     if fleet.is_server():
  18.         fleet.util.barrier("server")
  19.         print("all server arrive here")
  20.     elif fleet.is_worker():
  21.         fleet.util.barrier("worker")
  22.         print("all server arrive here")
  23.     fleet.util.barrier("all")
  24.     print("all servers and workers arrive here")
  26. if __name__ == "__main__":
  27.     train()

all_gather ( input, comm_world=’worker’ )

在指定的通信集合间进行聚合操作，并将聚合的结果返回给集合中每个实例。

参数：

  • input (int|float) - 聚合操作的输入。

  • comm_world (str) - 聚合操作的通信集合，包含: server集合(“server”)，worker集合(“worker”)及所有节点集合(“all”)，默认为worker集合。

返回：

  • output (List): List格式的聚合结果。

代码示例:

  1. # Save the following code in `train.py` , and then execute the command `fleetrun --server_num 2 --worker_num 2 train.py` .
  2. import paddle.distributed.fleet as fleet
  3. from paddle.distributed.fleet import PaddleCloudRoleMaker
  4. import sys
  5. import os
  7. os.environ["PADDLE_WITH_GLOO"] = "2"
  9. def train():
  10.     role = PaddleCloudRoleMaker(
  11.         is_collective=False,
  12.         init_gloo=True,
  13.         path="./tmp_gloo")
  14.     fleet.init(role)
  16.     if fleet.is_server():
  17.         input = fleet.server_index()
  18.         output = fleet.util.all_gather(input, "server")
  19.         print(output)
  20.         # output = [0, 1]
  21.     elif fleet.is_worker():
  22.         input = fleet.worker_index()
  23.         output = fleet.util.all_gather(input, "worker")
  24.         # output = [0, 1]
  25.         print(output)
  26.     output = fleet.util.all_gather(input, "all")
  27.     print(output)
  28.     # output = [0, 1, 0, 1]
  30. if __name__ == "__main__":
  31.     train()

get_file_shard ( files )

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

  1. 示例 1: 原始所有文件列表 `files` = [a, b, c ,d, e]，训练节点个数 `trainer_num` = 2，那么属于零号节点的训练文件为[a, b, c]，属于1号节点的训练文件为[d, e]。
  2. 示例 2: 原始所有文件列表 `files` = [a, b]，训练节点个数 `trainer_num` = 3，那么属于零号节点的训练文件为[a]，属于1号节点的训练文件为[b]，属于2号节点的训练文件为[]。

参数：

  • files (List)：原始所有文件列表。

返回：

  • List: 属于当前训练节点的文件列表。

代码示例:

  1. import paddle.distributed.fleet as fleet
  2. import paddle.distributed.fleet.base.role_maker as role_maker
  4. role = role_maker.UserDefinedRoleMaker(
  5.     is_collective=False,
  6.     init_gloo=False,
  7.     current_id=0,
  8.     role=role_maker.Role.WORKER,
  9.     worker_endpoints=["127.0.0.1:6003", "127.0.0.1:6004"],
  10.     server_endpoints=["127.0.0.1:6001", "127.0.0.1:6002"])
  11. fleet.init(role)
  13. files = fleet.util.get_file_shard(["file1", "file2", "file3"])
  14. print(files)
  15. # files = ["file1", "file2"]

print_on_rank ( message, rank_id )

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

参数：

  • message (str) – 打印内容。

  • rank_id (int) - 节点编号。

代码示例:

  1. import paddle.distributed.fleet as fleet
  2. import paddle.distributed.fleet.base.role_maker as role_maker
  4. role = role_maker.UserDefinedRoleMaker(
  5.     is_collective=False,
  6.     init_gloo=False,
  7.     current_id=0,
  8.     role=role_maker.Role.WORKER,
  9.     worker_endpoints=["127.0.0.1:6003", "127.0.0.1:6004"],
  10.     server_endpoints=["127.0.0.1:6001", "127.0.0.1:6002"])
  11. fleet.init(role)
  13. fleet.util.print_on_rank("I'm worker 0", 0)