diff --git a/BENCHMARK_WORKFLOW.md b/BENCHMARK_WORKFLOW.md index e36f593..ee298cc 100644 --- a/BENCHMARK_WORKFLOW.md +++ b/BENCHMARK_WORKFLOW.md @@ -83,6 +83,12 @@ - This is required for cross-platform reproduction: when the same experiment is run on H200 and P800, the only differences should be model paths, ports, and device IDs. - If an experiment uses `start_server.sh`, that script should be self-contained and its command line should be reproducible from `results.json` alone. +10. **Version control: commit code and final artifacts only.** + - Always commit the experiment code (`config.env`, `run_bench.sh`, `start_*.sh`, parsers, etc.) together with the run's final artifacts. + - Final artifacts to commit: `results.json` (structured data) and `report.md` / `comparison.md` (human-readable summaries). + - Do **not** commit intermediate logs, per-request JSONL raw outputs, or GPU sampling CSVs. These are already ignored by `.gitignore` (`raw_outputs/`, `logs/`, `gpu_logs/`). + - `scenarios.tsv` and `skipped_after_oom.csv` may be committed if they are useful for reproducing the test plan, but they are optional. + ## Naming Conventions ### Experiment result directories @@ -340,3 +346,4 @@ See `docs/H200_QUICKSTART.md` for a concrete H200 porting walkthrough. - [ ] `/README.md` exists and documents provenance (or the report itself covers provenance). - [ ] Scripts either live under `experiments//` or in `scripts/` (or `scripts//`). - [ ] Script path references updated after moving. +- [ ] Commits include the experiment code plus final `results.json` and `.md` reports; logs/raw outputs are left ignored.