Skip to content

Update README files to add new features and improve clarity #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
liu-xuecheng merged 1 commit into from
Nov 28, 2025
Merged

Update README files to add new features and improve clarity #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
- [Discover and Download Datasets](#discover-and-download-datasets)
- [Load a Dataset](#load-a-dataset)
- [Lerobot features explanation](#lerobot-features-explanation)
- [`observation.state` / `action`](#observationstate--action)
- [`eef_sim_pose_state` / `eef_sim_pose_action`](#eef_sim_pose_state--eef_sim_pose_action)
- [Upcoming Highlights](#upcoming-highlights)
- [Robot Control](#robot-control)
- [Robot Script Structure](#robot-script-structure)
Expand Down Expand Up @@ -346,10 +348,10 @@ Inheritance relationship, taking Realman as example:
graph LR
A[BaseRobotConfig] --> B[RealmanConfig]
A --> C[RealmanEndEffectorConfig]
D[BiBaseRobotConfig] --> E[BiRealmanConfig]
D --> F[BiRealmanEndEffectorConfig]
C --> F
A --> D
A --> D[BiBaseRobotConfig]
D --> E[BiRealmanConfig]
C --> F[BiRealmanEndEffectorConfig]
D --> F
```

Taking Realman as example, located at `src/lerobot/robots/realman/configuration_realman.py`：
Expand Down
12 changes: 7 additions & 5 deletions README_zh-CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@
- [数据集检索、下载与加载](#数据集检索下载与加载)
- [检索和下载数据集](#检索和下载数据集)
- [加载数据集](#加载数据集)
- [lerobot features说明](#lerobot-features说明)
- [lerobot-features说明](#lerobot-features说明)
- [`observation.state` / `action` feature](#observationstate--action-feature)
- [`eef_sim_pose_state`/`eef_sim_pose_action`](#eef_sim_pose_stateeef_sim_pose_action)
- [重点预告](#重点预告)
- [机器人控制逻辑](#机器人控制逻辑)
- [机器人目录结构](#机器人目录结构)
Expand Down Expand Up @@ -336,10 +338,10 @@ class BiBaseRobotEndEffectorConfig(BiBaseRobotConfig, BaseRobotEndEffectorConfig
graph LR
A[BaseRobotConfig] --> B[RealmanConfig]
A --> C[RealmanEndEffectorConfig]
D[BiBaseRobotConfig] --> E[BiRealmanConfig]
D --> F[BiRealmanEndEffectorConfig]
C --> F
A --> D
A --> D[BiBaseRobotConfig]
D --> E[BiRealmanConfig]
C --> F[BiRealmanEndEffectorConfig]
D --> F
```

以Realman为例，位于`src/lerobot/robots/realman/configuration_realman.py`：
Expand Down
Loading