Skip to content

AGENTS.md

Latest commit

 

History

History
13 lines (8 loc) · 1.18 KB

AGENTS.md

File metadata and controls

13 lines (8 loc) · 1.18 KB
Raw

Speculators — Agent Guide

Provenance

Training, eval, and vLLM-launch scripts write reproducibility artifacts so runs can be recreated later.

  • Training (src/speculators/train/utils.py): save_train_command() writes train_command.txt (timestamp, git SHA, world size, package versions, full argv) into the checkpoint directory.
  • Eval (scripts/evaluate/evaluate.py): save_eval_provenance() writes eval_command.txt (timestamp, git SHA, package versions, full argv) into the output directory.
  • vLLM launch (scripts/launch_vllm.py): _save_vllm_provenance() writes vllm_command.txt, vllm.patch, and checkpoint_sha256.txt — but only when --provenance-dir is passed.

Always pass --provenance-dir when running scripts/launch_vllm.py — point it at the associated run's output/checkpoint directory (e.g. --provenance-dir <output_dir>) so the vLLM provenance is co-located with the training/eval it belongs to.

When publishing a model or eval results (HuggingFace, GitHub comments, etc.), always include the provenance artifacts (train_command.txt, eval_command.txt, vllm_command.txt, checkpoint_sha256.txt, patches) so the run can be reproduced.