labnotes 0.0.118__tar.gz → 0.0.119__tar.gz

{labnotes-0.0.118 → labnotes-0.0.119}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: labnotes
-Version: 0.0.118
+Version: 0.0.119
 Summary: Browse experiment designs, notes, and run data from a folder.
 Project-URL: Repository, https://github.com/thekevinscott/labnotes
 Author-email: Kevin Scott <me@thekevinscott.com>
@@ -120,6 +120,8 @@ line per event instead.
 
 - `--concurrency N` runs N at a time (default 1).
 - `-e PATH` reads another file instead of `experiment.toml`.
+- `--PARAM=VALUE` runs only the cells where that param has that value, like
+  `--model=small`.
 - With runs going, Ctrl-C asks first. Enter (or a second Ctrl-C) leaves them
   running. `s` stops the running scripts and records their end, then kills any
   still going 5 seconds later. Escape goes back. SIGTERM stops them like `s`.

{labnotes-0.0.118 → labnotes-0.0.119}/README.md

@@ -95,6 +95,8 @@ line per event instead.
 
 - `--concurrency N` runs N at a time (default 1).
 - `-e PATH` reads another file instead of `experiment.toml`.
+- `--PARAM=VALUE` runs only the cells where that param has that value, like
+  `--model=small`.
 - With runs going, Ctrl-C asks first. Enter (or a second Ctrl-C) leaves them
   running. `s` stops the running scripts and records their end, then kills any
   still going 5 seconds later. Escape goes back. SIGTERM stops them like `s`.

{labnotes-0.0.118 → labnotes-0.0.119}/src/labnotes/context.md

@@ -151,6 +151,14 @@ going. Elsewhere, it prints a line per event instead.
   in `experiment.toml` sets it, then `concurrency` under `[experiments]` in
   `.labnotes.toml`, then 1.
 - `-e PATH` reads another file instead of `experiment.toml`.
+- `--PARAM=VALUE` runs only the cells where that param has that value, e.g.
+  `labnotes experiments NAME run --model=small`. PARAM must be a key in
+  `[params]` and VALUE one of its values, written as it shows in `runs`
+  (`true`, `2`); anything else is an error. One value per param; give several
+  params to narrow further (`--model=small --lang=en`). It changes only what
+  this `run` starts: counts, progress and `repeats` still cover the full
+  matrix, so a later plain `run` fills in the rest. Use it instead of editing
+  `experiment.toml` to run a slice.
 - `--timeout SECONDS` stops any one run still going after that many seconds:
   SIGTERM, then SIGKILL 5 seconds later. Its
   `run.json` gets `"error": "timed out after ..."` and `"ended_by": "timeout"`

{labnotes-0.0.118 → labnotes-0.0.119}/src/labnotes/daemon/daemon_app.py

@@ -78,6 +78,7 @@ def daemon_app(config: LabnotesConfig) -> Starlette:
                 name,
                 None if path is None else Path(str(path)),
                 body.get("concurrency"),  # type: ignore[arg-type]
+                body.get("only"),  # type: ignore[arg-type]
             )
         except ValueError as error:
             return refuse(400, str(error))
@@ -103,6 +104,7 @@ def daemon_app(config: LabnotesConfig) -> Starlette:
                     lambda event: record({**event, "experiment": name}),
                     listen,
                     body.get("timeout"),  # type: ignore[arg-type]
+                    only=body.get("only"),  # type: ignore[arg-type]
                 )
             # Clients hear why the session ended; the daemon keeps serving.
             except Exception as failure:  # noqa: BLE001

{labnotes-0.0.118 → labnotes-0.0.119}/src/labnotes/daemon/remote_start.py

@@ -16,6 +16,7 @@ def remote_start(
     experiment_config: Path | None,
     concurrency: int | None,
     timeout: float | None = None,
+    only: dict[str, str] | None = None,
 ) -> Start:
     async def start(report: Report, listen: Listen) -> list[dict[str, object]]:
         try:
@@ -46,6 +47,7 @@ def remote_start(
                     else str(experiment_config.resolve()),
                     "concurrency": concurrency,
                     "timeout": timeout,
+                    "only": only,
                 },
             )
             if reply.status_code != 202:

{labnotes-0.0.118 → labnotes-0.0.119}/src/labnotes/experiments.py

@@ -8,6 +8,7 @@ from labnotes.create_experiment import create_experiment
 from labnotes.daemon.remote_start import remote_start
 from labnotes.utils.format_bytes import format_bytes
 from labnotes.load_config import load_config
+from labnotes.parse_subset import parse_subset
 from labnotes.print_rows import print_rows
 from labnotes.read_config import CONFIG_FILE
 from labnotes.runner.run_headless import run_headless
@@ -20,7 +21,9 @@ BYTES = ("memory", "size")
 
 @click.command(
     help="List experiments, show one, list its runs, or run it."
-    " `new [NAME]` creates one."
+    " `new [NAME]` creates one. With run, --PARAM=VALUE runs only the"
+    " matrix cells where that param has that value.",
+    context_settings={"ignore_unknown_options": True, "allow_extra_args": True},
 )
 @click.argument("name", required=False)
 @click.argument("action", required=False, metavar="[runs|run]")
@@ -74,7 +77,13 @@ def experiments(
             click.echo(f"Created {path / 'experiment.toml'}")
             return
         case str(), "run":
-            start = remote_start(config, name, experiment_config, concurrency, timeout)
+            try:
+                only = parse_subset(ctx.args)
+            except ValueError as error:
+                raise click.UsageError(str(error)) from error
+            start = remote_start(
+                config, name, experiment_config, concurrency, timeout, only
+            )
             try:
                 if sys.stdout.isatty() and sys.stderr.isatty():
                     results = run_tui(start, name)
@@ -92,6 +101,8 @@ def experiments(
             passed = len(results) - failed - retried
             click.echo(f"{passed} passed, {failed} failed.{again}")
             return
+    if ctx.args:
+        raise click.UsageError(f"Unexpected {ctx.args[0]}. --PARAM=VALUE needs run.")
     if action not in (None, "runs"):
         raise click.UsageError(f"Unknown action {action}. Use runs or run.")
     if output_format is None and sys.stdout.isatty() and sys.stderr.isatty():

labnotes-0.0.119/src/labnotes/parse_subset.py

@@ -0,0 +1,10 @@
+def parse_subset(args: list[str]) -> dict[str, str]:
+    only: dict[str, str] = {}
+    for arg in args:
+        param, equals, value = arg.removeprefix("--").partition("=")
+        if not arg.startswith("--") or not equals or not param:
+            raise ValueError(f"Unexpected {arg}. Pick params with --PARAM=VALUE.")
+        if param in only:
+            raise ValueError(f"--{param} given twice. Pass one value per param.")
+        only[param] = value
+    return only

labnotes-0.0.119/src/labnotes/runner/check_subset.py

@@ -0,0 +1,13 @@
+from labnotes.format_value import format_value
+
+
+def check_subset(params: dict[str, list[object]], only: dict[str, str]) -> None:
+    for param, value in only.items():
+        if param not in params:
+            declared = ", ".join(params) or "none"
+            raise ValueError(f"No param {param}. Params: {declared}.")
+        values = [format_value(option) for option in params[param]]
+        if value not in values:
+            raise ValueError(
+                f"No value {value} for {param}. Values: {', '.join(values)}."
+            )

labnotes-0.0.119/src/labnotes/runner/in_subset.py

@@ -0,0 +1,5 @@
+from labnotes.format_value import format_value
+
+
+def in_subset(cell: dict[str, object], only: dict[str, str]) -> bool:
+    return all(format_value(cell[param]) == value for param, value in only.items())

{labnotes-0.0.118 → labnotes-0.0.119}/src/labnotes/runner/prepare_experiment.py

@@ -1,6 +1,7 @@
 from pathlib import Path
 
 from labnotes.models import ExperimentConfig, LabnotesConfig
+from labnotes.runner.check_subset import check_subset
 from labnotes.runner.read_experiment_config import read_experiment_config
 from labnotes.tables.file_text import file_text
 
@@ -10,6 +11,7 @@ async def prepare_experiment(
     name: str,
     experiment_config: Path | None,
     concurrency: int | None,
+    only: dict[str, str] | None = None,
 ) -> tuple[ExperimentConfig, int]:
     if config.experiment not in (None, name):
         raise ValueError(
@@ -29,4 +31,6 @@ async def prepare_experiment(
         config.retries,
         config.defaults,
     )
+    if only:
+        check_subset(experiment.params, only)
     return experiment, experiment.concurrency if concurrency is None else concurrency

{labnotes-0.0.118 → labnotes-0.0.119}/src/labnotes/runner/run_experiment.py

@@ -13,6 +13,7 @@ from labnotes.models import (
 )
 from labnotes.retries import RETRY_EXIT_CODE, RETRY_SECONDS
 from labnotes.runner.execute_run import execute_run
+from labnotes.runner.in_subset import in_subset
 from labnotes.runner.invocation_meta import invocation_meta
 from labnotes.runner.new_param_run_id import new_param_run_id
 from labnotes.runner.new_stamped_run_id import new_stamped_run_id
@@ -36,6 +37,7 @@ async def run_experiment(
     listen: Listen,
     timeout: float | None = None,
     retry_seconds: float = RETRY_SECONDS,
+    only: dict[str, str] | None = None,
 ) -> list[dict[str, object]]:
     meta = None
     if experiment.meta is not None:
@@ -52,7 +54,10 @@ async def run_experiment(
     def taken(run: str) -> bool:
         return run in planned or run in existing
 
-    cells = plan_runs(param_grid(experiment.params), experiment.repeats, finished)
+    grid = [
+        cell for cell in param_grid(experiment.params) if in_subset(cell, only or {})
+    ]
+    cells = plan_runs(grid, experiment.repeats, finished)
     group = None
     match experiment.mode:
         case "adhoc" if len(cells) > 1:

{labnotes-0.0.118 → labnotes-0.0.119}/testing-conventions.toml

@@ -25,13 +25,13 @@ reason = "quiet counts up by one from zero, so it reaches IDLE_EXIT_SECONDS befo
 [[python.exempt]]
 path = "src/labnotes/daemon/daemon_app.py"
 rules = ["mutation"]
-lines = [132]
+lines = [134]
 reason = "start answers 202, 400, 409 or 500, so every status but 202 is above it: != equals >"
 
 [[python.exempt]]
 path = "src/labnotes/daemon/remote_start.py"
 rules = ["mutation"]
-lines = [49]
+lines = [51]
 reason = "the daemon answers a run with 202, 400, 409 or 500, so every status but 202 is above it: != equals >"
 
 [[python.exempt]]
@@ -67,7 +67,7 @@ reason = "WorkerState members are singletons, so is equals =="
 [[python.exempt]]
 path = "src/labnotes/runner/run_experiment.py"
 rules = ["mutation"]
-lines = [188, 269]
+lines = [193, 274]
 reason = "a retry is only scheduled below the budget and each one adds one, so tried never passes retries: >= equals ==; both sides are small ints, which CPython caches, so is equals =="
 
 [[python.exempt]]
@@ -79,5 +79,5 @@ reason = "exit_code is non-negative here; when bit 7 is set, - 128 equals ^ 128,
 [[python.exempt]]
 path = "src/labnotes/experiments.py"
 rules = ["mutation"]
-lines = [109]
+lines = [120]
 reason = "click hands back the \"json\" choice literal itself, so is not equals !="