From ecd38c50d7d15b4184cf42649ff1185ee2e11eeb Mon Sep 17 00:00:00 2001 From: Steven Palma Date: Thu, 7 May 2026 21:28:41 +0200 Subject: [PATCH] chore(docs): add to readme and index --- AGENT_GUIDE.md | 2 ++ README.md | 2 +- docs/source/_toctree.yml | 12 ++++++++---- 3 files changed, 11 insertions(+), 5 deletions(-) diff --git a/AGENT_GUIDE.md b/AGENT_GUIDE.md index 725948dc9..57a33fdba 100644 --- a/AGENT_GUIDE.md +++ b/AGENT_GUIDE.md @@ -232,6 +232,8 @@ Match the policy to the user's **GPU memory** and **time budget**. Numbers below All policies typically train for **5–10 epochs** (see §7). +> **Human-facing version:** the [Compute Hardware Guide](./docs/source/hardware_guide.mdx) reuses the table below and adds a cloud-GPU tier guide and a Hugging Face Jobs pointer. + | Policy | Batch | Update (ms) | Peak GPU mem (GB) | Best for | | ----------- | ----: | ----------: | ----------------: | ------------------------------------------------------------------------------------------------ | | `act` | 4 | **83.9** | **0.94** | First-time users, laptops, single-task. Fast and reliable. | diff --git a/README.md b/README.md index afba8ff49..9c40e8b34 100644 --- a/README.md +++ b/README.md @@ -109,7 +109,7 @@ lerobot-train \ Similarly to the hardware, you can easily implement your own policy & leverage LeRobot's data collection, training, and visualization tools, and share your model to the HF Hub -For detailed policy setup guides, see the [Policy Documentation](https://huggingface.co/docs/lerobot/bring_your_own_policies). +For detailed policy setup guides, see the [Policy Documentation](https://huggingface.co/docs/lerobot/bring_your_own_policies). For GPU/RAM requirements and expected training time per policy, see the [Compute Hardware Guide](https://huggingface.co/docs/lerobot/hardware_guide). ## Inference & Evaluation diff --git a/docs/source/_toctree.yml b/docs/source/_toctree.yml index 40cec863f..dd94c7d9e 100644 --- a/docs/source/_toctree.yml +++ b/docs/source/_toctree.yml @@ -24,6 +24,12 @@ - local: rename_map title: Using Rename Map and Empty Cameras title: "Tutorials" +- sections: + - local: hardware_guide + title: Compute Hardware Guide + - local: torch_accelerators + title: PyTorch accelerators + title: "Compute & Hardware" - sections: - local: lerobot-dataset-v3 title: Using LeRobotDataset @@ -142,10 +148,6 @@ - local: cameras title: Cameras title: "Sensors" -- sections: - - local: torch_accelerators - title: PyTorch accelerators - title: "Supported Hardware" - sections: - local: notebooks title: Notebooks @@ -157,6 +159,8 @@ - sections: - local: contributing title: Contribute to LeRobot + - local: contributing_a_policy + title: Contributing a Policy - local: backwardcomp title: Backward compatibility title: "About"