Docs: rewrite install guide and make lerobot a required dependency#227
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates EmbodiChain’s installation documentation and makes lerobot a core dependency so users no longer need to opt into it via extras.
Changes:
- Move
lerobotfrom an optional extra into the maindependencieslist. - Rewrite
docs/source/quick_start/install.mdto present system requirements as a table and restructure installation into Docker/pip/source flows. - Update verification instructions and remove references to
embodichain[lerobot].
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| pyproject.toml | Adds lerobot>=0.4.4 to core dependencies and removes the lerobot optional extra. |
| docs/source/quick_start/install.md | Restructures and modernizes the install guide, removing lerobot-extras install paths. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| > [!NOTE] | ||
| > Ensure your NVIDIA driver is compatible with your chosen PyTorch wheel. We recommend installing PyTorch from the [official PyTorch instructions](https://pytorch.org/get-started/locally/) for your CUDA version. |
There was a problem hiding this comment.
The GitHub-flavored admonition syntax (> [!NOTE], > [!TIP]) isn’t supported by MyST/Sphinx by default, so these will likely render as plain blockquotes in the built docs. Consider switching to MyST admonitions (e.g., :::{note} / :::{tip} with the existing colon_fence + html_admonition extensions) so they render correctly.
| ### pip (PyPI) | ||
|
|
||
| > **We strongly recommend using a virtual environment to avoid dependency conflicts.** | ||
|
|
||
| To install EmbodiChain from pypi, run: | ||
| > [!TIP] | ||
| > We strongly recommend using a virtual environment to avoid dependency conflicts. | ||
|
|
||
| ```bash | ||
| pip install embodichain --extra-index-url http://pyp.open3dv.site:2345/simple/ --trusted-host pyp.open3dv.site | ||
|
|
||
| # Or install with the lerobot extras: | ||
| pip install embodichain[lerobot] --extra-index-url http://pyp.open3dv.site:2345/simple/ --trusted-host pyp.open3dv.site | ||
| ``` |
There was a problem hiding this comment.
This section is labeled “pip (PyPI)”, but the command installs from an additional index (--extra-index-url http://pyp.open3dv.site:2345/simple/). Either rename this section to avoid implying the install is from PyPI only, or add a brief note explaining why the extra index is required.
| ```bash | ||
| pip install embodichain --extra-index-url http://pyp.open3dv.site:2345/simple/ --trusted-host pyp.open3dv.site | ||
|
|
||
| # Or install with the lerobot extras: | ||
| pip install embodichain[lerobot] --extra-index-url http://pyp.open3dv.site:2345/simple/ --trusted-host pyp.open3dv.site | ||
| ``` |
There was a problem hiding this comment.
The additional package index is referenced over plain HTTP. If this host supports HTTPS, it’s safer to use it to reduce MITM risk when installing dependencies; otherwise consider documenting why HTTP is necessary and what trust assumptions users are making.
| [project.optional-dependencies] | ||
| lerobot = [ | ||
| "lerobot==0.4.4" | ||
| ] | ||
|
|
There was a problem hiding this comment.
[project.optional-dependencies] is now empty after moving lerobot into core dependencies. Consider removing the empty table to avoid suggesting there are supported extras when there aren’t any.
Description
This PR rewrites the installation documentation and moves
lerobotfrom an optional to a required dependency.Documentation changes (
docs/source/quick_start/install.md):> [!NOTE],> [!TIP]) for important calloutslerobotextras references from install commands (no longer needed since it's now required)Dependency changes (
pyproject.toml):lerobot>=0.4.4from[project.optional-dependencies]to the maindependencieslistType of change
Checklist
black .command to format the code base.🤖 Generated with Claude Code