多进程

一个库，用于启动和管理 n 个由函数或二进制文件指定的 worker 子进程。

对于函数，它使用 torch.multiprocessing（以及 Python 的 multiprocessing）来 spawn/fork worker 进程。对于二进制文件，它使用 Python 的 subprocessing.Popen 来创建 worker 进程。

用法 1：以函数形式启动两个训练器

from torch.distributed.elastic.multiprocessing import Std, start_processes


def trainer(a, b, c):
    pass  # train


# runs two trainers
# LOCAL_RANK=0 trainer(1,2,3)
# LOCAL_RANK=1 trainer(4,5,6)
ctx = start_processes(
    name="trainer",
    entrypoint=trainer,
    args={0: (1, 2, 3), 1: (4, 5, 6)},
    envs={0: {"LOCAL_RANK": 0}, 1: {"LOCAL_RANK": 1}},
    log_dir="/tmp/foobar",
    redirects=Std.ALL,  # write all worker stdout/stderr to a log file
    tee={0: Std.ERR},  # tee only local rank 0's stderr to console
)

# waits for all copies of trainer to finish
ctx.wait()

用法 2：以二进制形式启动 2 个 echo worker

# same as invoking
# echo hello
# echo world > stdout.log
ctx = start_processes(
        name="echo"
        entrypoint="echo",
        log_dir="/tmp/foobar",
        args={0: "hello", 1: "world"},
        redirects={1: Std.OUT},
       )

与 torch.multiprocessing 类似，函数 start_processes() 的返回值是一个进程上下文（api.PContext）。如果启动的是函数，则返回 api.MultiprocessContext；如果启动的是二进制文件，则返回 api.SubprocessContext。两者都是父类 api.PContext 的具体实现。

启动多个 Worker

torch.distributed.elastic.multiprocessing.start_processes(name, entrypoint, args, envs, logs_specs, log_line_prefixes=None, start_method='spawn')

使用提供的选项启动 n 个 entrypoint 进程的副本。

entrypoint 可以是一个 Callable（函数）或一个 str（二进制文件）。副本的数量由 args 和 envs 参数中的条目数量决定，它们需要具有相同的键集。

args 和 env 参数是传递给由副本索引（本地 rank）映射的 entrypoint 的参数和环境变量。所有本地 rank 都必须包含在内。也就是说，键集应该是 {0,1,...,(nprocs-1)}。

注意

当 entrypoint 是一个二进制文件（str）时，args 只能是字符串。如果给定任何其他类型，它将被转换为字符串表示（例如 str(arg1)）。此外，只有当主函数使用 torch.distributed.elastic.multiprocessing.errors.record 进行注解时，二进制文件失败才会写入 error.json 错误文件。对于函数启动，这是默认行为，无需手动添加 @record 注解。

redirects 和 tee 是位掩码，指定要重定向到 log_dir 中的日志文件的一个或多个标准流 (std stream)。有效的掩码值在 Std 中定义。若要仅重定向/tee 特定本地 rank 的流，请将 redirects 作为以本地 rank 为键的映射传递，以指定其重定向行为。任何缺失的本地 rank 将默认为 Std.NONE。

tee 的作用类似于 Unix 命令 “tee”，它会重定向并打印到控制台。要避免 worker 的 stdout/stderr 打印到控制台，请使用 redirects 参数。

对于每个进程，log_dir 将包含

1. {local_rank}/error.json：如果进程失败，则此文件包含错误信息

2. {local_rank}/stdout.json：如果 redirect & STDOUT == STDOUT

3. {local_rank}/stderr.json：如果 redirect & STDERR == STDERR

注意

期望 log_dir 存在、为空且是一个目录。

示例

log_dir = "/tmp/test"

# ok; two copies of foo: foo("bar0"), foo("bar1")
start_processes(
   name="trainer",
   entrypoint=foo,
   args:{0:("bar0",), 1:("bar1",),
   envs:{0:{}, 1:{}},
   log_dir=log_dir
)

# invalid; envs missing for local rank 1
start_processes(
   name="trainer",
   entrypoint=foo,
   args:{0:("bar0",), 1:("bar1",),
   envs:{0:{}},
   log_dir=log_dir
)

# ok; two copies of /usr/bin/touch: touch file1, touch file2
start_processes(
   name="trainer",
   entrypoint="/usr/bin/touch",
   args:{0:("file1",), 1:("file2",),
   envs:{0:{}, 1:{}},
   log_dir=log_dir
 )

# caution; arguments casted to string, runs:
# echo "1" "2" "3" and echo "[1, 2, 3]"
start_processes(
   name="trainer",
   entrypoint="/usr/bin/echo",
   args:{0:(1,2,3), 1:([1,2,3],),
   envs:{0:{}, 1:{}},
   log_dir=log_dir
 )

参数

• name (str) – 一个人类可读的短名称，描述进程是什么（在 teeing stdout/stderr 输出时用作标题）

• entrypoint (Union[Callable, str]) – 可以是 Callable（函数）或 cmd（二进制文件）

• args (dict[int, tuple]) – 传递给每个副本的参数

• envs (dict[int, dict[str, str]]) – 传递给每个副本的环境变量

• log_dir – 用于写入日志文件的目录

• start_method (str) – 多进程启动方法 (spawn, fork, forkserver)，对于二进制文件无效

• redirects – 要重定向到日志文件的标准流

• tee – 要重定向并打印到控制台的标准流

• local_ranks_filter – 要打印到控制台的哪些 rank 的日志

返回类型

PContext

进程上下文

class torch.distributed.elastic.multiprocessing.api.PContext(name, entrypoint, args, envs, logs_specs, log_line_prefixes=None)

用于标准化通过不同机制启动的一组进程上的操作的基类。

名称 PContext 是有意为之，以区分 torch.multiprocessing.ProcessContext。

警告

stdouts 和 stderrs 应该始终是 tee_stdouts 和 tee_stderrs（分别）的超集，这是因为 tee 被实现为重定向 + tail -f <stdout/stderr.log>

class torch.distributed.elastic.multiprocessing.api.MultiprocessContext(name, entrypoint, args, envs, start_method, logs_specs, log_line_prefixes=None)

包含以函数形式调用的 worker 进程的 PContext。

class torch.distributed.elastic.multiprocessing.api.SubprocessContext(name, entrypoint, args, envs, logs_specs, log_line_prefixes=None)

包含以二进制文件形式调用的 worker 进程的 PContext。

class torch.distributed.elastic.multiprocessing.api.RunProcsResult(return_values=<factory>, failures=<factory>, stdouts=<factory>, stderrs=<factory>)

使用 start_processes() 启动的进程完成运行的结果。由 PContext 返回。

请注意以下事项

1. 所有字段均按本地 rank 映射

2. return_values - 仅为函数填充（不包括二进制文件）。

3. stdouts - stdout.log 的路径（如果没有重定向则为空字符串）

4. stderrs - stderr.log 的路径（如果没有重定向则为空字符串）

class torch.distributed.elastic.multiprocessing.api.DefaultLogsSpecs(log_dir=None, redirects=Std.NONE, tee=Std.NONE, local_ranks_filter=None)

Default LogsSpecs 实现

• 如果 log_dir 不存在，则会创建它

• 为每次尝试和每个 rank 生成嵌套文件夹。

reify(envs)

使用以下方案构建日志目标路径

• <log_dir>/<rdzv_run_id>/attempt_<attempt>/<rank>/stdout.log

• <log_dir>/<rdzv_run_id>/attempt_<attempt>/<rank>/stderr.log

• <log_dir>/<rdzv_run_id>/attempt_<attempt>/<rank>/error.json

返回类型

LogsDest

class torch.distributed.elastic.multiprocessing.api.LogsDest(stdouts=<factory>, stderrs=<factory>, tee_stdouts=<factory>, tee_stderrs=<factory>, error_files=<factory>)

对于每种日志类型，保存着本地 rank ID 到文件路径的映射。

class torch.distributed.elastic.multiprocessing.api.LogsSpecs(log_dir=None, redirects=Std.NONE, tee=Std.NONE, local_ranks_filter=None)

定义每个 worker 进程的日志处理和重定向。

参数

• log_dir (Optional[str]) – 将写入日志的基本目录。

• redirects (Union[Std, dict[int, torch.distributed.elastic.multiprocessing.api.Std]]) – 要重定向到文件的流。传递单个 Std 枚举以重定向所有 worker 的流，或传递以 local_rank 为键的映射以选择性地重定向。

• tee (Union[Std, dict[int, torch.distributed.elastic.multiprocessing.api.Std]]) – 要复制到 stdout/stderr 的流。传递单个 Std 枚举以复制所有 worker 的流，或传递以 local_rank 为键的映射以选择性地复制。

abstract reify(envs)

给定环境变量，为每个本地 rank 构建日志文件的目标路径。

Envs 参数包含每个本地 rank 的环境变量字典，其中的条目在 _start_workers() 中定义。

返回类型

LogsDest