多进程包 - torch.multiprocessing

torch.multiprocessing 是对原生 multiprocessing 模块的封装。

它注册了自定义的规约器 (reducers)，使用共享内存以便在不同进程中对相同数据提供共享视图。一旦 tensor/storage 移动到 shared_memory (参见 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 张量

仅在 Python 3 中支持进程间共享 CUDA 张量，需要使用 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 除外，它们不支持此策略)。

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

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

文件系统 - file_system

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

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

生成子进程

注意

适用于 Python >= 3.4。

这取决于 Python 的 multiprocessing 包中的 spawn 启动方法。

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

具体来说，顺序连接进程意味着它们将按顺序终止。如果它们没有按顺序终止，并且第一个进程没有终止，则进程终止将不会被注意到。此外，没有用于错误传播的本地工具。

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

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

生成 nprocs 个进程来运行带有 args 的 fn。

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

参数

• fn (function) –

  函数作为生成进程的入口点被调用。此函数必须在模块的顶层定义，以便它可以被 pickle 并生成。这是 multiprocessing 强制要求的。

  该函数被调用为 fn(i, *args)，其中 i 是进程索引，args 是传递的参数元组。

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

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

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

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

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

返回值

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

class torch.multiprocessing.SpawnContext

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

join(timeout=None, grace_period=None)

在生成上下文中连接一个或多个进程。

尝试在此生成上下文中连接一个或多个进程。如果其中一个进程以非零退出状态退出，则此函数会杀死其余进程 (可以选择宽限期)，并引发异常，其中包含第一个进程退出的原因。

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

参数

• timeout (float) – 等待这么长时间 (以秒为单位) 后放弃等待。

• grace_period (float) – 当任何进程失败时，等待这么长时间 (以秒为单位) 让其他进程优雅地关闭，然后再终止它们。如果它们仍然没有退出，则再等待一个宽限期，然后再杀死它们。