Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kpertsch committed Mar 16, 2024
1 parent 5bbbb67 commit 7aa8f5f
Showing 1 changed file with 22 additions and 21 deletions.
43 changes: 22 additions & 21 deletions docs/the-droid-dataset.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,36 +31,16 @@ gsutil -m cp -r gs://gresearch/robotics/droid_100 <path_to_your_target_dir>
gsutil -m cp -r gs://gresearch/robotics/droid_raw <path_to_your_target_dir>
```


### Accessing RLDS Dataset

We provide a [Dataset Colab](https://colab.research.google.com/drive/1b4PPH4XGht4Jve2xPKMCh-AXXAQziNQa?usp=sharing) that walks you through the process of loading and visualizing a few samples from the DROID dataset.

We also provide an example of a "training-ready" data loader that allows for efficient loading of DROID data for policy training (in PyTorch and JAX), including parallelized loading, normalization and augmentation in our [policy learning repo](https://github.com/droid-dataset/droid_policy_learning/blob/master/examples/droid_dataloader.py).

### Accessing Raw Data

You can download the raw DROID data using the gsutil command listed above. It contains full-HD stereo videos for all three cameras, alongside with all other information contained in the RLDS dataset. Concretely, each episode folder contains the following information:
```
episode:
|
|---- metadata_*.json: Episode metadata like building ID, data collector ID etc.
|---- trajectory.h5: All low-dimensional information like action and proprioception trajectories.
|---- recordings:
|
|---- MP4:
| |
| |---- *.mp4: High-res video of single (left) camera view.
| |---- *-stereo.mp4: High-res video of concatenated stereo camera views.
|
|---- SVO:
|
|---- *.svo: Raw ZED SVO file with encoded camera recording information (contains some additional metadata)
```

## 📝 Dataset Schema

The following fields are contained in every RLDS episode:
```python
DROID = {
"episode_metadata": {
Expand Down Expand Up @@ -98,5 +78,26 @@ DROID = {
}
```

### Accessing Raw Data

You can download the raw DROID data using the gsutil command listed above. It contains full-HD stereo videos for all three cameras, alongside with all other information contained in the RLDS dataset. Concretely, each episode folder contains the following information:
```
episode:
|
|---- metadata_*.json: Episode metadata like building ID, data collector ID etc.
|---- trajectory.h5: All low-dimensional information like action and proprioception trajectories.
|---- recordings:
|
|---- MP4:
| |
| |---- *.mp4: High-res video of single (left) camera view.
| |---- *-stereo.mp4: High-res video of concatenated stereo camera views.
|
|---- SVO:
|
|---- *.svo: Raw ZED SVO file with encoded camera recording information (contains some additional metadata)
```

## 📄 Data Analysis and Further Information
Please consult the [paper](https://droid-dataset.github.io/paper.pdf) for detailed data analysis and further information about the dataset.

0 comments on commit 7aa8f5f

Please sign in to comment.