Files
UniversalTrain-ai/docs/PROJECT_GUIDE.md
T
chenlin d5e9004f6c
Checks / Layout, translation and Colab checks (push) Has been cancelled
Checks / Ruff (push) Has been cancelled
Checks / Framework tests (native backend, CPU) (push) Has been cancelled
Checks / Portable Rust controller (push) Has been cancelled
docs: add AI agent workflow guide and clean up residual single-robot references
2026-11-05 11:52:07 +08:00

33 lines
1.8 KiB
Markdown

# Project guide
Start with [Workflow](WORKFLOWS.md) when bringing an asset or policy into the
platform. Use [Agent setup](AGENT_SETUP.md) to establish the environment and
[Usage](USAGE.md) for the CLI and configuration.
| Goal | Read |
|---|---|
| Inspect model readiness and choose a tier | [Workflow](WORKFLOWS.md) |
| Set up native physics and verify a command | [Tutorial](TUTORIAL.md) and [Hardware](HARDWARE.md) |
| Specify a keyboard or pad mapping | [Controls](CONTROLS.md) |
| Train and measure a legged policy | [Tutorial](TUTORIAL.md) |
| Train on a Colab GPU | [Colab](COLAB.md) |
| Package a native app or inspect a legacy bundle | [Deploy guide](../deploy/README.md) and [bundle format](../deploy/BUNDLE.md) |
| Understand the backend seam and template lock | [Design](DESIGN.md) and [Vendoring](VENDOR.md) |
| Extend the platform | [Contributing](../CONTRIBUTING.md) |
The checkout includes calibrated Go1, G1, six-legged and wheeled-biped examples,
covering all four locked families.
Their asset READMEs distinguish execution checks, measured
learning and accepted policies; registration alone is not a performance or
hardware qualification. Add another robot with the onboarding tools to give it
a task ID. Run `python scripts/train.py --list` to list local registrations.
The [development record](REFACTOR_STATUS.md) indexes the measured example results
and generated applications from this refactor.
Native apps replay with MuJoCo and the Python requirements listed in the app.
The legacy Rust bundle handles its own board, browser, and extension runtimes.
Native applications currently cover model viewing, supported deterministic
controllers, and compatible ONNX policies, including the wheeled-biped
template's hybrid position and velocity actions. The legacy Rust runtime
uses its position-action layout.