Skip to content

Operations guide

This page is the English entry point for the repository operations guide.

What this guide is for

The operations guide is the document you read when you need the concrete order of actions for running the project. It is not the place for deep architecture explanation. It is the place for the operational path.

Why the project needs a dedicated guide

A long-running training system usually has enough moving parts that a reader can guess the wrong sequence. A single operations entry document reduces that risk.

Inputs and outputs

  • input: repository state, local toolchain availability, selected configuration
  • output: a started run, generated run directory content, and later checkpoints and metrics

How to judge a normal result

  • the steps point to one clear operational path
  • the run writes data under data/runs/<run_id>/
  • the guide matches the current repository structure

Source document

The root Chinese operations guide remains the authority:

  • STEP_BY_STEP_GUIDE.md