resubmit 0.0.6__tar.gz → 0.0.8__tar.gz

{resubmit-0.0.6/src/resubmit.egg-info → resubmit-0.0.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: resubmit
-Version: 0.0.6
+Version: 0.0.8
 Summary: Small wrapper around submitit to simplify cluster submissions
 Author: Amir Mehrpanah
 License: MIT

{resubmit-0.0.6 → resubmit-0.0.8}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "resubmit"
-version = "0.0.6"
+version = "0.0.8"
 description = "Small wrapper around submitit to simplify cluster submissions"
 readme = "README.md"
 license = { text = "MIT" }

{resubmit-0.0.6 → resubmit-0.0.8}/src/resubmit/__bookkeeping.py

@@ -153,6 +153,8 @@ def submit_jobs(
     block: bool = False,
     prompt: bool = True,
     local_run: bool = False,
+    debug: bool = False,
+    job_name: Optional[str] = "resubmit",
     slurm_additional_parameters: Dict | None = None,
 ) -> Any:
     """
@@ -173,6 +175,8 @@ def submit_jobs(
         block: Whether to block until jobs complete.
         prompt: Whether to prompt for confirmation before submission.
         local_run: If True, runs the function locally instead of submitting.
+        debug: If True, it runs only the first job in the queue for debugging.
+        job_name: Name of the job.
         slurm_additional_parameters: Additional Slurm parameters as a dict. If not provided, defaults to {"gpus": num_gpus}.
     Returns:
         The result of `submit_jobs` from `.__submit`.
@@ -193,5 +197,7 @@ def submit_jobs(
         block=block,
         prompt=prompt,
         local_run=local_run,
+        debug=debug,
+        job_name=job_name,
         slurm_additional_parameters=slurm_additional_parameters,
     )

{resubmit-0.0.6 → resubmit-0.0.8}/src/resubmit/__submit.py

@@ -15,12 +15,28 @@ def _submit_jobs(
     block: bool,
     prompt: bool,
     local_run: bool,
+    debug: bool = False,
     job_name: Optional[str] = "resubmit",
     slurm_additional_parameters: Optional[Dict] = 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)`.
+    Args:
+        jobs_args: Iterable of dicts of job parameters.
+        func: Function to be submitted for each job.
+        timeout_min: Job timeout in minutes.
+        cpus_per_task: Number of CPUs per task.
+        mem_gb: Memory in GB.
+        num_gpus: Number of GPUs.
+        folder: Folder for logs.
+        block: Whether to block until jobs complete.
+        prompt: Whether to prompt for confirmation before submission.
+        local_run: If True, runs the function locally instead of submitting.
+        debug: If True, runs only the first job in the queue for debugging.
+        job_name: Name of the job.
+        slurm_additional_parameters: Additional Slurm parameters as a dict. If not provided,
+    
+    - If `local_run` is True, the function is called directly on the local machine: `func(jobs_args[0])`.
     - 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
@@ -30,12 +46,16 @@ def _submit_jobs(
     """
     jobs_list = list(jobs_args) if not isinstance(jobs_args, list) else jobs_args
 
+    if debug:
+        print("Debug mode: only running the first job locally")
+        return func([jobs_list[0]])
+
     if len(jobs_list) == 0:
         print("No jobs to run exiting")
         return
 
     if local_run:
-        print("Running locally (local_run=True)")
+        print("Running the jobs locally (local_run=True)")
         return func(jobs_list)
 
     if prompt:

{resubmit-0.0.6 → resubmit-0.0.8/src/resubmit.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: resubmit
-Version: 0.0.6
+Version: 0.0.8
 Summary: Small wrapper around submitit to simplify cluster submissions
 Author: Amir Mehrpanah
 License: MIT

{resubmit-0.0.6 → resubmit-0.0.8}/tests/test_resubmit.py

@@ -31,6 +31,26 @@ def test_maybe_attach_debugger_noop():
     maybe_attach_debugger(0)
 
 
+def test_runs_only_the_first_job_in_debug_mode(monkeypatch):
+    jobs = [{"id": 1}, {"id": 2}, {"id": 3}]
+
+    res = _submit_jobs(
+        jobs,
+        dummy_func,
+        timeout_min=1,
+        local_run=True,
+        num_gpus=0,
+        cpus_per_task=1,
+        mem_gb=8,
+        folder="dummy/%j",
+        block=False,
+        prompt=False,
+        debug=True,
+    )
+    # only the first job should be run in debug mode
+    assert res == ["ok-1"]
+
+
 def test_slurm_parameters_optional(monkeypatch):
     events = {}
 
@@ -65,9 +85,10 @@ def test_slurm_parameters_optional(monkeypatch):
         mem_gb=16,
         folder="logs/%j",
         block=False,
+        slurm_additional_parameters={},
     )
     slurm = events["update"]["slurm_additional_parameters"]
-    assert slurm["gpus"] == 2
+
     assert "constraint" not in slurm
     assert "reservation" not in slurm
 
@@ -112,4 +133,3 @@ def test_slurm_parameters_settable(monkeypatch):
     slurm = events["update"]["slurm_additional_parameters"]
     assert slurm["constraint"] == "thin"
     assert slurm["reservation"] == "safe"
-