Skip to content

Commit e2d731a

Browse files
kongchen1992meta-codesync[bot]
authored andcommitted
{Documentation} Add pilot dataset install download and tutorial
Summary: see title Reviewed By: YLouWashU Differential Revision: D84789178 fbshipit-source-id: 138b138f3cdb1e016f319983dc7b0a372724637f
1 parent 5c2b0ca commit e2d731a

File tree

6 files changed

+2676
-7
lines changed

6 files changed

+2676
-7
lines changed
Lines changed: 123 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,126 @@
11
---
22
sidebar_position: 2
3-
title: Download
3+
title: Download and Usage
44
---
5-
install and download
5+
import Tabs from '@theme/Tabs';
6+
import TabItem from '@theme/TabItem';
7+
8+
This page provides instructions for previewing, downloading, and installing the tools needed to work with the Aria Gen 2 Pilot Dataset.
9+
10+
## Preview the Dataset
11+
12+
Before downloading, you can explore the dataset using our interactive Dataset Explorer:
13+
14+
**🔗 [Dataset Explorer: https://explorer.projectaria.com/gen2pilot](https://explorer.projectaria.com/gen2pilot)**
15+
16+
### What You Can Preview
17+
18+
The Dataset Explorer provides:
19+
20+
- **MP4 Video Previews**: Watch video clips from RGB camera stream
21+
- **Interactive 3D Visualization**: Explore 30-second segments with [Rerun](https://rerun.io/) visualization showing:
22+
- Raw sensor data from all cameras
23+
- On-device machine perception outputs (VIO, eye gaze, hand tracking)
24+
- MPS results (3D trajectories, semi-dense point clouds)
25+
- Additional algorithm outputs (ASR, heart rate, depth, etc.)
26+
27+
This allows you to understand the data structure and quality before downloading the full dataset.
28+
29+
## Download the Dataset
30+
31+
### Via Dataset Explorer (Recommended)
32+
33+
1. Visit [https://explorer.projectaria.com/gen2pilot](https://explorer.projectaria.com/gen2pilot)
34+
2. Browse the available sequences
35+
3. Follow the download instructions provided on the explorer page
36+
4. Accept the license agreement and terms of use
37+
38+
The Dataset Explorer provides detailed instructions for downloading individual sequences or the entire dataset.
39+
40+
### Dataset Size
41+
42+
The complete Aria Gen 2 Pilot Dataset includes:
43+
- 12 sequences (4 participants per sequence)
44+
- Raw VRS files with all sensor streams
45+
- On-device machine perception outputs
46+
- Offline MPS results
47+
- Additional perception algorithm outputs (ASR, heart rate, depth, etc.)
48+
49+
Please ensure you have sufficient storage space before downloading.
50+
51+
## Install the Dataset Tools
52+
53+
To work with the Aria Gen 2 Pilot Dataset, install the `projectaria-gen2-pilot-dataset` Python package.
54+
55+
### System Requirements
56+
57+
- **Python**: 3.8 - 3.12 (Python 3.12 recommended)
58+
- **Operating Systems**:
59+
- Linux (x64): Fedora 40/41, Ubuntu 20.04/22.04 LTS
60+
- macOS (ARM64): macOS 14+ (Apple Silicon)
61+
- macOS (Intel): macOS 13+
62+
63+
### Installation Steps
64+
65+
<Tabs groupId="operating-systems">
66+
<TabItem value="unix" label="Linux & macOS">
67+
68+
```bash
69+
# Deactivate conda if active
70+
conda deactivate
71+
72+
# Remove existing environment if it exists
73+
rm -rf ~/projectaria_gen2_python_env
74+
75+
# Create new Python virtual environment
76+
python3.12 -m venv ~/projectaria_gen2_python_env
77+
78+
# Activate the environment
79+
source ~/projectaria_gen2_python_env/bin/activate
80+
81+
# Upgrade pip
82+
python3 -m pip install --upgrade pip
83+
84+
# Install the package with all dependencies
85+
python3 -m pip install 'projectaria-gen2-pilot-dataset[all]'
86+
```
87+
88+
</TabItem>
89+
</Tabs>
90+
91+
### What Gets Installed
92+
93+
The `projectaria-gen2-pilot-dataset[all]` package includes:
94+
95+
- **Core data loaders**: Access VRS files, MPS outputs, and algorithm results
96+
- **Visualization tools**: Rerun integration for 3D visualization
97+
- **All dependencies**: Including `projectaria-tools` for working with Aria data
98+
- **Tutorial notebooks**: Example code for loading and analyzing the dataset
99+
100+
### Verify Installation
101+
102+
After installation, verify it works by checking the package version:
103+
104+
```bash
105+
python3 -c "import projectaria_gen2_pilot_dataset"
106+
```
107+
108+
## Source Code
109+
110+
The dataset tools are open-source and available on GitHub:
111+
112+
**🔗 [GitHub Repository](https://github.com/facebookresearch/projectaria_gen2_pilot_dataset)**
113+
114+
You can:
115+
- View the source code
116+
- Report issues
117+
- Contribute improvements
118+
- Access example scripts and notebooks
119+
120+
## Dataset License
121+
122+
Please review and comply with the dataset license agreement available on the Dataset Explorer. By downloading and using this dataset, you agree to the terms of use.
123+
124+
## Citation
125+
126+
If you use the Aria Gen 2 Pilot Dataset in your research, please cite: To be updated.

website/docs-research-tools/dataset/pilot/loader-viz.mdx

Lines changed: 0 additions & 5 deletions
This file was deleted.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "Python Notebook Tutorials",
3+
"position": 3
4+
}

0 commit comments

Comments
 (0)