Suoivy commited on
Commit
809a409
Β·
verified Β·
1 Parent(s): 67a749b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +26 -24
README.md CHANGED
@@ -53,8 +53,8 @@ extra_gated_button_content: Submit
53
 
54
 
55
  # Key Features πŸ”‘
56
- - **1 million+** episodes of atomic tasks automatically generated by agents.
57
- - **1 million+** episodes of enhanced digital twins of long-horizon real-world tasks from Agibot World.
58
  - **180+ classes of objects**.
59
  - **5 classes of scenes**.
60
 
@@ -64,7 +64,7 @@ extra_gated_button_content: Submit
64
 
65
 
66
  # TODO List πŸ“…
67
- - [ ] **AgiBot Digital World Beta**: More high-quality simulation data, including atomic skill task data and digital twin-enhanced data aligned with tasks in Agibot World. (expected release date: Q2 2025)
68
  <!-- - [ ] **AgiBot Digital World FEEDBACK**: Data quality feedback and improvement. -->
69
 
70
 
@@ -88,15 +88,15 @@ git lfs install
88
 
89
  # When prompted for a password, use an access token with write permissions.
90
  # Generate one from your settings: https://huggingface.co/settings/tokens
91
- git clone https://huggingface.co/datasets/agibot-world/AgiBotDigitalWorld/tree/main
92
 
93
  # If you want to clone without large files - just their pointers
94
- GIT_LFS_SKIP_SMUDGE=1 git clone https://huggingface.co/datasets/agibot-world/AgiBotDigitalWorld/tree/main
95
  ```
96
 
97
- If you only want to download a specific task, such as `digitaltwin_5`, you can use the following code.
98
  ```
99
- # Make sure you have git-lfs installed (https://git-lfs.com)
100
  git lfs install
101
 
102
  # Initialize an empty Git repository
@@ -104,41 +104,43 @@ git init AgiBotDigitalWorld
104
  cd AgiBotDigitalWorld
105
 
106
  # Set the remote repository
107
- git remote add origin https://huggingface.co/datasets/agibot-world/AgiBotDigitalWorld/tree/main
108
 
109
  # Enable sparse-checkout
110
  git sparse-checkout init
111
 
112
- # Specify the folders and files
113
  git sparse-checkout set observations/digitaltwin_5 task_info/digitaltwin_5.json scripts proprio_stats parameters
114
 
115
- # Pull the data
116
  git pull origin main
 
117
  ```
118
 
119
- To facilitate the inspection of the dataset's internal structure and examples, we also provide a sample dataset. Please refer to `sample_dataset.tar`.
120
 
121
  ## Dataset Preprocessing
122
  Our project relies solely on the [lerobot library](https://github.com/huggingface/lerobot) (dataset `v2.0`), please follow their [installation instructions](https://github.com/huggingface/lerobot?tab=readme-ov-file#installation).
123
  Here, we provide scripts for converting it to the lerobot format.
124
 
 
125
  Requeir ffmpeg>=7.1(You can install with **conda install -y -c conda -forge ffmpeg**)
126
  ```
127
  export SVT_LOG=0
128
- python convert_to_lerobot.py β€”data_dir DATASET_FOLDER β€”save_dir SAVE_FOLDER --repo_id=agibot/agibotdigital --preprocess_video
129
 
130
  ## Example
131
- # python convert_to_lerobot.py --data_dir final_format_data --save_dir ./output --repo_id=agibot/agibotdigital --preprocess_video
132
 
133
  ```
134
- Visulization
135
  ```
136
- python visualize_dataset.py --repo-id='agibot/agibotdigital' --episode-index=0 --dataset-path=SAVE_FOLDER
137
 
138
  ## Example
139
- # python visualize_dataset.py --repo-id='agibot/agibotdigital'--episode-index=0 --dataset-path=output
140
  ```
141
- We would like to express our gratitude to the developers of lerobot for their outstanding contributions to the open-source community.
142
 
143
  ## Dataset Structure
144
  ### Folder hierarchy
@@ -159,30 +161,30 @@ data
159
  β”‚ β”‚ β”œβ”€β”€ edb0774b-13bb-4a8b-8bb0-71e82fe3ff6a
160
  β”‚ β”‚ β”‚ └── ...
161
  β”‚ └── ...
162
- β”œβ”€β”€ states
163
  β”‚ β”œβ”€β”€ digitaltwin_0 # This represents the task id.
164
  β”‚ β”‚ β”œβ”€β”€ 9b21cf2e-829f-4aad-9b61-9edc5b947163 # This represents the episode uuid.
165
  β”‚ β”‚ β”‚ β”œβ”€β”€ task_info.json # This represents the task information.
166
- β”‚ β”‚ β”‚ β”œβ”€β”€ proprio_states.h5 # This file contains all the robot's proprioceptive information.
167
  β”‚ β”‚ β”‚ β”œβ”€β”€ camera_parameter.json # This contains all the cameras' intrinsic and extrinsic parameters.
168
  β”‚ β”‚ β”œβ”€β”€ 131e407a-b828-4937-a554-e6706cbc5e2f
169
  β”‚ β”‚ β”‚ β”œβ”€β”€ task_info.json
170
- β”‚ β”‚ β”‚ β”œβ”€β”€ proprio_states.h5
171
  β”‚ β”‚ β”‚ β”œβ”€β”€ camera_parameter.json
172
  β”‚ β”‚ └── ...
173
  β”‚ └── digitaltwin_1
174
  β”‚ β”œβ”€β”€ 95808182-501f-4dca-984b-7404df844d31
175
  β”‚ β”‚ β”‚ β”œβ”€β”€ task_info.json
176
- β”‚ β”‚ β”‚ β”œβ”€β”€ proprio_states.h5
177
  β”‚ β”‚ β”‚ β”œβ”€β”€ camera_parameter.json
178
  β”‚ └── edb0774b-13bb-4a8b-8bb0-71e82fe3ff6a
179
  β”‚ β”‚ β”‚ β”œβ”€β”€ task_info.json
180
- β”‚ β”‚ β”‚ β”œβ”€β”€ proprio_states.h5
181
  β”‚ β”‚ β”‚ β”œβ”€β”€ camera_parameter.json
182
  | └── ...
183
  ```
184
  ### json file format
185
- In the `task_[id].json` file, we store the basic information of every episode along with the language instructions. Here, we will further explain several specific keywords.
186
  - **action_config**: The content corresponding to this key is a list composed of all **action slices** from the episode. Each action slice includes a start and end time, the corresponding atomic skill, and the language instruction.
187
  - **key_frame**: The content corresponding to this key consists of annotations for keyframes, including the start and end times of the keyframes and detailed descriptions.
188
 
@@ -352,7 +354,7 @@ All the data and code within this repo are under [CC BY-NC-SA 4.0](https://creat
352
 
353
  ```BibTeX
354
  @misc{contributors2025agibotworldrepo,
355
- title={AgiBot World Colosseum},
356
  author={AgiBot World Colosseum contributors},
357
  howpublished={\url{https://agibot-digitalworld.com/}},
358
  year={2025}
 
53
 
54
 
55
  # Key Features πŸ”‘
56
+ - **1 million+** steps of enhanced digital twins of long-horizon real-world tasks from Agibot World.
57
+ - **500,000+** steps of atomic tasks automatically generated by agents.
58
  - **180+ classes of objects**.
59
  - **5 classes of scenes**.
60
 
 
64
 
65
 
66
  # TODO List πŸ“…
67
+ - [ ] **AgiBot Digital World**: More high-quality simulation data, including atomic skill task data and digital twin-enhanced data aligned with tasks in Agibot World. (ongoing open source)
68
  <!-- - [ ] **AgiBot Digital World FEEDBACK**: Data quality feedback and improvement. -->
69
 
70
 
 
88
 
89
  # When prompted for a password, use an access token with write permissions.
90
  # Generate one from your settings: https://huggingface.co/settings/tokens
91
+ git clone https://huggingface.co/datasets/agibot-world/AgiBotDigitalWorld
92
 
93
  # If you want to clone without large files - just their pointers
94
+ GIT_LFS_SKIP_SMUDGE=1 git clone https://huggingface.co/datasets/agibot-world/AgiBotDigitalWorld
95
  ```
96
 
97
+ If you only want to download a specific task from the AgiBotDigitalWorld dataset, such as `digitaltwin_5`,follow these steps:.
98
  ```
99
+ # Ensure Git LFS is installed (https://git-lfs.com)
100
  git lfs install
101
 
102
  # Initialize an empty Git repository
 
104
  cd AgiBotDigitalWorld
105
 
106
  # Set the remote repository
107
+ git remote add origin https://huggingface.co/datasets/agibot-world/AgiBotDigitalWorld
108
 
109
  # Enable sparse-checkout
110
  git sparse-checkout init
111
 
112
+ # Specify the folders and files you want to download
113
  git sparse-checkout set observations/digitaltwin_5 task_info/digitaltwin_5.json scripts proprio_stats parameters
114
 
115
+ # Pull the data from the main branch
116
  git pull origin main
117
+
118
  ```
119
 
120
+ To facilitate the inspection of the dataset's internal structure and examples, we also provide a sample dataset. Please refer to `sample_dataset.zip`.
121
 
122
  ## Dataset Preprocessing
123
  Our project relies solely on the [lerobot library](https://github.com/huggingface/lerobot) (dataset `v2.0`), please follow their [installation instructions](https://github.com/huggingface/lerobot?tab=readme-ov-file#installation).
124
  Here, we provide scripts for converting it to the lerobot format.
125
 
126
+ ### Requirements
127
  Requeir ffmpeg>=7.1(You can install with **conda install -y -c conda -forge ffmpeg**)
128
  ```
129
  export SVT_LOG=0
130
+ python scripts/convert_to_lerobot.py --data_dir DATASET_FOLDER --save_dir SAVE_FOLDER --repo_id=agibot/agibotdigital --preprocess_video
131
 
132
  ## Example
133
+ # python scripts/convert_to_lerobot.py --data_dir final_format_data --save_dir ./output --repo_id=agibot/agibotdigital --preprocess_video
134
 
135
  ```
136
+ ### Visualization
137
  ```
138
+ python scripts/visualize_dataset.py --repo-id='agibot/agibotdigital' --episode-index=0 --dataset-path=SAVE_FOLDER
139
 
140
  ## Example
141
+ # python scripts/visualize_dataset.py --repo-id='agibot/agibotdigital'--episode-index=0 --dataset-path=output
142
  ```
143
+ We sincerely thank the developers of lerobot for their exceptional contributions to the open-source community..
144
 
145
  ## Dataset Structure
146
  ### Folder hierarchy
 
161
  β”‚ β”‚ β”œβ”€β”€ edb0774b-13bb-4a8b-8bb0-71e82fe3ff6a
162
  β”‚ β”‚ β”‚ └── ...
163
  β”‚ └── ...
164
+ β”œβ”€β”€ meta_info
165
  β”‚ β”œβ”€β”€ digitaltwin_0 # This represents the task id.
166
  β”‚ β”‚ β”œβ”€β”€ 9b21cf2e-829f-4aad-9b61-9edc5b947163 # This represents the episode uuid.
167
  β”‚ β”‚ β”‚ β”œβ”€β”€ task_info.json # This represents the task information.
168
+ β”‚ β”‚ β”‚ β”œβ”€β”€ proprio_meta_info.h5 # This file contains all the robot's proprioceptive information.
169
  β”‚ β”‚ β”‚ β”œβ”€β”€ camera_parameter.json # This contains all the cameras' intrinsic and extrinsic parameters.
170
  β”‚ β”‚ β”œβ”€β”€ 131e407a-b828-4937-a554-e6706cbc5e2f
171
  β”‚ β”‚ β”‚ β”œβ”€β”€ task_info.json
172
+ β”‚ β”‚ β”‚ β”œβ”€β”€ proprio_meta_info.h5
173
  β”‚ β”‚ β”‚ β”œβ”€β”€ camera_parameter.json
174
  β”‚ β”‚ └── ...
175
  β”‚ └── digitaltwin_1
176
  β”‚ β”œβ”€β”€ 95808182-501f-4dca-984b-7404df844d31
177
  β”‚ β”‚ β”‚ β”œβ”€β”€ task_info.json
178
+ β”‚ β”‚ β”‚ β”œβ”€β”€ proprio_meta_info.h5
179
  β”‚ β”‚ β”‚ β”œβ”€β”€ camera_parameter.json
180
  β”‚ └── edb0774b-13bb-4a8b-8bb0-71e82fe3ff6a
181
  β”‚ β”‚ β”‚ β”œβ”€β”€ task_info.json
182
+ β”‚ β”‚ β”‚ β”œβ”€β”€ proprio_meta_info.h5
183
  β”‚ β”‚ β”‚ β”œβ”€β”€ camera_parameter.json
184
  | └── ...
185
  ```
186
  ### json file format
187
+ In the `task_info.json` file, we store the basic information of every episode along with the language instructions. Here, we will further explain several specific keywords.
188
  - **action_config**: The content corresponding to this key is a list composed of all **action slices** from the episode. Each action slice includes a start and end time, the corresponding atomic skill, and the language instruction.
189
  - **key_frame**: The content corresponding to this key consists of annotations for keyframes, including the start and end times of the keyframes and detailed descriptions.
190
 
 
354
 
355
  ```BibTeX
356
  @misc{contributors2025agibotworldrepo,
357
+ title={AgiBot DigitalWorld},
358
  author={AgiBot World Colosseum contributors},
359
  howpublished={\url{https://agibot-digitalworld.com/}},
360
  year={2025}