Python API

Note

This documents Monarch’s public APIs - the stable, supported interfaces.

The actor API for monarch is accessed through the monarch.actor package. The monarch package contains APIs related to computing with distributed tensors. The monarch.job package provides a declarative interface for managing distributed job resources. The monarch.rdma package provides RDMA support for high-performance networking. The monarch.spmd package provides primitives for running torchrun-style SPMD scripts over Monarch meshes.

• monarch.actor
• Creating Actors
  • HostMesh
  • ProcMesh
  • get_or_spawn_controller()
  • this_host()
• Defining Actors
  • Actor
  • endpoint()
• Messaging Actor
  • Endpoint
  • Future
  • ValueMesh
  • ActorError
  • Accumulator
  • send()
  • Channel
  • Port
  • PortReceiver
  • as_endpoint()
• Context API
  • current_actor_name()
  • current_rank()
  • current_size()
  • context()
  • Context
  • Point
  • Extent
• monarch.config
• Configuration API
  • configure()
  • configured()
  • get_global_config()
  • get_runtime_config()
  • clear_runtime_config()
• Configuration Keys
  • Performance and Transport
  • Timeouts
  • Logging
  • Message Handling
  • Message Encoding
  • Mesh Bootstrap
  • Runtime and Buffering
  • Actor Configuration
  • Mesh Configuration
  • Remote Allocation
  • Validation and Error Handling
• Examples
  • Basic Configuration
  • Temporary Configuration (Testing)
  • Nested Overrides
  • Duration Formats
  • Environment Variable Override
• See Also
• monarch.job
• Job Model
• Job State
  • JobState
• Job Base Class
  • JobTrait
• Job Implementations
  • LocalJob
  • SlurmJob
  • KubernetesJob
• Serialization
  • job_load()
  • job_loads()
• SPMD Jobs
  • serve()
  • SPMDJob
• monarch
  • Tensor
  • Stream
  • remote()
  • coalescing()
  • get_active_mesh()
  • no_mesh()
  • to_mesh()
  • slice_mesh()
  • get_active_stream()
  • reduce()
  • reduce_()
  • call_on_shard_and_fetch()
  • fetch_shard()
  • inspect()
  • show()
  • grad_function()
  • grad_generator()
  • timer()
  • world_mesh()
  • function_resolvers()
• Types
  • Extent
  • Shape
  • Selection
  • NDSlice
  • OpaqueRef
  • Future
• Distributed Computing
  • RemoteProcessGroup
• Simulation
  • Simulator
  • set_meta()
• Builtins
• monarch.rdma
• RDMA Buffer
  • RDMABuffer
• RDMA Actions
  • RDMAAction
• Utility Functions
  • is_rdma_available()
• monarch.spmd
  • Environment Setup
  • SPMD Actor