Commitb146ca7

authored and

committed

docs: add get_default_backend_for_device to distributed documentation (#156783)

`torch.distributed.get_default_backend_for_device()` API was added to torch 2.6, but is still missing in distributed documentation. This commit addresses the gap.CC:@guangyey,@EikanWangPull Requestresolved:#156783Approved by:https://github.com/guangyey,https://github.com/malfet

1 parenteddddea commitb146ca7Copy full SHA for b146ca7

File tree

-1

lines changed

-1

lines changed

Lines changed: 4 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -224,6 +224,10 @@ inconsistent 'UUID' assignment across ranks, and to prevent races during initial`
`224`	`224`	`.. autofunction:: is_torchelastic_launched`
`225`	`225`	```
`226`	`226`
	`227`	+```{eval-rst}
	`228`	`+.. autofunction:: get_default_backend_for_device`
	`229`	+```
	`230`	`+`
`227`	`231`	`______________________________________________________________________`
`228`	`232`
`229`	`233`	`Currently three initialization methods are supported:`

Lines changed: 3 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -1379,7 +1379,7 @@ def get_default_backend_for_device(device: Union[str, torch.device]) -> str:`
`1379`	`1379`	`Return the default backend for the given device.`
`1380`	`1380`
`1381`	`1381`	`Args:`
`1382`		`- Union[str, torch.device]: The device to get the default backend for.`
	`1382`	`+device (Union[str, torch.device]): The device to get the default backend for.`
`1383`	`1383`
`1384`	`1384`	`Returns:`
`1385`	`1385`	`The default backend for the given device as a lower case string.`
`@@ -1584,6 +1584,8 @@ def init_process_group(`
`1584`	`1584`	`process must have exclusive access to every GPU it uses, as sharing`
`1585`	`1585`	`GPUs between processes can result in deadlock or NCCL invalid usage.`
`1586`	`1586`	``ucc`` backend is experimental.
	`1587`	`+ Default backend for the device can be queried with`
	`1588`	+ :func:`get_default_backend_for_device`.
`1587`	`1589`	`init_method (str, optional): URL specifying how to initialize the`
`1588`	`1590`	`process group. Default is "env://" if no`
`1589`	`1591`	``init_method`` or ``store`` is specified.

Comments

(0)