Command line#
pimm is installed with the package. Run it from the checkout as uv run pimm <command>; every command takes -h.
Command |
Does |
|---|---|
list training configs |
|
run training locally or inside an allocation |
|
submit training to Slurm through submitit |
|
manage supervisors for chained interactive runs |
|
inspect or export structured trace logs |
|
export model weights (optionally push to the HF Hub) |
pimm ls#
List training configs below an optional directory. The names are paths under configs/ without .py, the form --train.config takes.
usage: pimm ls [DIRECTORY ...]
pimm launch#
Run pimm training locally or inside an existing allocation.
usage: pimm launch [FLAGS] [-- KEY=VALUE ...]
Flags set the launch config; KEY=VALUE tokens after a bare -- override the experiment config (see Configs and overrides). Defaults below come from launch/defaults.yaml and the local site profile; --site and --recipe load others.
General#
Flag |
Type |
Meaning |
Default |
|---|---|---|---|
|
|
— |
|
|
|
Execution mode; the launch/submit command sets this. |
|
|
|
Use a blocking Slurm allocation for |
|
|
|
Shell lines that bootstrap the environment (e.g. |
— |
|
|
— |
|
|
|
— |
|
|
|
— |
|
--paths.*#
Flag |
Type |
Meaning |
Default |
|---|---|---|---|
|
|
— |
|
|
|
— |
|
--resources.*#
Flag |
Type |
Meaning |
Default |
|---|---|---|---|
|
|
— |
|
|
|
— |
|
|
|
GPUs/processes per node; ‘auto’ is local-only. |
|
|
|
— |
|
|
|
— |
|
|
|
— |
|
|
|
— |
|
|
|
— |
|
|
|
— |
|
|
|
— |
|
|
|
— |
|
|
|
— |
|
|
|
— |
|
|
|
— |
|
|
|
— |
|
|
|
— |
|
--run.*#
Flag |
Type |
Meaning |
Default |
|---|---|---|---|
|
|
— |
|
|
|
— |
|
|
|
— |
|
|
|
— |
|
|
|
— |
|
--train.*#
Flag |
Type |
Meaning |
Default |
|---|---|---|---|
|
|
— |
|
|
|
— |
|
|
|
— |
|
|
|
— |
|
|
|
— |
|
--container.*#
Flag |
Type |
Meaning |
Default |
|---|---|---|---|
|
|
— |
|
|
|
— |
|
|
|
— |
|
|
|
— |
— |
|
|
— |
|
|
|
— |
— |
|
|
Absolute interpreter path inside the image (e.g. /opt/conda/bin/python). When set, used as |
|
--submit.*#
Flag |
Type |
Meaning |
Default |
|---|---|---|---|
|
|
— |
|
|
|
— |
|
--chain.*#
Flag |
Type |
Meaning |
Default |
|---|---|---|---|
|
|
— |
|
|
|
— |
|
|
|
— |
|
|
|
— |
|
--watchdog.*#
Flag |
Type |
Meaning |
Default |
|---|---|---|---|
|
|
— |
|
|
|
— |
|
|
|
— |
|
--rdzv.*#
Flag |
Type |
Meaning |
Default |
|---|---|---|---|
|
|
— |
|
|
|
— |
|
|
|
— |
|
pimm submit#
Submit pimm training to Slurm through submitit.
usage: pimm submit [FLAGS] [-- KEY=VALUE ...]
pimm submit takes every pimm launch flag, with --site defaulting to s3df, plus:
Flag |
Meaning |
Default |
|---|---|---|
|
— |
|
pimm watchdog#
Manage watchdogs that supervise chained interactive runs.
usage: pimm watchdog [-h] {ls,rm} ...
pimm watchdog ls#
List installed watchdogs and their state
usage: pimm watchdog ls [-h]
pimm watchdog rm#
Remove a run’s watchdog (stop supervising)
usage: pimm watchdog rm [-h] [--scancel] run
Argument |
Meaning |
Default |
|---|---|---|
|
run name (as shown by |
— |
|
also scancel the running driver and its interactive slot |
— |
pimm trace#
Inspect and export pimm structured trace logs.
usage: pimm trace [-h] {summarize,export} ...
pimm trace summarize#
Summarize rank progress, open spans, and phase durations.
usage: pimm trace summarize [-h] run_dir
Argument |
Meaning |
Default |
|---|---|---|
|
Experiment directory or its structured_logs directory. |
— |
pimm trace export#
Merge per-rank JSONL logs into a Perfetto-compatible trace.
usage: pimm trace export [-h] [-o OUTPUT] run_dir
Argument |
Meaning |
Default |
|---|---|---|
|
Experiment directory or its structured_logs directory. |
— |
|
Output JSON path (default: RUN_DIR/analysis/structured_trace.json). |
— |
pimm export#
Export pimm checkpoints to portable pretrained model directories.
usage: pimm export [-h] [--run-dir RUN_DIR] [--config CONFIG]
[--model-card MODEL_CARD] [--push-to-hub PUSH_TO_HUB]
[--public] [--token TOKEN] [--device DEVICE]
[--no-safe-serialization] [--dry-run]
[checkpoint] [output_dir]
Argument |
Meaning |
Default |
|---|---|---|
|
Checkpoint path, DCP directory, or checkpoint name under <run-dir>/model. Defaults to last when –run-dir is used. |
|
|
Directory to write exported artifacts. |
— |
|
Experiment directory containing config.py and model/. |
— |
|
Config file to use when it cannot be inferred from the run dir. |
— |
|
README.md text file to include as the model card. |
— |
|
Optional Hugging Face Hub repo id to upload after export. |
— |
|
Create a public Hub repo (default: private). |
— |
|
Hugging Face token for upload. |
— |
|
Device used while consolidating checkpoint tensors. |
|
|
Write model.bin (torch pickle) instead of model.safetensors. |
— |
|
Print resolved paths and exit without writing. |
— |