From d811dc547843ccd67b2f79bbbe5a315c2031c3c6 Mon Sep 17 00:00:00 2001 From: Megvii Engine Team Date: Wed, 21 Jul 2021 16:52:42 +0800 Subject: [PATCH] docs(mge/distributed): add document for distributed.backend GitOrigin-RevId: 6cdcf7af7796e551a3bbaca9f84531fd84791db8 --- imperative/python/megengine/distributed/__init__.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/imperative/python/megengine/distributed/__init__.py b/imperative/python/megengine/distributed/__init__.py index 19e3b9a3..3ac321c3 100644 --- a/imperative/python/megengine/distributed/__init__.py +++ b/imperative/python/megengine/distributed/__init__.py @@ -31,6 +31,18 @@ from .server import Client, Server @mproperty def backend(mod): + r""" + Get or set backend of collective communication. + Available backends are ['nccl', 'shm', 'rccl'] + + Examples: + + .. code-block:: + + import megengine.distributed as dist + dist.backend = "nccl" + + """ assert group._sd, "please call init_process_group first" return group._sd.backend