📚 update README (#80)

This commit is contained in:
Qizhi Chen
2026-01-05 15:23:22 +08:00
committed by GitHub
parent 3ceef3bef1
commit 8dae4c5c56
4 changed files with 4 additions and 18 deletions
+1 -1
View File
@@ -35,7 +35,7 @@ Dataset Structure of `meta/info.json`:
```json
{
"codebase_version": "v2.1", // lastest lerobot format
"codebase_version": "v3.0", // lastest lerobot format
"robot_type": "a2d", // specific robot type
"fps": 30, // control frequency
"features": {
+1 -1
View File
@@ -14,7 +14,7 @@ Dataset Structure of `meta/info.json`:
```json
{
"codebase_version": "v2.1", // lastest lerobot format
"codebase_version": "v3.0", // lastest lerobot format
"robot_type": "franka", // specific robot type
"fps": 20, // control frequency
"features": {
+1 -15
View File
@@ -15,7 +15,7 @@ Dataset Structure of `meta/info.json`:
```json
{
"codebase_version": "v2.1", // lastest lerobot format
"codebase_version": "v3.0", // lastest lerobot format
"robot_type": "franka", // specific robot type, unknown if not provided
"fps": 3, // control frequency, 10 if not provided
// will add an additional key "control_frequency"
@@ -70,20 +70,6 @@ Dataset Structure of `meta/info.json`:
## Get started
> [!IMPORTANT]
> 1.for `bc_z` dataset, modify `encode_video_frames()` in `src/lerobot/datasets/video_utils.py`.
>
> ```python
> # add the following content to line 141:
> vf: str = "pad=ceil(iw/2)*2:ceil(ih/2)*2",
> # Add the following content to line 171:
> ffmpeg_args["-vf"] = vf
> ```
> [!TIP]
> We recommend using `libsvtav1` as the vcodec for ffmpeg when encoding videos during dataset conversion. If you can't use libsvtav1 after installing lerobot, you need to compile it yourself. Follow this [link](https://trac.ffmpeg.org/wiki/CompilationGuide) for detailed compilation instructions.
1. Download source code:
```bash
+1 -1
View File
@@ -41,7 +41,7 @@ Dataset Structure of `meta/info.json`:
```json
{
"codebase_version": "v2.1", // lastest lerobot format
"codebase_version": "v3.0", // lastest lerobot format
"robot_type": "franka_3rgb", // specific robot type
"fps": 30, // control frequency
"features": {