documenting-experiment-results

Standardize machine learning experiment documentation with version-stamped JSON logs and updated model cards.

1|Updated Jul 12, 2026
One-click install
npx skills add https://github.com/Tyler-R-Kendrick/slm-training --skill documenting-experiment-results
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documenting-experiment-results
Source: https://github.com/Tyler-R-Kendrick/slm-training/tree/main/.agents/skills/documenting-experiment-results
Command: npx skills add https://github.com/Tyler-R-Kendrick/slm-training --skill documenting-experiment-results

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill solves the problem of fragmented or missing experiment documentation, ensuring that every training run, evaluation, and checkpoint is properly recorded, versioned, and linked to the project's design ledger.

Core Features & Use Cases

  • Durable Ledger Maintenance: Automatically maps experiment outputs to the required JSON and Markdown documentation structure.
  • Model Card Synchronization: Ensures that every promoted checkpoint is accompanied by an updated MODEL_CARD.md and a summary in the repository README.
  • Use Case: After completing a model training run, use this Skill to verify that the results JSON is correctly stamped, the measured-results table is updated, and the model card reflects the new experiment metrics and recipe.

Quick Start

Use the documenting-experiment-results skill to audit the current run outputs and update the corresponding design documentation and model card.

Frequently Asked Questions about documenting-experiment-results

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I standardize machine learning experiment documentation and model cards?

Standardize machine learning experiment documentation by enforcing a strict mapping between output artifacts and repository design files. This generates version-stamped JSON logs and updated model cards, ensuring training and evaluation outcomes are traceable and reproducible.

What is the best way to maintain a durable design ledger for ML training runs?

A durable design ledger for ML training runs is maintained by automatically mapping experiment outputs to the required JSON and Markdown documentation structure. This ensures all checkpoints and evaluations are properly recorded, versioned, and linked to project architecture invariants.

How do model cards synchronize with promoted checkpoints during machine learning evaluation?

Model cards synchronize with promoted checkpoints by ensuring every promotion is accompanied by an updated MODEL_CARD.md and a summary in the repository README. This records the new experiment metrics and recipe for complete evidence-grounded research.

Can I use this approach for benchmarking workflows that require evidence-grounded research?

Yes, you can apply this standardization to benchmarking workflows requiring evidence-grounded research. It ensures experiment outcomes are traceable and compliant with project architecture invariants by mapping output artifacts to version-stamped JSON logs.

Why does experiment tracking fail when documentation is fragmented or missing?

Experiment tracking fails with fragmented documentation because training runs, evaluations, and checkpoints are not properly recorded or linked to the design ledger. Enforcing a strict mapping between output artifacts and repository files resolves this reproducibility gap.

Does this documentation method require specific dependencies to version stamp JSON logs?

No specific dependencies are required to version stamp JSON logs and update experiment documentation. The process operates directly on repository design files to enforce traceability and compliance with project architecture invariants.