frozenleaves/pytorch
1
0
Fork 0
mirror of https://github.com/pytorch/pytorch.git synced 2025-10-22 14:15:01 +08:00
Code Issues Packages Projects Releases Wiki Activity

Minor fixes for RPC API doc (#34955)

Browse Source 
Summary: Pull Request resolved: https://github.com/pytorch/pytorch/pull/34955

Test Plan: Imported from OSS

Differential Revision: D20512262

Pulled By: mrshenli

fbshipit-source-id: 86ed099638fd32dc8fbde5a6f284239b146fd5e9
This commit is contained in:
Shen Li
2020-03-18 11:15:17 -07:00
committed by Facebook GitHub Bot
parent d29f450e63
commit b35e544772
2 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
torch/distributed/rpc/api.py
View File

@ -196,17 +196,17 @@ def _wait_all_workers():
def shutdown(graceful=True):
r"""
Perform a shutdown of the RPC agent, and then destroy the RPC agent. This
stops the local agent from accepting outstanding requests, and shuts
down the RPC framework by terminating all RPC threads. If graceful=True,
then this will block until all local and remote RPC processes reach this
method and wait for all outstanding work to complete. Otherwise, if
graceful=False, then this is a local shutdown, and it does not wait for
other RPC processes to reach this method.
stops the local agent from accepting outstanding requests, and shuts
down the RPC framework by terminating all RPC threads. If ``graceful=True``,
this will block until all local and remote RPC processes reach this method
and wait for all outstanding work to complete. Otherwise, if
``graceful=False``, this is a local shutdown, and it does not wait for other
RPC processes to reach this method.
Arguments:
graceful (bool): Whether to do a graceful shutdown or not. If True,
this will 1) wait until there is no pending system
messages for ``UserRRef``s and delete them; 2) block
messages for ``UserRRefs`` and delete them; 2) block
until all local and remote RPC processes have reached
this method and wait for all outstanding work to
complete.