pathwaysutils 0.1.8__tar.gz → 0.1.10__tar.gz

{pathwaysutils-0.1.8 → pathwaysutils-0.1.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pathwaysutils
-Version: 0.1.8
+Version: 0.1.10
 Summary: Package of Pathways-on-Cloud utilities.
 Keywords: 
 Author-email: Pathways-on-Cloud Utilities Developers <pathwaysutils-dev@google.com>
@@ -10,7 +10,7 @@ Classifier: License :: OSI Approved :: Apache Software License
 License-File: LICENSE
 Requires-Dist: absl-py
 Requires-Dist: fastapi
-Requires-Dist: jax>=0.8.0
+Requires-Dist: jax>=0.8.3
 Requires-Dist: orbax-checkpoint
 Requires-Dist: uvicorn
 Requires-Dist: requests

{pathwaysutils-0.1.8 → pathwaysutils-0.1.10}/pathwaysutils/__init__.py

@@ -21,4 +21,4 @@ is_pathways_backend_used: Callable[[], bool] = _initialize.is_pathways_backend_u
 del _initialize
 
 # When changing this, also update the CHANGELOG.md.
-__version__ = "v0.1.8"
+__version__ = "v0.1.10"

{pathwaysutils-0.1.8 → pathwaysutils-0.1.10}/pathwaysutils/elastic/elastic.py

@@ -18,10 +18,13 @@ retries a function in case of `jax.errors.JaxRuntimeError` caused by slice down
 events. It also provides a utility for waiting for slices to become active.
 """
 
+from abc import ABC, abstractmethod
 import collections
-from collections.abc import Mapping, Sequence, Set
+from collections.abc import Callable, Mapping, Sequence, Set
+import itertools
 import logging
 import time
+from typing import Any
 
 import jax
 import numpy as np
@@ -41,44 +44,87 @@ _ELASTIC_DOWN_ADDITIONAL_ERROR_TYPES = frozenset([
 ])
 
 
-def _plus_one(x: jax.Array) -> jax.Array:
-  """Adds one to each element in the array.
+class SliceHealthChecker(ABC):
+  """Base class for slice health checkers.
 
-  Used to test if a slice is active.
+  Implementations must provide `dispatch` and `validate` methods.
+  `dispatch` starts the health check operations, and `validate` waits for them
+  and returns the active slice indices.
+  """
 
-  Args:
-    x: The array to add one to.
+  def __init__(self, slice_to_devices: Mapping[int, Sequence[jax.Device]]):
+    self.slice_to_devices = slice_to_devices
 
-  Returns:
-      The array with one added to each element.
-  """
-  return x + 1
+  @abstractmethod
+  def dispatch(self) -> None:
+    """Dispatches the JAX operations in the background."""
 
+  @abstractmethod
+  def validate(self) -> Set[int]:
+    """Blocks on results and returns the set of active slice indices.
 
-def _simple_execution(devices: Sequence[jax.Device]) -> jax.Array:
-  """Simple execution to test if a slice is active.
+    Returns:
+      Set of active slice indices.
+    """
 
-  This function is used to test if a slice is active. It executes a simple
-  computation on the devices and returns the result. If any of the devices are
-  not active, the returned array will fail with a JaxRuntimeError used.
 
-  Simply executing this function is not enough to determine if the slice is
-  active. We also need to check the value of the returned array.
+class DefaultSliceHealthChecker(SliceHealthChecker):
+  """Default implementation that checks each slice individually.
 
-  Args:
-    devices: The devices to execute on.
+  It executes a simple computation on each slice independently to verify
+  that the devices are active and responsive.
 
-  Returns:
-    The result of the execution.
+  The computation involves creating a zero array of the same size as the
+  number of devices in the slice, adding (_SIMPLE_EXECUTION_TEST_VALUE - 1)
+  to it, and then running a pmap to add 1 to each element. This verifies
+  that the devices are active and can perform computations.
   """
-  if not devices:
-    raise ValueError("No devices")
 
-  test_input = np.zeros(len(devices), dtype=float) + (
-      _SIMPLE_EXECUTION_TEST_VALUE - 1
-  )
+  def _plus_one(self, x: jax.Array) -> jax.Array:
+    return x + 1
+
+  def _simple_execution(self, devices: Sequence[jax.Device]) -> jax.Array:
+    if not devices:
+      raise ValueError("No devices")
+
+    test_input = np.zeros(len(devices), dtype=float) + (
+        _SIMPLE_EXECUTION_TEST_VALUE - 1
+    )
+
+    return jax.pmap(self._plus_one, devices=devices)(test_input)
+
+  def dispatch(self) -> None:
+    self.results = {
+        slice_index: self._simple_execution(devices)
+        for slice_index, devices in self.slice_to_devices.items()
+    }
+
+  def validate(self) -> Set[int]:
+    active_slice_indices = set()
+    for slice_index, x in self.results.items():
+      expected = (
+          np.zeros(len(self.slice_to_devices[slice_index]), dtype=float)
+          + _SIMPLE_EXECUTION_TEST_VALUE
+      )
+      try:
+        jax.block_until_ready(x)
+        if np.allclose(x, expected):
+          active_slice_indices.add(slice_index)
+        else:
+          msg = (
+              f"Error with _simple_execution for slice_index={slice_index}. "
+              f"Expected: {expected!r}, Actual: {x!r}"
+          )
+          _logger.error(msg)
+          raise ValueError(msg)
+      except jax.errors.JaxRuntimeError as error:
+        _logger.debug(
+            "Caught JaxRuntimeError for slice_index=%s: %s", slice_index, error
+        )
+        if not is_error_due_to_slice_down(error):
+          raise
+    return active_slice_indices
 
-  return jax.pmap(_plus_one, devices=devices)(test_input)
 
 
 def get_slice_to_devices(
@@ -94,6 +140,7 @@ def get_slice_to_devices(
 @timing.timeit
 def get_active_slice_indices(
     slice_to_devices: Mapping[int, Sequence[jax.Device]] | None = None,
+    checker: SliceHealthChecker | None = None,
 ) -> Set[int]:
   """Returns the set of active slices indices.
 
@@ -101,6 +148,8 @@ def get_active_slice_indices(
     slice_to_devices: A mapping from slice index to devices. If None,
       `get_slice_to_devices(jax.devices())` is used to gather all available
       devices and group them by slice.
+    checker: A SliceHealthChecker instance. If None, DefaultSliceHealthChecker
+      is used.
 
   Returns:
     A set of integers representing the indices of the active slices.
@@ -109,55 +158,16 @@ def get_active_slice_indices(
     _logger.debug("slice_to_devices is None. Getting from jax.devices().")
     slice_to_devices = get_slice_to_devices(tuple(jax.devices()))
 
+  if checker is None:
+    checker = DefaultSliceHealthChecker(slice_to_devices)
+
   _logger.debug(
       "Getting active slice indices for slices: %s",
       sorted(list(slice_to_devices.keys())),
   )
 
-  active_slice_indices = set()
-
-  results = {
-      slice_index: _simple_execution(devices)
-      for slice_index, devices in slice_to_devices.items()
-  }
-
-  for slice_index, x in results.items():
-    _logger.debug("Checking slice_index=%s", slice_index)
-    expected = (
-        np.zeros(len(slice_to_devices[slice_index]), dtype=float)
-        + _SIMPLE_EXECUTION_TEST_VALUE
-    )
-    try:
-      with timing.Timer(f"Checking {slice_index=}"):
-        _logger.debug("Blocking until ready for slice_index=%s", slice_index)
-        jax.block_until_ready(x)
-        _logger.debug("Execution finished for slice_index=%s", slice_index)
-        if np.allclose(x, expected):
-          active_slice_indices.add(slice_index)
-          _logger.debug("slice_index=%s active", slice_index)
-        else:
-          _logger.error(
-              "Error with _simple_execution for slice_index=%s. "
-              "This should never happen. Expected: %r, Actual: %r",
-              slice_index,
-              expected,
-              x,
-          )
-          raise ValueError(
-              f"Error with _simple_execution for slice_index={slice_index}."
-          )
-    except jax.errors.JaxRuntimeError as error:
-      _logger.debug(
-          "Caught JaxRuntimeError for slice_index=%s: %s", slice_index, error
-      )
-      if not is_error_due_to_slice_down(error):
-        _logger.info("Re-raising error for slice_index=%s", slice_index)
-        raise
-      _logger.debug("slice_index=%s bad", slice_index)
-
-  _logger.debug("active_slice_indices=%s", active_slice_indices)
-
-  return active_slice_indices
+  checker.dispatch()
+  return checker.validate()
 
 
 def wait_for_slices(
@@ -165,6 +175,7 @@ def wait_for_slices(
     poll_interval: float | int = 10,
     timeout: float | int | None = None,
     slice_to_devices: Mapping[int, Sequence[jax.Device]] | None = None,
+    checker: SliceHealthChecker | None = None,
 ) -> Set[int]:
   """Waits until after at least `slice_count` slices become active.
 
@@ -177,6 +188,7 @@ def wait_for_slices(
       timeout.
     slice_to_devices: A mapping from slice index to devices. If None,
       `get_slice_to_devices(jax.devices())` is used.
+    checker: A SliceHealthChecker instance to use for checking health.
 
   Returns:
     The active slice indices
@@ -201,7 +213,7 @@ def wait_for_slices(
     check_start_time = time.time()
 
     _logger.debug("Checking active slices...")
-    active_slice_indices = get_active_slice_indices(slice_to_devices)
+    active_slice_indices = get_active_slice_indices(slice_to_devices, checker)
     if len(active_slice_indices) >= slice_count:
       _logger.info(
           "Sufficient slices active: %s >= %s. Active indices: %s",

{pathwaysutils-0.1.8 → pathwaysutils-0.1.10}/pathwaysutils/elastic/manager.py

@@ -22,7 +22,7 @@ from collections.abc import Callable, Mapping, Sequence, Set
 import functools
 import logging
 import threading
-from typing import Any, TypeVar
+from typing import Any, TypeAlias, TypeVar
 import warnings
 
 import jax
@@ -48,6 +48,7 @@ class ScaleUpSignalError(Exception):
 
 
 _F = TypeVar("_F", bound=Callable[..., Any])
+RetryPolicy: TypeAlias = Callable[[int, Exception], bool]
 
 
 def _elastic_event_cleanup() -> None:
@@ -66,6 +67,19 @@ def _elastic_event_cleanup() -> None:
     array.delete()
 
 
+class ElasticRetryLimit:
+  """A retry callback that limits the number of attempts."""
+
+  def __init__(self, max_attempts: int):
+    if max_attempts <= 0:
+      raise ValueError("max_attempts must be positive.")
+    self.max_attempts = max_attempts
+
+  def __call__(self, attempt: int, error: Exception) -> bool:
+    del error  # Unused
+    return attempt < self.max_attempts
+
+
 class Manager:
   """Utility class for elastic training.
 
@@ -191,12 +205,14 @@ class Manager:
 
   def elastic_retry(
       self,
-      max_retries: int,
+      # TODO: b/523384843 - Remove max_retries parameter.
+      max_retries: int | None = None,
       minimum_slice_count: int | None = None,
       poll_interval: float | int = 10,
       timeout: float | None = None,
       pre_callback: Callable[..., Any] | None = None,
       on_elastic_event_callback: Callable[..., Any] | None = None,
+      retry_policy: RetryPolicy | None = None,
   ) -> Callable[[_F], _F]:
     """Retries a function with elasticity fault tolerance.
 
@@ -224,6 +240,8 @@ class Manager:
 
     Args:
       max_retries: The maximum number of times to retry the function.
+        Deprecated: Use `retry_policy` instead.
+        TODO: b/523384843 - Remove max_retries parameter.
       minimum_slice_count: The minimum number of slices required to run the
         function. If None, defaults to the total number of slices.
       poll_interval: The number of seconds to wait between activity checks.
@@ -233,6 +251,11 @@ class Manager:
       pre_callback: A callback to call before the function is attempted.
       on_elastic_event_callback: A callback to call after an elastic failure
         occurs.
+      retry_policy: A policy (callable) to determine if a retry should be
+        attempted. It accepts the attempt number (1-indexed) and the exception
+        that triggered the retry. If it returns False, no more retries are
+        attempted. If neither `retry_policy` nor `max_retries` is specified, it
+        defaults to unlimited retries.
 
     Returns:
       A decorator that retries the wrapped function.
@@ -248,17 +271,24 @@ class Manager:
         else minimum_slice_count
     )
 
-    if max_retries <= 0:
-      raise ValueError("max_retries must be positive.")
+    if max_retries is not None and retry_policy is not None:
+      raise ValueError("Cannot specify both max_retries and retry_policy.")
+
+    if retry_policy is None:
+      if max_retries is None:
+        # Default to unlimited retries if neither parameter is supplied.
+        retry_policy = lambda attempt, error: True
+      else:
+        if max_retries <= 0:
+          raise ValueError("max_retries must be positive.")
+        retry_policy = ElasticRetryLimit(max_retries)
 
     def decorator(func: _F) -> _F:
       @functools.wraps(func)
       def wrapper(*args: Any, **kwargs: Any) -> Any:
 
-        def attempt_execution(retry_index: int) -> Any:
-          _logger.info(
-              "Elastic attempt %d out of %d", retry_index + 1, max_retries
-          )
+        def attempt_execution(attempt: int) -> Any:
+          _logger.info("Elastic attempt %d", attempt)
           self.active_slice_indices = elastic.wait_for_slices(
               slice_count=target_slice_count,
               slice_to_devices=self.slice_to_devices,
@@ -289,34 +319,49 @@ class Manager:
               if monitor_thread is not None:
                 monitor_thread.join()
 
-        for retry_index in range(max_retries):
+        attempt = 1
+        while True:
           try:
-            return attempt_execution(retry_index)
-          except ScaleUpSignalError:
-            _logger.info("Scale up requested. Retrying.")
+            return attempt_execution(attempt)
+          except ScaleUpSignalError as error:
+            _logger.info("Scale up requested.")
             _elastic_event_cleanup()
 
             if on_elastic_event_callback is not None:
               on_elastic_event_callback()
+
+            if not retry_policy(attempt, error):
+              _logger.info(
+                  "Retry policy rejected retry after ScaleUpSignalError."
+              )
+              raise ElasticRuntimeError(
+                  f"Elastic attempt {attempt} failed."
+              ) from error
+
+            _logger.info("Retrying.")
           except jax.errors.JaxRuntimeError as error:
             if not elastic.is_error_due_to_slice_down(error):
               raise
 
             if self.new_slice_event.is_set():
-              _logger.info(
-                  "Slice down event and new slice available detected. Retrying."
-              )
+              _logger.info("Slice down event and new slice available detected.")
             else:
-              _logger.info("Slice down event detected. Retrying.")
+              _logger.info("Slice down event detected.")
 
             _elastic_event_cleanup()
 
             if on_elastic_event_callback is not None:
               on_elastic_event_callback()
-        else:
-          raise ElasticRuntimeError(
-              f"Elastic attempt {max_retries} out of {max_retries} failed."
-          )
+
+            if not retry_policy(attempt, error):
+              _logger.info("Retry policy rejected retry after JaxRuntimeError.")
+              raise ElasticRuntimeError(
+                  f"Elastic attempt {attempt} failed."
+              ) from error
+
+            _logger.info("Retrying.")
+
+          attempt += 1
 
       return wrapper
 

pathwaysutils-0.1.10/pathwaysutils/experimental/gke/__init__.py

@@ -0,0 +1,11 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.