groundhog-hpc 0.5.5__tar.gz → 0.5.6__tar.gz

{groundhog_hpc-0.5.5 → groundhog_hpc-0.5.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: groundhog-hpc
-Version: 0.5.5
+Version: 0.5.6
 Summary: Iterative HPC function development. As many 'first tries' as you need.
 Author-email: Owen Price Skelly <OwenPriceSkelly@uchicago.edu>
 License: MIT

{groundhog_hpc-0.5.5 → groundhog_hpc-0.5.6}/src/groundhog_hpc/app/run.py

@@ -92,8 +92,9 @@ def run(
     except RemoteExecutionError as e:
         if e.returncode == 124:
             typer.echo(
-                "Remote execution failed (timed out - try "
-                "increasing walltime for long running jobs)",
+                "Remote execution failed: (exit code 124 - timed out). \nTry increasing walltime for "
+                "long running jobs by setting my_function.walltime (in seconds) "
+                "before invoking my_function.remote/submit()",
                 err=True,
             )
             raise

{groundhog_hpc-0.5.5 → groundhog_hpc-0.5.6}/src/groundhog_hpc/compute.py

@@ -44,7 +44,10 @@ def _get_compute_client() -> Client:
 
 
 def script_to_submittable(
-    script_path: str, function_name: str, payload: str
+    script_path: str,
+    function_name: str,
+    payload: str,
+    walltime: int | float | None = None,
 ) -> ShellFunction:
     """Convert a user script and function name into a Globus Compute ShellFunction.
 
@@ -52,6 +55,7 @@ def script_to_submittable(
         script_path: Path to the Python script containing the function
         function_name: Name of the function to execute remotely
         payload: Serialized arguments string
+        walltime: Optional maximum execution time in seconds for ShellFunction timeout
 
     Returns:
         A ShellFunction ready to be submitted to a Globus Compute executor
@@ -60,7 +64,7 @@ def script_to_submittable(
 
     shell_command = template_shell_command(script_path, function_name, payload)
     shell_function = gc.ShellFunction(
-        shell_command, name=function_name.replace(".", "_")
+        shell_command, name=function_name.replace(".", "_"), walltime=walltime
     )
     return shell_function
 
@@ -82,12 +86,8 @@ def submit_to_executor(
     """
     import globus_compute_sdk as gc
 
-    # Extract walltime and set it on the shell function
-    config = user_endpoint_config.copy()
-    if "walltime" in config:
-        shell_function.walltime = config.pop("walltime")
-
     # Validate config against endpoint schema and filter out unexpected keys
+    config = user_endpoint_config.copy()
     if schema := get_endpoint_schema(endpoint):
         expected_keys = set(schema.get("properties", {}).keys())
         unexpected_keys = set(config.keys()) - expected_keys

{groundhog_hpc-0.5.5 → groundhog_hpc-0.5.6}/src/groundhog_hpc/configuration/models.py

@@ -24,12 +24,10 @@ class EndpointConfig(BaseModel, extra="allow"):
 
     Attributes:
         endpoint: Globus Compute endpoint UUID (required for base configs)
-        walltime: Maximum execution time in seconds (must be positive)
         worker_init: Shell commands to run in worker initialization
     """
 
     endpoint: str | UUID
-    walltime: int | None = Field(None, gt=0)
     worker_init: str | None = None
 
 
@@ -50,7 +48,6 @@ class EndpointVariant(BaseModel, extra="allow"):
     """
 
     endpoint: None = None
-    walltime: int | None = Field(None, gt=0)
     worker_init: str | None = None
 
     @model_validator(mode="before")

{groundhog_hpc-0.5.5 → groundhog_hpc-0.5.6}/src/groundhog_hpc/configuration/pep723.py

@@ -39,7 +39,7 @@ def read_pep723(script: str) -> Pep723Metadata | None:
 
     Raises:
         ValueError: If multiple 'script' metadata blocks are found
-        ValidationError: If metadata contains invalid configuration (e.g., negative walltime)
+        ValidationError: If metadata contains invalid configuration
     """
     name = "script"
     matches = list(

{groundhog_hpc-0.5.5 → groundhog_hpc-0.5.6}/src/groundhog_hpc/decorators.py

@@ -45,7 +45,6 @@ def harness() -> Callable[[FunctionType], Harness]:
 
 def function(
     endpoint: str | None = None,
-    walltime: int | None = None,
     **user_endpoint_config: Any,
 ) -> Callable[[FunctionType], Function]:
     """Decorator to mark a function for remote execution on Globus Compute.
@@ -56,17 +55,17 @@ def function(
     - Submitted asynchronously: func.submit(args)
 
     Args:
-        endpoint: Globus Compute endpoint UUID
-        walltime: Maximum execution time in seconds
+        endpoint: Globus Compute endpoint UUID or named endpoint from
+            `[tool.hog.<name>]` PEP 723 metadata
         **user_endpoint_config: Options to pass through to the Executor as
-            user_endpoint_config (e.g. account, partition, etc)
+            user_endpoint_config (e.g. account, partition, walltime, etc)
 
     Returns:
         A decorator function that wraps the function as a Function instance
 
     Example:
         ```python
-        @hog.function(endpoint="my-remote-endpoint-uuid", walltime=300)
+        @hog.function(endpoint="my-remote-endpoint-uuid", account='my-account')
         def train_model(data):
             # This runs on the remote HPC cluster
             model = train(data)
@@ -81,7 +80,7 @@ def function(
     """
 
     def decorator(func: FunctionType) -> Function:
-        wrapper = Function(func, endpoint, walltime, **user_endpoint_config)
+        wrapper = Function(func, endpoint, **user_endpoint_config)
         functools.update_wrapper(wrapper, func)
         return wrapper
 
@@ -90,7 +89,6 @@ def function(
 
 def method(
     endpoint: str | None = None,
-    walltime: int | None = None,
     **user_endpoint_config: Any,
 ) -> Callable[[FunctionType], Method]:
     """Decorator to mark a class method for remote execution on Globus Compute.
@@ -105,9 +103,8 @@ def method(
 
     Args:
         endpoint: Globus Compute endpoint UUID
-        walltime: Maximum execution time in seconds
         **user_endpoint_config: Options to pass through to the Executor as
-            user_endpoint_config (e.g. account, partition, etc)
+            user_endpoint_config (e.g. account, partition, walltime, etc)
 
     Returns:
         A decorator function that wraps the function as a Method instance
@@ -137,7 +134,7 @@ def method(
                 stacklevel=2,
             )
 
-        wrapper = Method(func, endpoint, walltime, **user_endpoint_config)
+        wrapper = Method(func, endpoint, **user_endpoint_config)
         functools.update_wrapper(wrapper, func)
         return wrapper
 

{groundhog_hpc-0.5.5 → groundhog_hpc-0.5.6}/src/groundhog_hpc/function.py

@@ -51,15 +51,13 @@ class Function:
 
     Attributes:
         endpoint: Default Globus Compute endpoint UUID or None to use resolved config
-        walltime: Default walltime in seconds for remote execution or None to use resolved config
-        default_user_endpoint_config: Default endpoint configuration (e.g., worker_init)
+        default_user_endpoint_config: Default endpoint configuration (e.g., worker_init, walltime)
     """
 
     def __init__(
         self,
         func: FunctionType,
         endpoint: str | None = None,
-        walltime: int | None = None,
         **user_endpoint_config: Any,
     ) -> None:
         """Initialize a Function wrapper.
@@ -67,15 +65,18 @@ class Function:
         Args:
             func: The Python function to wrap
             endpoint: Globus Compute endpoint UUID or named endpoint from `[tool.hog.<name>]` PEP 723
-            walltime: Maximum execution time in seconds (can also be set in config)
             **user_endpoint_config: Additional endpoint configuration to pass to
-                Globus Compute Executor (e.g., worker_init commands)
+                Globus Compute Executor (e.g., worker_init commands, walltime)
         """
         self._script_path: str | None = None
         self.endpoint: str | None = endpoint
-        self.walltime: int | None = walltime
         self.default_user_endpoint_config: dict[str, Any] = user_endpoint_config
 
+        # ShellFunction walltime - always None here to prevent conflicts with a
+        # 'walltime' endpoint config, but the attribute exists as an escape
+        # hatch if users need to set it after the function's been created
+        self.walltime: int | float | None = None
+
         self._local_function: FunctionType = func
         self._config_resolver: ConfigResolver | None = None
 
@@ -103,7 +104,6 @@ class Function:
         self,
         *args: Any,
         endpoint: str | None = None,
-        walltime: int | None = None,
         user_endpoint_config: dict[str, Any] | None = None,
         **kwargs: Any,
     ) -> GroundhogFuture:
@@ -112,7 +112,6 @@ class Function:
         Args:
             *args: Positional arguments to pass to the function
             endpoint: Globus Compute endpoint UUID (overrides decorator default)
-            walltime: Maximum execution time in seconds (overrides decorator default)
             user_endpoint_config: Endpoint configuration dict (merged with decorator default)
             **kwargs: Keyword arguments to pass to the function
 
@@ -134,12 +133,7 @@ class Function:
         endpoint = endpoint or self.endpoint
 
         decorator_config = self.default_user_endpoint_config.copy()
-        if self.walltime is not None:
-            decorator_config["walltime"] = self.walltime
-
         call_time_config = user_endpoint_config.copy() if user_endpoint_config else {}
-        if walltime is not None:
-            call_time_config["walltime"] = walltime
 
         # merge all config sources
         config = self.config_resolver.resolve(
@@ -166,7 +160,9 @@ class Function:
                 raise ValueError("No endpoint specified")
 
         payload = serialize((args, kwargs), use_proxy=False, proxy_threshold_mb=None)
-        shell_function = script_to_submittable(self.script_path, self.name, payload)
+        shell_function = script_to_submittable(
+            self.script_path, self.name, payload, walltime=self.walltime
+        )
 
         future: GroundhogFuture = submit_to_executor(
             UUID(endpoint),
@@ -182,7 +178,6 @@ class Function:
         self,
         *args: Any,
         endpoint: str | None = None,
-        walltime: int | None = None,
         user_endpoint_config: dict[str, Any] | None = None,
         **kwargs: Any,
     ) -> Any:
@@ -194,7 +189,6 @@ class Function:
         Args:
             *args: Positional arguments to pass to the function
             endpoint: Globus Compute endpoint UUID (overrides decorator default)
-            walltime: Maximum execution time in seconds (overrides decorator default)
             user_endpoint_config: Endpoint configuration dict (merged with decorator default)
             **kwargs: Keyword arguments to pass to the function
 
@@ -210,7 +204,6 @@ class Function:
         future = self.submit(
             *args,
             endpoint=endpoint,
-            walltime=walltime,
             user_endpoint_config=user_endpoint_config,
             **kwargs,
         )

{groundhog_hpc-0.5.5 → groundhog_hpc-0.5.6}/src/groundhog_hpc/templates/init_script.py.jinja

@@ -11,8 +11,7 @@
 # endpoint = "TODO: Add Globus Compute endpoint UUID here"
 # # Uncomment and configure default options for "my_endpoint" here (available options vary by endpoint):
 # # account = "my-account"
-# # partition = "standard"
-# # walltime = 300 {% endif %}
+# # partition = "standard" {% endif %}
 # ///
 
 import groundhog_hpc as hog