resubmit 0.0.2__py3-none-any.whl → 0.0.3__py3-none-any.whl

resubmit/__init__.py

@@ -2,6 +2,5 @@
 
 from .submit import submit_jobs
 from .debug import maybe_attach_debugger
-from .slurm import make_default_slurm_params
 
-__all__ = ["submit_jobs", "maybe_attach_debugger", "make_default_slurm_params"]
+__all__ = ["submit_jobs", "maybe_attach_debugger"]

resubmit/submit.py

@@ -16,11 +16,18 @@ def submit_jobs(
     prompt: bool = True,
     local_run: bool = False,
     slurm_additional_parameters: Optional[Dict] = None,
+    constraint: Optional[str] = None,
+    reservation: Optional[str] = None,
 ):
     """Submit jobs described by `jobs_args` where each entry is a dict of kwargs for `func`.
 
     - If `local_run` is True, the function is called directly: `func(jobs_args)`.
     - Otherwise, submits via submitit.AutoExecutor and returns job objects or, if `block` is True, waits and returns results.
+
+    Optional Slurm settings `constraint` and `reservation` can be provided via explicit
+    parameters (they take precedence) or by passing `slurm_additional_parameters`.
+    If not provided, they are omitted so the code is not tied to cluster-specific
+    defaults.
     """
     jobs_list = list(jobs_args) if not isinstance(jobs_args, list) else jobs_args
 
@@ -42,19 +49,20 @@ def submit_jobs(
     print("submitting jobs")
     executor = submitit.AutoExecutor(folder=folder)
 
-    # default slurm params
+    # default slurm params (keep cluster-specific options out unless explicitly set)
     if slurm_additional_parameters is None:
-        slurm_additional_parameters = {
-            "constraint": "thin",
-            "reservation": "safe",
-            "gpus": num_gpus,
-        }
+        slurm_additional_parameters = {"gpus": num_gpus}
     else:
         slurm_additional_parameters = dict(slurm_additional_parameters)
         slurm_additional_parameters.setdefault("gpus", num_gpus)
 
+    # Allow explicit overrides similar to `account`.
     if account is not None:
         slurm_additional_parameters["account"] = account
+    if reservation is not None:
+        slurm_additional_parameters["reservation"] = reservation
+    if constraint is not None:
+        slurm_additional_parameters["constraint"] = constraint
 
     print("Slurm additional parameters:", slurm_additional_parameters)
 

resubmit-0.0.3.dist-info/METADATA

@@ -0,0 +1,89 @@
+Metadata-Version: 2.4
+Name: resubmit
+Version: 0.0.3
+Summary: Small wrapper around submitit to simplify cluster submissions
+Author: Amir Mehrpanah
+License: MIT
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: submitit>=0.8
+Provides-Extra: debug
+Requires-Dist: debugpy; extra == "debug"
+Dynamic: license-file
+
+# resubmit
+
+Small utility library to simplify job submission with Submitit on SLURM clusters.
+
+Quick usage:
+
+- Install locally for development:
+
+```bash
+pip install -e .[debug]
+```
+
+- Use in your project:
+
+```python
+from resubmit import submit_jobs, maybe_attach_debugger
+
+# attach remote debugger if requested
+maybe_attach_debugger(args.get("port", None))
+
+# submit jobs (list of dicts)
+submit_jobs(jobs_list, my_entrypoint, timeout_min=60, block=True)
+```
+
+## API
+
+### submit_jobs(...) 🔧
+
+Submit multiple jobs to a Slurm cluster using Submitit.
+
+Signature (short):
+
+`submit_jobs(jobs_args: Iterable[dict], func: Callable[[List[dict]], Any], *, timeout_min: int, cpus_per_task: int = 16, mem_gb: int = 64, num_gpus: int = 1, account: Optional[str] = None, folder: str = "logs/%j", block: bool = False, prompt: bool = True, local_run: bool = False, slurm_additional_parameters: Optional[Dict] = None, constraint: Optional[str] = None, reservation: Optional[str] = None)`
+
+- `jobs_args`: iterable of per-job kwargs (each item is passed to `func`).
+- `func`: entrypoint called for each job (should accept a list or single job dict depending on your usage).
+- `timeout_min`, `cpus_per_task`, `mem_gb`, `num_gpus`: common Slurm resources.
+- `account`: optional Slurm account name.
+- `folder`: logs folder for Submitit files (supports `%j` for job id).
+- `block`: if True, waits for all jobs and returns results.
+- `prompt`: if True, asks for confirmation interactively; set to `False` for CI or tests.
+- `local_run`: run the jobs locally without Submitit (useful for debugging).
+- `slurm_additional_parameters`: pass any extra Slurm key/value pairs to Submitit.
+- `constraint` / `reservation`: cluster-specific options kept out of defaults — provide them explicitly if you need them (they take precedence over values in `slurm_additional_parameters`).
+
+Example:
+
+```python
+submit_jobs(
+    jobs_list,
+    my_entrypoint,
+    timeout_min=60,
+    num_gpus=2,
+    prompt=False,
+    constraint="gpu",
+)
+```
+
+### maybe_attach_debugger(port: Optional[int]) 🐞
+
+Attach `debugpy` to the job when `port` is provided (> 0). Safe no-op if `port` is `None` or `<= 0`.
+
+- If `debugpy` (and `submitit`) are not available on the node, a `RuntimeError` is raised with an explanatory message.
+
+Example:
+
+```python
+# attach remote debugger only when a port is provided (e.g., from CLI args)
+maybe_attach_debugger(args.get("port"))
+```
+
+---
+
+Tips:
+- Use `prompt=False` when calling `submit_jobs` from scripts or CI to avoid interactive prompts.
+- Tests demonstrate non-interactive behavior (`prompt=False`) and optional `constraint`/`reservation` handling.

resubmit-0.0.3.dist-info/RECORD

@@ -0,0 +1,8 @@
+resubmit/__init__.py,sha256=E9oorHt7ntQZgLeV9GtB79jHJCCC9WR5_skifBMHnGQ,210
+resubmit/debug.py,sha256=8RINyz7eSAiT47d018wR0R3B_u4PllQJCiLy0zTSQDE,887
+resubmit/submit.py,sha256=iyL-VTDmL_2YvdOAbfeJTH9m4FVb7lLXQLnOIoHqIZI,2874
+resubmit-0.0.3.dist-info/licenses/LICENSE,sha256=v2spsd7N1pKFFh2G8wGP_45iwe5S0DYiJzG4im8Rupc,1066
+resubmit-0.0.3.dist-info/METADATA,sha256=lVUYWXWkdtlco8409sxgQAzjvTp60_lM_FOrKRrj72I,2976
+resubmit-0.0.3.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+resubmit-0.0.3.dist-info/top_level.txt,sha256=BfCexfX-VhUZuNi8sI88i0HF_e3ppausQ76hxPeXjYc,9
+resubmit-0.0.3.dist-info/RECORD,,

resubmit/slurm.py

@@ -1,10 +0,0 @@
-"""Small helpers for SLURM parameter construction."""
-
-
-from typing import Optional
-
-def make_default_slurm_params(gpus: int = 1, constraint: str = "thin", reservation: str = "safe", account: Optional[str] = None) -> dict:
-    params = {"constraint": constraint, "reservation": reservation, "gpus": gpus}
-    if account is not None:
-        params["account"] = account
-    return params

resubmit-0.0.2.dist-info/METADATA

@@ -1,36 +0,0 @@
-Metadata-Version: 2.4
-Name: resubmit
-Version: 0.0.2
-Summary: Small wrapper around submitit to simplify cluster submissions
-Author: Amir Mehrpanah
-License: MIT
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: submitit>=0.8
-Provides-Extra: debug
-Requires-Dist: debugpy; extra == "debug"
-Dynamic: license-file
-
-# resubmit
-
-Small utility library to simplify job submission with Submitit on SLURM clusters.
-
-Quick usage:
-
-- Install locally for development:
-
-```bash
-pip install -e .[debug]
-```
-
-- Use in your project:
-
-```python
-from resubmit import submit_jobs, maybe_attach_debugger
-
-# attach remote debugger if requested
-maybe_attach_debugger(args.get("port", None))
-
-# submit jobs (list of dicts)
-submit_jobs(jobs_list, my_entrypoint, timeout_min=60, block=True)
-```

resubmit-0.0.2.dist-info/RECORD

@@ -1,9 +0,0 @@
-resubmit/__init__.py,sha256=nuOlPF_zmRDxn_bmCE_rseLYL-DNC8f4UC6vHicEcig,284
-resubmit/debug.py,sha256=8RINyz7eSAiT47d018wR0R3B_u4PllQJCiLy0zTSQDE,887
-resubmit/slurm.py,sha256=-mez8sQh0ADTL8xL3cV2ureGn1uvNaR-Uuu7K_qePAY,387
-resubmit/submit.py,sha256=KBN4RDCjmn5Gg7wDogbtytEbTT66xMteTXGpHpHEYFo,2319
-resubmit-0.0.2.dist-info/licenses/LICENSE,sha256=v2spsd7N1pKFFh2G8wGP_45iwe5S0DYiJzG4im8Rupc,1066
-resubmit-0.0.2.dist-info/METADATA,sha256=V2YBAdAukURde6IKVC6TDUIsNMoV679OyUlGfvbC0iE,794
-resubmit-0.0.2.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-resubmit-0.0.2.dist-info/top_level.txt,sha256=BfCexfX-VhUZuNi8sI88i0HF_e3ppausQ76hxPeXjYc,9
-resubmit-0.0.2.dist-info/RECORD,,