Skip to content

docs(il_robots): update API examples and bash snippets from SO100 to SO101#3409

Draft
TaliesinYang wants to merge 2 commits intohuggingface:mainfrom
TaliesinYang:fix/3219-il-robots-api-example-so101
Draft

docs(il_robots): update API examples and bash snippets from SO100 to SO101#3409
TaliesinYang wants to merge 2 commits intohuggingface:mainfrom
TaliesinYang:fix/3219-il-robots-api-example-so101

Conversation

@TaliesinYang
Copy link
Copy Markdown

Summary

Addresses the SO100 / SO101 naming inconsistency half of #3219.

Inside docs/source/il_robots.mdx, bash commands and Python API examples previously mixed old SO100 class names with newer SO101 names. This PR makes the tutorial use SO101 consistently across every section where SO100/SO101 appear.

Scope (explicit)

This PR only addresses the naming inconsistency. It does not fix the "rerun.io visualization not showing data" part of #3219 — that root cause appears unrelated to class naming and warrants separate investigation. Issue #3219 should stay open for the visualization problem after this lands.

Refs #3219

Changes

All SO100 → SO101 renames in docs/source/il_robots.mdx:

  • Record a dataset (~line 207-237): Python API example — SO100Follower, SO100FollowerConfig, SO100Leader, SO100LeaderConfig → SO101 equivalents.
  • Replay an episode (~line 419-427): Python API example — same classes.
  • Run inference and evaluate your policy — Command (~line 518-529): bash args — so100_follower / eval_so100 / so100_leader → SO101.
  • Run inference and evaluate your policy — API example (~line 544-565): Python API example — same classes.

The SO101 classes (SO101Follower, SO101FollowerConfig, SO101Leader, SO101LeaderConfig) are already exported from lerobot.robots.so_follower and lerobot.teleoperators.so_leader.

Testing

Documentation-only change, no code paths affected. After the change:

```
$ grep -i so100 docs/source/il_robots.mdx
(no matches)
```

SO101 now appears uniformly where SO100 used to.

Notes

Keeping the PR as a draft for now — please convert to ready-for-review when you're happy with it.

TaliesinYang and others added 2 commits April 18, 2026 21:58
All bash commands in the il_robots tutorial use so101_follower and
so101_leader, but the Python API examples referenced SO100Follower,
SO100FollowerConfig, SO100Leader, and SO100LeaderConfig. Align the
Python examples to match the SO101 hardware used in the CLI examples.

Affected sections: Record a dataset, Replay an episode, Evaluate a policy.

Fixes huggingface#3219

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
Follow-up to the earlier commit: the Evaluate-a-policy section still had
so100_follower / eval_so100 / so100_leader in its bash snippet, which
re-introduced the same inconsistency the PR claims to fix. Replace all
three with their so101 equivalents so the section is internally
consistent with the paired Python API example.

Refs huggingface#3219

Co-Authored-By: Claude <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant