mirror of
https://github.com/huggingface/lerobot.git
synced 2026-05-21 03:30:10 +00:00
chore(docs): add to readme and index
This commit is contained in:
@@ -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).
|
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 |
|
| 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. |
|
| `act` | 4 | **83.9** | **0.94** | First-time users, laptops, single-task. Fast and reliable. |
|
||||||
|
|||||||
@@ -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
|
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
|
## Inference & Evaluation
|
||||||
|
|
||||||
|
|||||||
@@ -24,6 +24,12 @@
|
|||||||
- local: rename_map
|
- local: rename_map
|
||||||
title: Using Rename Map and Empty Cameras
|
title: Using Rename Map and Empty Cameras
|
||||||
title: "Tutorials"
|
title: "Tutorials"
|
||||||
|
- sections:
|
||||||
|
- local: hardware_guide
|
||||||
|
title: Compute Hardware Guide
|
||||||
|
- local: torch_accelerators
|
||||||
|
title: PyTorch accelerators
|
||||||
|
title: "Compute & Hardware"
|
||||||
- sections:
|
- sections:
|
||||||
- local: lerobot-dataset-v3
|
- local: lerobot-dataset-v3
|
||||||
title: Using LeRobotDataset
|
title: Using LeRobotDataset
|
||||||
@@ -142,10 +148,6 @@
|
|||||||
- local: cameras
|
- local: cameras
|
||||||
title: Cameras
|
title: Cameras
|
||||||
title: "Sensors"
|
title: "Sensors"
|
||||||
- sections:
|
|
||||||
- local: torch_accelerators
|
|
||||||
title: PyTorch accelerators
|
|
||||||
title: "Supported Hardware"
|
|
||||||
- sections:
|
- sections:
|
||||||
- local: notebooks
|
- local: notebooks
|
||||||
title: Notebooks
|
title: Notebooks
|
||||||
@@ -157,6 +159,8 @@
|
|||||||
- sections:
|
- sections:
|
||||||
- local: contributing
|
- local: contributing
|
||||||
title: Contribute to LeRobot
|
title: Contribute to LeRobot
|
||||||
|
- local: contributing_a_policy
|
||||||
|
title: Contributing a Policy
|
||||||
- local: backwardcomp
|
- local: backwardcomp
|
||||||
title: Backward compatibility
|
title: Backward compatibility
|
||||||
title: "About"
|
title: "About"
|
||||||
|
|||||||
Reference in New Issue
Block a user