torchmonarch-nightly 2025.9.3__cp312-cp312-manylinux2014_x86_64.whl → 2025.9.4__cp312-cp312-manylinux2014_x86_64.whl

monarch/_src/actor/actor_mesh.py

@@ -529,14 +529,38 @@ def as_endpoint(
 
 
 class Accumulator(Generic[P, R, A]):
+    """
+    Accumulate the result of a broadcast invocation of an endpoint
+    across a sliced mesh.
+
+    Usage:
+            >>> counter = Accumulator(Actor.increment, 0, lambda x, y: x + y)
+    """
+
     def __init__(
         self, endpoint: Endpoint[P, R], identity: A, combine: Callable[[A, R], A]
     ) -> None:
+        """
+        Args:
+            endpoint: Endpoint to accumulate the result of.
+            identity: Initial value of the accumulated value before the first combine invocation.
+            combine: Lambda invoked for combining the result of the endpoint with the accumulated value.
+        """
         self._endpoint: Endpoint[P, R] = endpoint
         self._identity: A = identity
         self._combine: Callable[[A, R], A] = combine
 
     def accumulate(self, *args: P.args, **kwargs: P.kwargs) -> "Future[A]":
+        """
+        Accumulate the result of the endpoint invocation.
+
+        Args:
+            args: Arguments to pass to the endpoint.
+            kwargs: Keyword arguments to pass to the endpoint.
+
+        Returns:
+            Future that resolves to the accumulated value.
+        """
         gen: Generator[Future[R], None, None] = self._endpoint.stream(*args, **kwargs)
 
         async def impl() -> A:
@@ -550,7 +574,7 @@ class Accumulator(Generic[P, R, A]):
 
 class ValueMesh(MeshTrait, Generic[R]):
     """
-    Container of return values, indexed by rank.
+    A mesh that holds the result of an endpoint invocation.
     """
 
     def __init__(self, shape: Shape, values: List[R]) -> None:
@@ -561,6 +585,18 @@ class ValueMesh(MeshTrait, Generic[R]):
         return ValueMesh(shape, self._values)
 
     def item(self, **kwargs) -> R:
+        """
+        Get the value at the given coordinates.
+
+        Args:
+            kwargs: Coordinates to get the value at.
+
+        Returns:
+            Value at the given coordinate.
+
+        Raises:
+            KeyError: If invalid coordinates are provided.
+        """
         coordinates = [kwargs.pop(label) for label in self._labels]
         if kwargs:
             raise KeyError(f"item has extra dimensions: {list(kwargs.keys())}")
@@ -568,6 +604,12 @@ class ValueMesh(MeshTrait, Generic[R]):
         return self._values[self._ndslice.nditem(coordinates)]
 
     def items(self) -> Iterable[Tuple[Point, R]]:
+        """
+        Generator that returns values for the provided coordinates.
+
+        Returns:
+            Values at all coordinates.
+        """
         extent = self._shape.extent
         for i, rank in enumerate(self._shape.ranks()):
             yield Point(i, extent), self._values[rank]
@@ -596,14 +638,27 @@ def send(
     selection: Selection = "all",
 ) -> None:
     """
-    Fire-and-forget broadcast invocation of the endpoint across all actors in the mesh.
+        Fire-and-forget broadcast invocation of the endpoint across a given selection of the mesh.
+
+        This sends the message to all actors but does not wait for any result. Use the port provided to
+        send the response back to the caller.
 
-    This sends the message to all actors but does not wait for any result.
+    Args:
+        endpoint: Endpoint to invoke.
+        args: Arguments to pass to the endpoint.
+        kwargs: Keyword arguments to pass to the endpoint.
+        port: Handle to send the response to.
+        selection: Selection query representing a subset of the mesh.
     """
     endpoint._send(args, kwargs, port, selection)
 
 
 class Port(Generic[R]):
+    """
+    Handle used to send reliable in-order messages through a channel to
+    a PortReceiver.
+    """
+
     def __init__(
         self,
         port_ref: PortRef | OncePortRef,
@@ -615,6 +670,13 @@ class Port(Generic[R]):
         self._rank = rank
 
     def send(self, obj: R) -> None:
+        """
+            Fire-and-forget send R-typed objects in order
+            through a channel to its corresponding PortReceiver.
+
+        Args:
+            obj: R-typed object to send.
+        """
         self._port_ref.send(
             self._mailbox,
             PythonMessage(PythonMessageKind.Result(self._rank), _pickle(obj)),
@@ -656,8 +718,17 @@ T = TypeVar("T")
 # not part of the Endpoint API because they way it accepts arguments
 # and handles concerns is different.
 class Channel(Generic[R]):
+    """
+    An advanced low level API for a communication channel used for message passing
+    between actors.
+
+    Provides static methods to create communication channels with port pairs
+    for sending and receiving messages of type R.
+    """
+
     @staticmethod
     def open(once: bool = False) -> Tuple["Port[R]", "PortReceiver[R]"]:
+        """ """
         mailbox = context().actor_instance._mailbox
         handle, receiver = mailbox.open_once_port() if once else mailbox.open_port()
         port_ref = handle.bind()
@@ -673,6 +744,14 @@ class Channel(Generic[R]):
 
 
 class PortReceiver(Generic[R]):
+    """
+    Receiver for messages sent through a communication channel.
+
+    Handles receiving R-typed objects sent from a corresponding Port.
+    Asynchronously message reception with optional supervision
+    monitoring for error handling.
+    """
+
     def __init__(
         self,
         mailbox: Mailbox,
@@ -956,6 +1035,15 @@ class Actor(MeshTrait, DeprecatedNotAFuture):
 
 
 class ActorMesh(MeshTrait, Generic[T], DeprecatedNotAFuture):
+    """
+    A group of actor instances of the same class.
+
+    Represents a collection of T-typed actor instances spawned at most once per process
+    that can be communicated with collectively or individually. Provides
+    methods for spawning actors, managing their lifecycle, and creating
+    endpoints for method invocation across the mesh.
+    """
+
     def __init__(
         self,
         Class: Type[T],

monarch/tools/components/hyperactor.py

@@ -9,7 +9,8 @@ import getpass
 from typing import Optional
 
 from monarch.tools import mesh_spec
-from monarch.tools.config import UnnamedAppDef
+
+from monarch.tools.config import NOT_SET
 from monarch.tools.mesh_spec import mesh_spec_from_str
 from torchx import specs
 
@@ -19,6 +20,7 @@ _USER: str = getpass.getuser()
 
 DEFAULT_NAME: str = f"monarch-{_USER}"
 
+
 __version__ = "latest"  # TODO get version from monarch.__version_
 
 
@@ -28,7 +30,7 @@ def host_mesh(
     env: Optional[dict[str, str]] = None,
     port: int = mesh_spec.DEFAULT_REMOTE_ALLOCATOR_PORT,
     program: str = "monarch_bootstrap",  # installed with monarch wheel (as console script)
-) -> UnnamedAppDef:
+) -> specs.AppDef:
     """
     Args:
         name: the name of the monarch server job
@@ -39,7 +41,7 @@ def host_mesh(
         program: path to the binary that the remote process allocator spawns on an allocation request
     """
 
-    appdef = UnnamedAppDef()
+    appdef = specs.AppDef(name=NOT_SET)
 
     for mesh in [mesh_spec_from_str(mesh) for mesh in meshes]:
         mesh_role = specs.Role(

monarch/tools/config/__init__.py

@@ -7,26 +7,22 @@
 # pyre-strict
 import warnings
 from dataclasses import dataclass, field
-from typing import Any, Dict, List, TYPE_CHECKING
+from typing import Any
 
 from monarch.tools.config.workspace import Workspace
 
-# Defer the import of Role to avoid requiring torchx at import time
-if TYPE_CHECKING:
-    from torchx.specs import Role
-
+# Gracefully handle cases where torchx might not be installed
+# NOTE: this can be removed once torchx.specs moves to monarch.session
+try:
+    from torchx import specs
+except ImportError:
+    pass
 
 NOT_SET: str = "__NOT_SET__"
 
 
-@dataclass
-class UnnamedAppDef:
-    """
-    A TorchX AppDef without a name.
-    """
-
-    roles: List["Role"] = field(default_factory=list)
-    metadata: Dict[str, str] = field(default_factory=dict)
+def _empty_appdef() -> "specs.AppDef":
+    return specs.AppDef(name=NOT_SET)
 
 
 @dataclass
@@ -39,7 +35,7 @@ class Config:
     scheduler_args: dict[str, Any] = field(default_factory=dict)
     workspace: Workspace = field(default_factory=Workspace.null)
     dryrun: bool = False
-    appdef: UnnamedAppDef = field(default_factory=UnnamedAppDef)
+    appdef: "specs.AppDef" = field(default_factory=_empty_appdef)
 
     def __post_init__(self) -> None:
         # workspace used to be Optional[str]

monarch/tools/config/defaults.py

@@ -12,7 +12,7 @@ import warnings
 from typing import Callable
 
 from monarch.tools.components import hyperactor
-from monarch.tools.config import Config, UnnamedAppDef
+from monarch.tools.config import Config
 from monarch.tools.config.workspace import Workspace
 
 from torchx import specs
@@ -25,7 +25,7 @@ from torchx.schedulers import (
 )
 
 
-def component_fn(scheduler: str) -> Callable[..., UnnamedAppDef]:
+def component_fn(scheduler: str) -> Callable[..., specs.AppDef]:
     """The default TorchX component function for the scheduler"""
     return hyperactor.host_mesh
 

monarch/tools/mesh_spec.py

@@ -9,8 +9,6 @@ import string
 from dataclasses import dataclass, field
 from typing import Any, Optional
 
-from monarch.tools.config import UnnamedAppDef
-
 from monarch.tools.network import get_sockaddr
 from torchx import specs
 from torchx.specs.api import is_terminal
@@ -72,7 +70,7 @@ def _tag(mesh_name: str, tag_template: str) -> str:
     return string.Template(tag_template).substitute(mesh_name=mesh_name)
 
 
-def tag_as_metadata(mesh_spec: MeshSpec, appdef: UnnamedAppDef) -> None:
+def tag_as_metadata(mesh_spec: MeshSpec, appdef: specs.AppDef) -> None:
     appdef.metadata[_tag(mesh_spec.name, _TAG_HOST_TYPE)] = mesh_spec.host_type
     appdef.metadata[_tag(mesh_spec.name, _TAG_GPUS)] = str(mesh_spec.gpus)
     appdef.metadata[_tag(mesh_spec.name, _TAG_TRANSPORT)] = mesh_spec.transport

{torchmonarch_nightly-2025.9.3.dist-info → torchmonarch_nightly-2025.9.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: torchmonarch-nightly
-Version: 2025.9.3
+Version: 2025.9.4
 Summary: Monarch: Single controller library
 Author: Meta
 Author-email: oncall+monarch@xmail.facebook.com
@@ -64,7 +64,7 @@ fut.get()
 ```
 
 
-The [introduction to monarch concepts](getting_started.html) provides an introduction to using these features.
+The [introduction to monarch concepts](https://meta-pytorch.org/monarch/generated/examples/getting_started.html) provides an introduction to using these features.
 
 > ⚠️ **Early Development Warning** Monarch is currently in an experimental
 > stage. You should expect bugs, incomplete features, and APIs that may change

{torchmonarch_nightly-2025.9.3.dist-info → torchmonarch_nightly-2025.9.4.dist-info}/RECORD

@@ -1,5 +1,5 @@
 monarch/__init__.py,sha256=mgKiyD1kxky-1pvhMlNfF4VmxWnhi-FSYZNFzkW1BEM,7052
-monarch/_rust_bindings.so,sha256=d4RzRGInKRFbwTNtBqowNU3-WMygmJcNqq9TUSF_zEo,61315880
+monarch/_rust_bindings.so,sha256=Rrq4nwRBp2AFTzMN70XOP7VO9Kqn4NUaWh7BiIthKXA,61351272
 monarch/_testing.py,sha256=5BDMVA4hBMo780rsJ39vRmUZi6mTN8aYY7I9grJRjJ8,7841
 monarch/actor_mesh.py,sha256=VtPU9syi_vUdwDSJJ639Z4Y_EcWZUScyoj0lQ88RQPs,421
 monarch/bootstrap_main.py,sha256=39OZpNMrfvvNJf-iwuNzgslzYA_ItaRPHfXGn_V74N0,524
@@ -8,7 +8,7 @@ monarch/fetch.py,sha256=CssP25dMqyJnJAWoC41lwkMnSbvS-f2DL9PRbudJXfc,1704
 monarch/gradient_generator.py,sha256=b7PmoN_F3c5hQglfHeW_v5htYnePKvJGkzZN-tpHR4A,6396
 monarch/memory.py,sha256=ol86dBhFAJqg78iF25-BuK0wuwj1onR8FIioZ_B0gjw,1377
 monarch/mesh_controller.py,sha256=Y_26Cnmp72TccNbWdDQhq18j7de7pSw83E_fREJX9Yo,15372
-monarch/monarch_controller,sha256=AA0u7qLppriOcmqPZ30oVORlRH9QEyEPqGR8oIETQ7g,32393216
+monarch/monarch_controller,sha256=ncWs8HR0sQOreG4yZrbBOnQ0qb9P-aWSzQx55xzE8N4,32393264
 monarch/notebook.py,sha256=zu9MKDFKf1-rCM2TqFSRJjMBeiWuKcJSyUFLvoZRQzs,25949
 monarch/opaque_module.py,sha256=jCcg0DjbcEVXA9WNG0NhUzGteLHOJLTZEBvrIYJIAns,10436
 monarch/opaque_object.py,sha256=x1LoX6RIMGh4ux52xIfhPgoh6PhZHdkf9bMccHW3DW0,2808
@@ -25,7 +25,7 @@ monarch/tensorboard.py,sha256=MnLgH5lbqeUJauEuirEgR6L_qYl2NGdtwZOWIAuOZao,2587
 monarch/world_mesh.py,sha256=ob5dJWaC49Uw0xqClHBm8CQLvL4xKnjd4TGzk7k8NxI,980
 monarch/_src/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 monarch/_src/actor/__init__.py,sha256=4iK3nzQZmEPe0HGNY70fABBenw3lCVVaaF0xddF5Fa0,235
-monarch/_src/actor/actor_mesh.py,sha256=Y4IaWtVwL4h8nZ2qpOEIs3sqI2uCpVwYQZUCCHUSO80,37707
+monarch/_src/actor/actor_mesh.py,sha256=QH1ITgg9pCRg6LAmdFKhPAYiuUKN757vZUslXscUbNM,40474
 monarch/_src/actor/allocator.py,sha256=UVGhrkPQMqPQp6vUngPI361s6yCEfZ0gfz8WTtG2om4,9392
 monarch/_src/actor/bootstrap_main.py,sha256=7T7ARumcHLZ5RI-k5jej9tBil0J7-BUSVFKwAZO2tJU,2413
 monarch/_src/actor/device_utils.py,sha256=gBpl23wMjppVAEzzj8U9HyX-B7Bs2_3ftiMAkzUS4j4,577
@@ -127,13 +127,13 @@ monarch/tools/__init__.py,sha256=J8qjUOysmcMAek2KFN13mViOXZxTYc5vCrF02t3VuFU,223
 monarch/tools/cli.py,sha256=b3mKZnK-MwP7JwskTxHI0KcJXxSU6498jEb2ntVr_VM,5001
 monarch/tools/colors.py,sha256=XrBkslKoaoDeXqiTluiiuvFLYd-weKp1sjw7DYWz2RY,581
 monarch/tools/commands.py,sha256=z4vCPtn_Ypic7L4_Jd3nMJWyyE4olUPqDe4cpJsDKZ4,13873
-monarch/tools/mesh_spec.py,sha256=9CMiLWNrgSUF0oWoAtmUT2CweMgqi4pLI18w7-EZWxs,8032
+monarch/tools/mesh_spec.py,sha256=lkKZ7RxuJKY19X6kdiU_V6IWlH1GHidynOaTbuCOsAY,7983
 monarch/tools/network.py,sha256=mN8Fx9mervxM3VdFHRn4ZXt4z7yWxZp52BTxx2tfpus,2455
 monarch/tools/utils.py,sha256=gcZyalfoBC6Y3v65h-QMngwXsn24ejXh2TH8RxlgXkA,1888
 monarch/tools/components/__init__.py,sha256=J8qjUOysmcMAek2KFN13mViOXZxTYc5vCrF02t3VuFU,223
-monarch/tools/components/hyperactor.py,sha256=P_5XTbCl-niCj7wua-9iDaEuLVhYohetT3nScWgA7Uc,2169
-monarch/tools/config/__init__.py,sha256=3VV8zWKUc-yKA-wybCIbwSvDjtIzCS4dHX9KChvxn9A,2296
-monarch/tools/config/defaults.py,sha256=BRWDbfUkPX1Mz982EzRsYn-DlQpQw2kLIwVV2lbhpnE,2203
+monarch/tools/components/hyperactor.py,sha256=OR5JtH2UCao3ke3vMohzVbuo_L0gZ_jTw8ud82qLj3M,2175
+monarch/tools/config/__init__.py,sha256=wCw2qwGJL1gFuo9Wpvnrva6NKDLyjf2Yglm6Q9UJYkI,2224
+monarch/tools/config/defaults.py,sha256=twUF6eT9HjJyxEZYrz2SoROHHXi3YPUDSeAelJRLBSU,2187
 monarch/tools/config/environment.py,sha256=ikEZKATa2e_8h9pN4_3TzhIHWb4ZZfRT5XtOVoOmHjI,1628
 monarch/tools/config/workspace.py,sha256=a2YzFBTLUB_VrO3kt6dCV5TlmhCH4LyRX3JCMzu7Iv0,6049
 monarch/utils/__init__.py,sha256=9ofjBGAMZo1VGsn7ufiDlrVheMw4Ye34p-isDfveUxc,295
@@ -186,9 +186,9 @@ tests/simulator/test_profiling.py,sha256=TGYCfzTLdkpIwnOuO6KApprmrgPIRQe60KRX3wk
 tests/simulator/test_simulator.py,sha256=LO8lA0ssY-OGEBL5ipEu74f97Y765TEwfUOv-DtIptM,14568
 tests/simulator/test_task.py,sha256=ipqBDuDAysuo1xOB9S5psaFvwe6VATD43IovCTSs0t4,2327
 tests/simulator/test_worker.py,sha256=QrWWIJ3HDgDLkBPRc2mwYPlOQoXQcj1qRfc0WUfKkFY,3507
-torchmonarch_nightly-2025.9.3.dist-info/licenses/LICENSE,sha256=e0Eotbf_rHOYPuEUlppIbvwy4SN98CZnl_hqwvbDA4Q,1530
-torchmonarch_nightly-2025.9.3.dist-info/METADATA,sha256=L5a1VhSSe2RevR33LVzvECh6LjPdlCV_bWkaT1nD7Zk,6184
-torchmonarch_nightly-2025.9.3.dist-info/WHEEL,sha256=lduYNUEDASmtUEDemd8SmeX1qOMvvA6YKAbAo1Qbwk8,104
-torchmonarch_nightly-2025.9.3.dist-info/entry_points.txt,sha256=60QVSpYVzkzS4iDOiLp0fsLxVp47X3J2l3v7W-59LMo,117
-torchmonarch_nightly-2025.9.3.dist-info/top_level.txt,sha256=E-ZssZzyM17glpVrh-S9--qJ-w9p2EjuYOuNw9tQ4Eg,33
-torchmonarch_nightly-2025.9.3.dist-info/RECORD,,
+torchmonarch_nightly-2025.9.4.dist-info/licenses/LICENSE,sha256=e0Eotbf_rHOYPuEUlppIbvwy4SN98CZnl_hqwvbDA4Q,1530
+torchmonarch_nightly-2025.9.4.dist-info/METADATA,sha256=mRWehYrs_QENvKeR77pdQ8AO9LIPeGwd1Tarqqf05gs,6236
+torchmonarch_nightly-2025.9.4.dist-info/WHEEL,sha256=lduYNUEDASmtUEDemd8SmeX1qOMvvA6YKAbAo1Qbwk8,104
+torchmonarch_nightly-2025.9.4.dist-info/entry_points.txt,sha256=60QVSpYVzkzS4iDOiLp0fsLxVp47X3J2l3v7W-59LMo,117
+torchmonarch_nightly-2025.9.4.dist-info/top_level.txt,sha256=E-ZssZzyM17glpVrh-S9--qJ-w9p2EjuYOuNw9tQ4Eg,33
+torchmonarch_nightly-2025.9.4.dist-info/RECORD,,