Training Modules

TODO:

  • [ ] Add page-specific notes for code-reference/training-modules.md after inspecting the real project files.
  • [ ] Cross-link Training Modules to the most relevant code, data, testing, and safety pages.
  • [ ] Name the exact file, module, function, class, or flag being documented.
  • [ ] Document inputs, outputs, side effects, and failure modes.
  • [ ] List callers and downstream behavior affected by changes.
  • [ ] Add command examples for running or testing the code.
  • [ ] Add important constants, defaults, units, and assumptions.
  • [ ] Add known edge cases and how to reproduce them.
  • [ ] Add the full training command with every flag.
  • [ ] Document default value, unit, and reason for each training flag.
  • [ ] Add how to verify samples per epoch, roots, corrections, and source weights were used correctly.
  • [ ] Add the exact source path, artifact path, or hardware component name.
  • [ ] Add the command or procedure needed to reproduce the result.
  • [ ] Add expected inputs and outputs.
  • [ ] Add the settings, flags, constants, or calibration values that control it.