Website Blog TensorPlay documentation

tensorplay API tensorplay._composite_funcs API tensorplay._einsum API tensorplay._shape_funcs API tensorplay._stax.api API tensorplay.accelerator API tensorplay.amp.autocast_mode API tensorplay.ao.nn.intrinsic API tensorplay.ao.nn.qat API tensorplay.ao.nn.quantized API tensorplay.ao.nn.quantized.dynamic API tensorplay.ao.pruning API tensorplay.ao.quantization API tensorplay.autograd API tensorplay.autograd.anomaly_mode API tensorplay.autograd.forward_ad API tensorplay.autograd.function API tensorplay.autograd.functional API tensorplay.autograd.grad_mode API tensorplay.autograd.gradcheck API tensorplay.autograd.graph API tensorplay.autograd.profiler_util API tensorplay.autograd.variable API tensorplay.backends.cpu API tensorplay.backends.cuda API tensorplay.backends.mkl API tensorplay.backends.nnpack API tensorplay.backends.openmp API tensorplay.compiler API tensorplay.cuda API tensorplay.cuda.gds API tensorplay.cuda.graph_annotations API tensorplay.cuda.graphs API tensorplay.cuda.green_contexts API tensorplay.cuda.memory API tensorplay.cuda.nccl API tensorplay.cuda.nvtx API tensorplay.cuda.profiler API tensorplay.cuda.random API tensorplay.cuda.streams API tensorplay.cuda.tunable API tensorplay.distributed.algorithms API tensorplay.distributed.algorithms.ddp_comm_hooks.ddp_zero_hook API tensorplay.distributed.algorithms.ddp_comm_hooks.default_hooks API tensorplay.distributed.algorithms.ddp_comm_hooks.post_localSGD_hook API tensorplay.distributed.algorithms.ddp_comm_hooks.powerSGD_hook API tensorplay.distributed.algorithms.ddp_comm_hooks.quantization_hooks API tensorplay.distributed.algorithms.model_averaging API tensorplay.distributed.autograd API tensorplay.distributed.checkpoint API tensorplay.distributed.device_mesh API tensorplay.distributed.elastic.agent.server API tensorplay.distributed.elastic.events API tensorplay.distributed.elastic.metrics API tensorplay.distributed.elastic.multiprocessing API tensorplay.distributed.elastic.rendezvous API tensorplay.distributed.elastic.timer API tensorplay.distributed.elastic.utils API tensorplay.distributed.elastic.utils.data API tensorplay.distributed.fsdp API tensorplay.distributed.fsdp.sharded_grad_scaler API tensorplay.distributed.launcher API tensorplay.distributed.nn API tensorplay.distributed.nn.api API tensorplay.distributed.nn.functional API tensorplay.distributed.optim API tensorplay.distributed.pipelining API tensorplay.distributed.rpc API tensorplay.distributed.tensor API tensorplay.distributed.tensor.parallel API tensorplay.distributions API tensorplay.export API tensorplay.fft._frequency API tensorplay.fft._transforms API tensorplay.func API tensorplay.functional API tensorplay.futures API tensorplay.library API tensorplay.linalg API tensorplay.masked API tensorplay.monitor API tensorplay.multiprocessing API tensorplay.nested API tensorplay.nn.attention API tensorplay.nn.attention.bias API tensorplay.nn.attention.varlen API tensorplay.nn.functional API tensorplay.nn.init API tensorplay.nn.modules.flatten API tensorplay.nn.modules.lazy API tensorplay.nn.modules.module API tensorplay.nn.parameter API tensorplay.nn.utils.rnn API tensorplay.nn.utils.stateless API tensorplay.onnx API tensorplay.overrides API tensorplay.package API tensorplay.profiler API tensorplay.profiler.profiler API tensorplay.random API tensorplay.serialization API tensorplay.serialization.api API tensorplay.signal.windows API tensorplay.special._elementwise API tensorplay.special._error API tensorplay.special._gamma API tensorplay.stax API tensorplay.testing API tensorplay.utils.checkpoint API tensorplay.utils.data API tensorplay.utils.viz API

Automatic differentiation package - tensorplay.autograd Automatic Mixed Precision package - tensorplay.amp Complex numbers Computation-graph visualization - tensorplay.utils.viz DDP Communication Hooks Distributed communication package - tensorplay.distributed DLPack Environment variables foreach operations Index Meta device Multiprocessing package - tensorplay.multiprocessing Patching batch norm Pruning - tensorplay.ao.pruning Python Module Index Quantization - tensorplay.ao.quantization Reproducibility Search Size Storage Tensor attributes Tensor views tensorplay tensorplay._stax tensorplay.accelerator tensorplay.audio tensorplay.backends tensorplay.compiler tensorplay.cuda tensorplay.cuda.tunable tensorplay.distributed.algorithms tensorplay.distributed.autograd tensorplay.distributed.checkpoint tensorplay.distributed.device_mesh tensorplay.distributed.elastic tensorplay.distributed.fsdp tensorplay.distributed.fsdp.fully_shard tensorplay.distributed.nn tensorplay.distributed.optim tensorplay.distributed.pipelining tensorplay.distributed.rpc tensorplay.distributed.tensor tensorplay.distributed.tensor.parallel tensorplay.distributions tensorplay.export tensorplay.fft tensorplay.func tensorplay.func API reference tensorplay.func whirlwind tour tensorplay.futures tensorplay.hub tensorplay.library tensorplay.linalg tensorplay.masked tensorplay.monitor tensorplay.nested tensorplay.nn tensorplay.nn.attention tensorplay.nn.attention.bias tensorplay.nn.attention.omni_attention tensorplay.nn.attention.varlen tensorplay.nn.functional tensorplay.nn.init tensorplay.onnx tensorplay.optim tensorplay.overrides tensorplay.package tensorplay.profiler tensorplay.random tensorplay.serialization tensorplay.signal tensorplay.sparse tensorplay.special tensorplay.stax tensorplay.testing tensorplay.utils.checkpoint tensorplay.utils.data tensorplay.vision Type information UX limitations

API reference

Documentation/API reference

latest (dev)

latest (dev)2026-10-08

Copy

Latest development documentation · Updated 2026-10-08

tensorplay.distributed.rpc API

Functions 14

backend_registered

functionFull reference ↗

tensorplay.distributed.rpc.backend_registered(backend_name: str) → bool[source]

construct_rpc_backend_options

functionFull reference ↗

tensorplay.distributed.rpc.construct_rpc_backend_options(backend: Any, rpc_timeout: float = 60.0, init_method: str = 'env://', **kwargs: Any) → Any[source]

get_rpc_timeout

functionFull reference ↗

tensorplay.distributed.rpc.get_rpc_timeout() → float[source]

get_worker_info

functionFull reference ↗

tensorplay.distributed.rpc.get_worker_info(worker_name: Any = None) → WorkerInfo[source]

init_backend

functionFull reference ↗

tensorplay.distributed.rpc.init_backend(backend: Any, *args: Any, **kwargs: Any) → Any[source]

init_rpc

functionFull reference ↗

tensorplay.distributed.rpc.init_rpc(name: str, backend: Any = BackendType.TENSORPIPE, rank: int = -1, world_size: int = -1, rpc_backend_options: Any = None) → None[source]

is_available

functionFull reference ↗

tensorplay.distributed.rpc.is_available() → bool[source]

method_factory

functionFull reference ↗

tensorplay.distributed.rpc.method_factory(method_name: str, docstring: str | None = None)[source]

new_method

functionFull reference ↗

tensorplay.distributed.rpc.new_method(method_name: str, docstring: str | None = None)

register_backend

functionFull reference ↗

tensorplay.distributed.rpc.register_backend(backend_name: str, construct_rpc_backend_options_handler: Any, init_backend_handler: Any) → Enum[source]

remote

functionFull reference ↗

tensorplay.distributed.rpc.remote(to: Any, func: Any, args: tuple[Any, ...] | None = None, kwargs: dict[str, Any] | None = None, timeout: float = -1.0) → RRef[Any][source]

rpc_async

functionFull reference ↗

tensorplay.distributed.rpc.rpc_async(to: Any, func: Any, args: tuple[Any, ...] | None = None, kwargs: dict[str, Any] | None = None, timeout: float = -1.0) → _Future[Any][source]

rpc_sync

functionFull reference ↗

tensorplay.distributed.rpc.rpc_sync(to: Any, func: Any, args: tuple[Any, ...] | None = None, kwargs: dict[str, Any] | None = None, timeout: float = -1.0) → Any[source]

shutdown

functionFull reference ↗

tensorplay.distributed.rpc.shutdown(graceful: bool = True, timeout: float = 0.0) → None[source]

Classes 5

AllGatherStates

classFull reference ↗

class tensorplay.distributed.rpc.AllGatherStates[source]

BackendType

classFull reference ↗

class tensorplay.distributed.rpc.BackendType(*values)

BackendValue

classFull reference ↗

class tensorplay.distributed.rpc.BackendValue(construct_rpc_backend_options_handler, init_backend_handler)

construct_rpc_backend_options_handler: Alias for field number 0

count(value, /): Return number of occurrences of value.

index(value, start=0, stop=9223372036854775807, /)

Return first index of value.

Raises ValueError if the value is not present.

init_backend_handler: Alias for field number 1

RRef

classFull reference ↗

class tensorplay.distributed.rpc.RRef(value: T | object = <object object>, owner: Any = None, _future: _Future[T] | None = None, _native: Any = None)[source]

TensorPipeRpcBackendOptions

classFull reference ↗

class tensorplay.distributed.rpc.TensorPipeRpcBackendOptions(*, num_worker_threads: int = 16, rpc_timeout: float = 60.0, init_method: str = 'env://', device_maps: dict[str, dict[int | str | Any, int | str | Any]] | None = None, devices: list[int | str | Any] | None = None, _transports: list[Any] | None = None, _channels: list[Any] | None = None)[source]

Attributes 1

Future

attributeFull reference ↗

tensorplay.distributed.rpc.Future: alias of _Future

Help improve this page

Found an error, an unclear step, or a missing example?

Was this page helpful?

Suggest an edit Report an issue

tensorplay.distributed.pipelining API

Complete API reference for tensorplay.distributed.pipelining, including signatures, parameters, examples and members.

tensorplay.distributed.tensor API

Complete API reference for tensorplay.distributed.tensor, including signatures, parameters, examples and members.

On this page

Functions 14 backend_registered construct_rpc_backend_options get_rpc_timeout get_worker_info init_backend init_rpc is_available method_factory new_method register_backend remote rpc_async rpc_sync shutdown Classes 5 AllGatherStates BackendType BackendValue RRef TensorPipeRpcBackendOptions Attributes 1 Future