Skip to content

Add document page for torch.distributed.rpc/autograd #28983

@mrshenli

Description

@mrshenli

distributed_c10d has a nice doc page here, and the source code of that live in here. We should add a similar page for rpc and distributed autograd to describe the API.

@rohan-varma brought up a point that whether we want to add the new docs into the existing distributed.rst file as distributed/distributed_c10d.py, distributed/rpc/ and distributed/autograd all live in the same distributed/ folder, or whether we want to keep them in separate files. I would vote for keeping them separate from the existing one, as the existing one mostly focus on c10d, and the new ones are on rpc/autograd, which are quite different topics. The following items would need more discussion and let's track them here:

  1. The title of the existing distributed.rst page says Distributed communication package - torch.distributed, do we want to rename that to Distributed collective communication package - torch.distributed to be more precise?
  2. Should rpc and distributed autograd api docs live in the same file?

cc @pietern @mrshenli @pritamdamania87 @zhaojuanmao @satgera @gqchen @aazzolini @rohan-varma @xush6528

Metadata

Metadata

Assignees

Labels

module: docsRelated to our documentation, both in docs/ and docblocksmodule: rpcRelated to RPC, distributed autograd, RRef, and distributed optimizertriagedThis issue has been looked at a team member, and triaged and prioritized into an appropriate module

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions