多进程包 - torch.multiprocessing

torch.multiprocessing 是原生 multiprocessing 模块的包装器。

它注册了自定义的 reducer，使用共享内存来提供不同进程中相同数据的共享视图。一旦张量/存储（storage）被移动到共享内存（参见 share_memory_()），就可以在不进行任何拷贝的情况下将其发送到其他进程。

该 API 与原始模块 100% 兼容 - 只需将 import multiprocessing 改为 import torch.multiprocessing，就可以使通过队列发送或通过其他机制共享的所有张量移动到共享内存。

由于 API 的相似性，我们不对该包的大部分内容进行文档记录，建议参考原始模块的优秀文档。

警告

如果主进程突然退出（例如由于接收到信号），Python 的 multiprocessing 有时会无法清理其子进程。这是一个已知的问题，因此如果在中断解释器后看到任何资源泄漏，很可能就是这种情况发生了。

策略管理

torch.multiprocessing.get_all_sharing_strategies()

返回当前系统支持的共享策略集合。

torch.multiprocessing.get_sharing_strategy()

返回当前共享 CPU 张量的策略。

torch.multiprocessing.set_sharing_strategy(new_strategy)

设置共享 CPU 张量的策略。

参数

new_strategy (str) – 所选策略的名称。应为 get_all_sharing_strategies() 返回的值之一。

共享 CUDA 张量

进程间共享 CUDA 张量仅在 Python 3 中受支持，使用 spawn 或 forkserver 启动方法。

与 CPU 张量不同，发送进程需要保留原始张量，只要接收进程保留张量的副本。引用计数是在内部实现的，但要求用户遵循以下最佳实践。

警告

如果消费者进程因致命信号异常终止，只要发送进程仍在运行，共享张量可能会永久保留在内存中。

1. 消费者应尽快释放内存。

## Good
x = queue.get()
# do somethings with x
del x

## Bad
x = queue.get()
# do somethings with x
# do everything else (producer have to keep x in memory)

2. 使生产者进程运行，直到所有消费者退出。这将防止生产者进程释放仍在被消费者使用的内存的情况。

## producer
# send tensors, do something
event.wait()

## consumer
# receive tensors and use them
event.set()

3. 不要传递接收到的张量。

# not going to work
x = queue.get()
queue_2.put(x)

# you need to create a process-local copy
x = queue.get()
x_clone = x.clone()
queue_2.put(x_clone)

# putting and getting from the same queue in the same process will likely end up with segfault
queue.put(tensor)
x = queue.get()

共享策略

本节简要概述了不同共享策略的工作原理。请注意，它仅适用于 CPU 张量 - CUDA 张量将始终使用 CUDA API 进行共享，因为这是它们可以共享的唯一方式。

文件描述符 - file_descriptor

注意

这是默认策略（macOS 和 OS X 上不支持此策略）。

此策略将使用文件描述符作为共享内存句柄。每当存储（storage）被移动到共享内存时，从 shm_open 获取的文件描述符会与对象一起缓存，当将其发送到其他进程时，文件描述符将（例如通过 UNIX 套接字）传输给它。接收者也会缓存文件描述符并对其进行 mmap，以获取存储数据的共享视图。

请注意，如果共享大量张量，此策略将大部分时间保持大量文件描述符处于打开状态。如果您的系统对打开的文件描述符数量有限制较低且无法提高，应使用 file_system 策略。

文件系统 - file_system

此策略将使用提供给 shm_open 的文件名来标识共享内存区域。这样做的好处是不需要实现缓存从 shm_open 获取的文件描述符，但同时容易出现共享内存泄漏。文件创建后不能立即删除，因为其他进程需要访问它来打开其视图。如果进程发生致命崩溃或被杀死，并且没有调用存储（storage）的析构函数，文件将保留在系统中。这是非常严重的问题，因为它们会持续占用内存，直到系统重启或手动释放它们。

为了解决共享内存文件泄漏的问题，torch.multiprocessing 将启动一个名为 torch_shm_manager 的守护进程，该进程将与当前进程组隔离，并跟踪所有共享内存分配。一旦所有连接到它的进程退出，它将等待片刻以确保没有新的连接，并遍历该组分配的所有共享内存文件。如果发现其中任何文件仍然存在，它们将被解除分配。我们已经测试了这种方法，并证明它能够应对各种故障。尽管如此，如果您的系统具有足够高的限制，并且 file_descriptor 是一种受支持的策略，我们不建议切换到此策略。

生成子进程

注意

适用于 Python >= 3.4。

这依赖于 Python 的 multiprocessing 包中的 spawn 启动方法。

通过创建 Process 实例并调用 join 等待它们完成，可以生成多个子进程来执行某个函数。这种方法在处理单个子进程时效果很好，但在处理多个进程时可能会出现潜在问题。

具体来说，按顺序连接（joining）进程意味着它们将按顺序终止。如果不是这样，并且第一个进程没有终止，则进程终止将不会被注意到。此外，没有原生机制用于错误传播。

下面的 spawn 函数解决了这些问题，并负责错误传播、乱序终止，并在检测到其中一个进程发生错误时主动终止其他进程。

torch.multiprocessing.spawn.spawn(fn, args=(), nprocs=1, join=True, daemon=False, start_method='spawn')

生成 nprocs 个进程，这些进程使用 args 运行 fn。

如果其中一个进程以非零退出状态退出，其余进程将被杀死，并抛出异常，指示终止原因。如果在子进程中捕获到异常，该异常将被转发，其回溯信息将包含在父进程中抛出的异常中。

参数

• fn (函数) –

  此函数作为生成的进程的入口点被调用。此函数必须在模块的顶层定义，以便可以被序列化（pickled）和生成（spawned）。这是 multiprocessing 强制的要求。

  该函数以 fn(i, *args) 的形式调用，其中 i 是进程索引，args 是透传的参数元组。

• args (元组) – 传递给 fn 的参数。

• nprocs (int) – 要生成的进程数。

• join (bool) – 对所有进程执行阻塞式连接（join）。

• daemon (bool) – 生成进程的守护进程（daemon）标志。如果设置为 True，将创建守护进程。

• start_method (str) – (已弃用) 此方法将始终使用 spawn 作为启动方法。要使用不同的启动方法，请使用 start_processes()。

返回

如果 join 为 True 则返回 None，如果 join 为 False 则返回 ProcessContext

class torch.multiprocessing.SpawnContext

当调用 spawn() 时且 join=False 时返回。

join(timeout=None, grace_period=None)

连接（join）spawn 上下文中的一个或多个进程。

尝试连接（join）此 spawn 上下文中的一个或多个进程。如果其中一个以非零退出状态退出，此函数将杀死其余进程（可选择给予宽限期），并抛出异常，指示第一个进程退出的原因。

如果所有进程都已成功连接（joined），则返回 True，如果还有更多进程需要连接，则返回 False。

参数

• timeout (浮点数) – 等待此时长（秒）后放弃等待。

• grace_period (浮点数) – 当任何进程失败时，等待此时长（秒）让其他进程优雅关闭，然后终止它们。如果它们仍未退出，则再等待一个宽限期后杀死它们。