Skip to content

Commit 43e34f7

Browse files
n-gaon-gao
committed
bump version
1 parent 06c7093 commit 43e34f7

File tree

2 files changed

+20
-19
lines changed

2 files changed

+20
-19
lines changed

‎docs.md‎

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ $ seml add [OPTIONS] CONFIG_FILES...
7474
* `-ncs, --no-sanity-check`: Disable this if the check fails unexpectedly when using advanced Sacred features or to accelerate adding.
7575
* `-ncc, --no-code-checkpoint`: Disable this if you want your experiments to use the current codeinstead of the code at the time of adding.
7676
* `-f, --force`: Force adding the experiment even if it already exists in the database.
77-
* `-o, --overwrite-params JSON`: Dictionary (passed as a string, e.g. '{"epochs": 100}') to overwrite parameters in the config.
77+
* `-o, --overwrite-params DICT`: Dictionary (passed as a string, e.g. '{"epochs": 100}') to overwrite parameters in the config.
7878
* `-d, --description TEXT`: A description for the experiment.
7979
* `--no-resolve-descriptions`: Whether to prevent using omegaconf to resolve experiment descriptions
8080
* `--help`: Show this message and exit.
@@ -92,7 +92,7 @@ $ seml cancel [OPTIONS]
9292
**Options**:
9393

9494
* `-id, --sacred-id INTEGER`: Sacred ID (_id in the database collection) of the experiment. Takes precedence over other filters.
95-
* `-f, --filter-dict JSON`: Dictionary (passed as a string, e.g. '{"config.dataset": "cora_ml"}') to filter the experiments by.
95+
* `-fd, --filter-dict DICT`: Dictionary (passed as a string, e.g. '{"config.dataset": "cora_ml"}') to filter the experiments by.
9696
* `-b, --batch-id INTEGER`: Batch ID (batch_id in the database collection) of the experiments. Experiments that were staged together have the same batch_id.
9797
* `-s, --filter-states [STAGED|QUEUED|PENDING|RUNNING|FAILED|KILLED|INTERRUPTED|COMPLETED]`: List of states to filter the experiments by. If empty (""), all states are considered. [default: PENDING, RUNNING]
9898
* `-w, --wait`: Wait until all jobs are properly cancelled.
@@ -179,7 +179,7 @@ $ seml delete [OPTIONS]
179179

180180
* `-id, --sacred-id INTEGER`: Sacred ID (_id in the database collection) of the experiment. Takes precedence over other filters.
181181
* `-s, --filter-states [STAGED|QUEUED|PENDING|RUNNING|FAILED|KILLED|INTERRUPTED|COMPLETED]`: List of states to filter the experiments by. If empty (""), all states are considered. [default: STAGED, QUEUED, FAILED, KILLED, INTERRUPTED]
182-
* `-f, --filter-dict JSON`: Dictionary (passed as a string, e.g. '{"config.dataset": "cora_ml"}') to filter the experiments by.
182+
* `-fd, --filter-dict DICT`: Dictionary (passed as a string, e.g. '{"config.dataset": "cora_ml"}') to filter the experiments by.
183183
* `-b, --batch-id INTEGER`: Batch ID (batch_id in the database collection) of the experiments. Experiments that were staged together have the same batch_id.
184184
* `-nc, --no-cancel`: Do not cancel the experiments before deleting them.
185185
* `-y, --yes`: Automatically confirm all dialogues with yes.
@@ -219,7 +219,7 @@ $ seml description delete [OPTIONS]
219219

220220
* `-id, --sacred-id INTEGER`: Sacred ID (_id in the database collection) of the experiment. Takes precedence over other filters.
221221
* `-s, --filter-states [STAGED|QUEUED|PENDING|RUNNING|FAILED|KILLED|INTERRUPTED|COMPLETED]`: List of states to filter the experiments by. If empty (""), all states are considered.
222-
* `-f, --filter-dict JSON`: Dictionary (passed as a string, e.g. '{"config.dataset": "cora_ml"}') to filter the experiments by.
222+
* `-fd, --filter-dict DICT`: Dictionary (passed as a string, e.g. '{"config.dataset": "cora_ml"}') to filter the experiments by.
223223
* `-b, --batch-id INTEGER`: Batch ID (batch_id in the database collection) of the experiments. Experiments that were staged together have the same batch_id.
224224
* `-y, --yes`: Automatically confirm all dialogues with yes.
225225
* `--help`: Show this message and exit.
@@ -257,7 +257,7 @@ $ seml description set [OPTIONS] DESCRIPTION
257257

258258
* `-id, --sacred-id INTEGER`: Sacred ID (_id in the database collection) of the experiment. Takes precedence over other filters.
259259
* `-s, --filter-states [STAGED|QUEUED|PENDING|RUNNING|FAILED|KILLED|INTERRUPTED|COMPLETED]`: List of states to filter the experiments by. If empty (""), all states are considered.
260-
* `-f, --filter-dict JSON`: Dictionary (passed as a string, e.g. '{"config.dataset": "cora_ml"}') to filter the experiments by.
260+
* `-fd, --filter-dict DICT`: Dictionary (passed as a string, e.g. '{"config.dataset": "cora_ml"}') to filter the experiments by.
261261
* `-b, --batch-id INTEGER`: Batch ID (batch_id in the database collection) of the experiments. Experiments that were staged together have the same batch_id.
262262
* `-y, --yes`: Automatically confirm all dialogues with yes.
263263
* `--no-resolve-descriptions`: Whether to prevent using omegaconf to resolve experiment descriptions
@@ -276,7 +276,7 @@ $ seml detect-duplicates [OPTIONS]
276276
**Options**:
277277

278278
* `-s, --filter-states [STAGED|QUEUED|PENDING|RUNNING|FAILED|KILLED|INTERRUPTED|COMPLETED]`: List of states to filter the experiments by. If empty (""), all states are considered. [default: STAGED, QUEUED, FAILED, KILLED, INTERRUPTED]
279-
* `-f, --filter-dict JSON`: Dictionary (passed as a string, e.g. '{"config.dataset": "cora_ml"}') to filter the experiments by.
279+
* `-fd, --filter-dict DICT`: Dictionary (passed as a string, e.g. '{"config.dataset": "cora_ml"}') to filter the experiments by.
280280
* `-b, --batch-id INTEGER`: Batch ID (batch_id in the database collection) of the experiments. Experiments that were staged together have the same batch_id.
281281
* `--help`: Show this message and exit.
282282

@@ -312,7 +312,7 @@ $ seml download-sources [OPTIONS] TARGET_DIRECTORY
312312

313313
* `-id, --sacred-id INTEGER`: Sacred ID (_id in the database collection) of the experiment. Takes precedence over other filters.
314314
* `-s, --filter-states [STAGED|QUEUED|PENDING|RUNNING|FAILED|KILLED|INTERRUPTED|COMPLETED]`: List of states to filter the experiments by. If empty (""), all states are considered.
315-
* `-f, --filter-dict JSON`: Dictionary (passed as a string, e.g. '{"config.dataset": "cora_ml"}') to filter the experiments by.
315+
* `-fd, --filter-dict DICT`: Dictionary (passed as a string, e.g. '{"config.dataset": "cora_ml"}') to filter the experiments by.
316316
* `-b, --batch-id INTEGER`: Batch ID (batch_id in the database collection) of the experiments. Experiments that were staged together have the same batch_id.
317317
* `--help`: Show this message and exit.
318318

@@ -373,9 +373,9 @@ $ seml launch-worker [OPTIONS]
373373
* `-o, --output-to-console`: Write the experiment's output to the console.
374374
* `-wg, --worker-gpus TEXT`: The IDs of the GPUs used by the local worker. Will be directly passed to CUDA_VISIBLE_DEVICES.
375375
* `-wc, --worker-cpus INTEGER`: The number of CPUs used by the local worker. Will be directly passed to OMP_NUM_THREADS.
376-
* `-we, --worker-env JSON`: Further environment variables to be set for the local worker.
376+
* `-we, --worker-env DICT`: Further environment variables to be set for the local worker.
377377
* `-id, --sacred-id INTEGER`: Sacred ID (_id in the database collection) of the experiment. Takes precedence over other filters.
378-
* `-f, --filter-dict JSON`: Dictionary (passed as a string, e.g. '{"config.dataset": "cora_ml"}') to filter the experiments by.
378+
* `-fd, --filter-dict DICT`: Dictionary (passed as a string, e.g. '{"config.dataset": "cora_ml"}') to filter the experiments by.
379379
* `-b, --batch-id INTEGER`: Batch ID (batch_id in the database collection) of the experiments. Experiments that were staged together have the same batch_id.
380380
* `--help`: Show this message and exit.
381381

@@ -434,12 +434,12 @@ $ seml print-command [OPTIONS]
434434

435435
* `-id, --sacred-id INTEGER`: Sacred ID (_id in the database collection) of the experiment. Takes precedence over other filters.
436436
* `-s, --filter-states [STAGED|QUEUED|PENDING|RUNNING|FAILED|KILLED|INTERRUPTED|COMPLETED]`: List of states to filter the experiments by. If empty (""), all states are considered. [default: STAGED, QUEUED]
437-
* `-f, --filter-dict JSON`: Dictionary (passed as a string, e.g. '{"config.dataset": "cora_ml"}') to filter the experiments by.
437+
* `-fd, --filter-dict DICT`: Dictionary (passed as a string, e.g. '{"config.dataset": "cora_ml"}') to filter the experiments by.
438438
* `-b, --batch-id INTEGER`: Batch ID (batch_id in the database collection) of the experiments. Experiments that were staged together have the same batch_id.
439439
* `-n, --num-experiments INTEGER`: Number of experiments to start. 0: all (staged) experiments [default: 0]
440440
* `-wg, --worker-gpus TEXT`: The IDs of the GPUs used by the local worker. Will be directly passed to CUDA_VISIBLE_DEVICES.
441441
* `-wc, --worker-cpus INTEGER`: The number of CPUs used by the local worker. Will be directly passed to OMP_NUM_THREADS.
442-
* `-we, --worker-env JSON`: Further environment variables to be set for the local worker.
442+
* `-we, --worker-env DICT`: Further environment variables to be set for the local worker.
443443
* `--unresolved`: Whether to print the unresolved command.
444444
* `--no-interpolation`: Whether disable variable interpolation. Only compatible with --unresolved.
445445
* `--help`: Show this message and exit.
@@ -458,9 +458,10 @@ $ seml print-experiment [OPTIONS]
458458

459459
* `-id, --sacred-id INTEGER`: Sacred ID (_id in the database collection) of the experiment. Takes precedence over other filters.
460460
* `-s, --filter-states [STAGED|QUEUED|PENDING|RUNNING|FAILED|KILLED|INTERRUPTED|COMPLETED]`: List of states to filter the experiments by. If empty (""), all states are considered. [default: PENDING, STAGED, QUEUED, RUNNING, FAILED, KILLED, INTERRUPTED, COMPLETED]
461-
* `-f, --filter-dict JSON`: Dictionary (passed as a string, e.g. '{"config.dataset": "cora_ml"}') to filter the experiments by.
461+
* `-fd, --filter-dict DICT`: Dictionary (passed as a string, e.g. '{"config.dataset": "cora_ml"}') to filter the experiments by.
462462
* `-b, --batch-id INTEGER`: Batch ID (batch_id in the database collection) of the experiments. Experiments that were staged together have the same batch_id.
463463
* `-p, --projection KEY`: List of configuration keys, e.g., `config.model`, to additionally print.
464+
* `-F, --format TEXT`: The format in which to print the experiment document. [default: yaml]
464465
* `--help`: Show this message and exit.
465466

466467
## `seml print-fail-trace`
@@ -476,7 +477,7 @@ $ seml print-fail-trace [OPTIONS]
476477
**Options**:
477478

478479
* `-id, --sacred-id INTEGER`: Sacred ID (_id in the database collection) of the experiment. Takes precedence over other filters.
479-
* `-f, --filter-dict JSON`: Dictionary (passed as a string, e.g. '{"config.dataset": "cora_ml"}') to filter the experiments by.
480+
* `-fd, --filter-dict DICT`: Dictionary (passed as a string, e.g. '{"config.dataset": "cora_ml"}') to filter the experiments by.
480481
* `-b, --batch-id INTEGER`: Batch ID (batch_id in the database collection) of the experiments. Experiments that were staged together have the same batch_id.
481482
* `-s, --filter-states [STAGED|QUEUED|PENDING|RUNNING|FAILED|KILLED|INTERRUPTED|COMPLETED]`: List of states to filter the experiments by. If empty (""), all states are considered. [default: FAILED, KILLED, INTERRUPTED]
482483
* `-p, --projection KEY`: List of configuration keys, e.g., `config.model`, to additionally print.
@@ -496,7 +497,7 @@ $ seml print-output [OPTIONS]
496497

497498
* `-id, --sacred-id INTEGER`: Sacred ID (_id in the database collection) of the experiment. Takes precedence over other filters.
498499
* `-s, --filter-states [STAGED|QUEUED|PENDING|RUNNING|FAILED|KILLED|INTERRUPTED|COMPLETED]`: List of states to filter the experiments by. If empty (""), all states are considered. [default: RUNNING, FAILED, KILLED, INTERRUPTED, COMPLETED]
499-
* `-f, --filter-dict JSON`: Dictionary (passed as a string, e.g. '{"config.dataset": "cora_ml"}') to filter the experiments by.
500+
* `-fd, --filter-dict DICT`: Dictionary (passed as a string, e.g. '{"config.dataset": "cora_ml"}') to filter the experiments by.
500501
* `-b, --batch-id INTEGER`: Batch ID (batch_id in the database collection) of the experiments. Experiments that were staged together have the same batch_id.
501502
* `-sl, --slurm`: Whether to print the Slurm output instead of the experiment output.
502503
* `-h, --head INTEGER`: Print the first n lines of the output.
@@ -631,7 +632,7 @@ $ seml reset [OPTIONS]
631632

632633
* `-id, --sacred-id INTEGER`: Sacred ID (_id in the database collection) of the experiment. Takes precedence over other filters.
633634
* `-s, --filter-states [STAGED|QUEUED|PENDING|RUNNING|FAILED|KILLED|INTERRUPTED|COMPLETED]`: List of states to filter the experiments by. If empty (""), all states are considered. [default: FAILED, KILLED, INTERRUPTED]
634-
* `-f, --filter-dict JSON`: Dictionary (passed as a string, e.g. '{"config.dataset": "cora_ml"}') to filter the experiments by.
635+
* `-fd, --filter-dict DICT`: Dictionary (passed as a string, e.g. '{"config.dataset": "cora_ml"}') to filter the experiments by.
635636
* `-b, --batch-id INTEGER`: Batch ID (batch_id in the database collection) of the experiments. Experiments that were staged together have the same batch_id.
636637
* `-y, --yes`: Automatically confirm all dialogues with yes.
637638
* `--help`: Show this message and exit.
@@ -649,7 +650,7 @@ $ seml start [OPTIONS]
649650
**Options**:
650651

651652
* `-id, --sacred-id INTEGER`: Sacred ID (_id in the database collection) of the experiment. Takes precedence over other filters.
652-
* `-f, --filter-dict JSON`: Dictionary (passed as a string, e.g. '{"config.dataset": "cora_ml"}') to filter the experiments by.
653+
* `-fd, --filter-dict DICT`: Dictionary (passed as a string, e.g. '{"config.dataset": "cora_ml"}') to filter the experiments by.
653654
* `-b, --batch-id INTEGER`: Batch ID (batch_id in the database collection) of the experiments. Experiments that were staged together have the same batch_id.
654655
* `-d, --debug`: Run a single interactive experiment without Sacred observers and with post-mortem debugging. Implies `--verbose --num-exps 1 --post-mortem --output-to-console`.
655656
* `-ds, --debug-server`: Run the experiment with a debug server, to which you can remotely connect with e.g. VS Code. Implies `--debug`.
@@ -662,7 +663,7 @@ $ seml start [OPTIONS]
662663
* `-o, --output-to-console`: Write the experiment's output to the console.
663664
* `-wg, --worker-gpus TEXT`: The IDs of the GPUs used by the local worker. Will be directly passed to CUDA_VISIBLE_DEVICES.
664665
* `-wc, --worker-cpus INTEGER`: The number of CPUs used by the local worker. Will be directly passed to OMP_NUM_THREADS.
665-
* `-we, --worker-env JSON`: Further environment variables to be set for the local worker.
666+
* `-we, --worker-env DICT`: Further environment variables to be set for the local worker.
666667
* `--help`: Show this message and exit.
667668

668669
## `seml start-jupyter`
@@ -680,7 +681,7 @@ $ seml start-jupyter [OPTIONS]
680681

681682
* `-l, --lab`: Start a jupyter-lab instance instead of jupyter notebook.
682683
* `-c, --conda-env TEXT`: Start the Jupyter instance in a Conda environment.
683-
* `-sb, --sbatch-options JSON`: Dictionary (passed as a string, e.g. '{"gres": "gpu:2"}') to request two GPUs.
684+
* `-sb, --sbatch-options DICT`: Dictionary (passed as a string, e.g. '{"gres": "gpu:2"}') to request two GPUs.
684685
* `--help`: Show this message and exit.
685686

686687
## `seml status`

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "seml"
3-
version = "0.5.1"
3+
version = "0.5.2"
44
description = "Slurm Experiment Management Library"
55
readme = "README.md"
66
requires-python = ">=3.10"

0 commit comments

Comments
 (0)