Skip to content

Commit

Permalink
{Documentation} Add Archive details and redirects
Browse files Browse the repository at this point in the history
Summary: Updates to headers, footers and redirecting users to Project Aria Tools as appropriate

Reviewed By: xiaqingp

Differential Revision: D48668767

fbshipit-source-id: e6038db49958f7e9e96c35eb25826416f99863a9
  • Loading branch information
Elizabeth Argall authored and facebook-github-bot committed Aug 25, 2023
1 parent 086a32a commit 536d2bc
Show file tree
Hide file tree
Showing 25 changed files with 123 additions and 51 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
# /!\ We are moving to a new repository /!\
This project is now deprecated, and moving to be hosted to [facebookresearch/projectaria_tools](https://github.com/facebookresearch/projectaria_tools/).

The [Aria Pilot Dataset documentation](https://facebookresearch.github.io/Aria_data_tools/docs/pilotdata/pilotdata-index/) will continue to be hosted in the Aria Data Tools wiki *in the short term* as it uses a different file structure compared to more recent Aria open data releases.

## About

Project Aria makes open data and open tooling available to support researchers expand the horizons of Augmented Reality, Machine Perception and Artificial Intelligence by releasing the Aria Pilot Dataset and Aria Research Kit: Aria Data Tools.
Expand Down
3 changes: 3 additions & 0 deletions website/docs/FAQ.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ title: FAQ
import useBaseUrl from '@docusaurus/useBaseUrl'

# FAQ
:::caution
This website is an archive of Project Aria's first open source initiative. It still provides specific tooling and documentation for the Aria Pilot Dataset, but to use the most up to date tooling, documentation and to find out about our other open datasets go to [Project Aria Tools](https://facebookresearch.github.io/projectaria_tools/docs/intro).
:::

## Installation
### How do I install Podman?
Expand Down
3 changes: 3 additions & 0 deletions website/docs/aria-vrs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ sidebar_position: 6
id: aria-vrs
title: How Project Aria Uses VRS
---
:::caution
This website is an archive of Project Aria's first open source initiative. It still provides specific tooling and documentation for the Aria Pilot Dataset. Go to [Aria VRS](https://facebookresearch.github.io/projectaria_tools/docs/data_formats/aria_vrs/aria_vrs_format) in Project Aria Tools for the latest VRS documentation and timestamp definitions.
:::

# **How Project Aria Uses VRS**

Expand Down
9 changes: 4 additions & 5 deletions website/docs/citation-contribute.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,14 @@ title: Citation and Contributing

# Citation and Contributing

## Aria Research Kit: Aria Data Tools and Aria Pilot Dataset White Paper
:::caution
This website is an archive of Project Aria's first open source initiative. Go to [Attribution and Contributing](https://facebookresearch.github.io/projectaria_tools/docs/attribution_citation) at Project Aria Tools for the latest citation details.
:::

While our emphasis for this release has been creating detailed documentation that can be navigated in a non-linear fashion, a white paper is in development. The white paper will cover many of the features documented, with more of an emphasis on mathematics and calculations, rather than code and tooling. The white paper will also provide more detail about the Project Aria device program.

Once the white paper is complete, it will be linked to on this page.

## Aria Data Tools

If you use Aria Data Tools in your research, please cite the Aria Data Tools website _https://facebookresearch.github.io/aria_data_tools_ or use the white paper when it is released.
If you use Aria Data Tools in your research, please cite the Aria Data Tools website _https://facebookresearch.github.io/aria_data_tools_.

If you use Aria Data Tools in GitHub, please consider starring ⭐ us and citing:

Expand Down
4 changes: 4 additions & 0 deletions website/docs/howto/MPS.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ title: Machine Perception Services

# Machine Perception Services

:::caution
These instructions are for Aria Data Tools, which is used for the Aria Pilot Dataset. If you are working with any other Aria data, we recommend using [Project Aria Tools](https://facebookresearch.github.io/projectaria_tools/docs/intro) instead. Go to [Aria Machine Perception Services](https://facebookresearch.github.io/projectaria_tools/docs/ARK/mps) in Project Aria Tools for more information and details about MPS.
:::

# Introduction

This page provides information on how to use Machine Perception Services (MPS) derived data with Aria Data Tools. Currently, this tooling is only available in C++.
Expand Down
4 changes: 4 additions & 0 deletions website/docs/howto/calibration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ id: calibration
title: Using Calibration Sensor Data
---
# Using Calibration Sensor Data

:::caution
These instructions are for using Aria Data Tools. We recommend using [Project Aria Tools](https://facebookresearch.github.io/projectaria_tools/docs/intro) instead, wherever possible. Go to the Project Aria Tools [Device Calibration page](https://facebookresearch.github.io/projectaria_tools/docs/tech_spec/device_calibration) for the most up to date information and tooling.
:::
## Introduction
This page covers:

Expand Down
5 changes: 5 additions & 0 deletions website/docs/howto/dataprovider.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ title: Accessing Sensor Data
---

# Accessing Project Aria Sensor Data

:::info
These instructions are for using Aria Data Tools. We recommend using [Project Aria Tools](https://facebookresearch.github.io/projectaria_tools/docs/intro) instead, wherever possible. Go to [Getting Started](https://facebookresearch.github.io/projectaria_tools/docs/data_utilities/getting_started) in Project Aria Tools for an introduction to Aria data utilities and using the most up to Aria Data provider.
:::

## Introduction

The Project Aria Data Provider provides a customized way to retrieve and read data from [VRS](aria-vrs.mdx) files in an intuitive and effective way.
Expand Down
3 changes: 3 additions & 0 deletions website/docs/howto/examples.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ title: Examples
---

# Examples
:::caution
These instructions are for Aria Data Tools. We recommend using [Project Aria Tools](https://facebookresearch.github.io/projectaria_tools/docs/intro) instead, wherever possible. It does not have the aria_multi_viewer utility for visualizing multiple time-synchronized recordings, but it is more up to date and will continue to be maintained. [Getting Started With Aria Data Utilities](https://facebookresearch.github.io/projectaria_tools/docs/data_utilities/getting_started) in Project Aria Tools includes Jupyter Notebook Tutorials that can be run locally, or on Google Colab.
:::

## Introduction
The Aria Research Kit: Aria Data Tools provides Python3 code and a C++ library to work with [VRS files](/aria-vrs.mdx).
Expand Down
5 changes: 5 additions & 0 deletions website/docs/howto/visualizing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ title: Visualize Sequences and Pre-Computed Camera Trajectory
import useBaseUrl from '@docusaurus/useBaseUrl'

# Visualize Sequences & Pre-Computed Camera Trajectory

:::caution
These instructions are for Aria Data Tools, which is used for the Aria Pilot Dataset. If you are working with any other Aria data, we recommend using [Project Aria Tools](https://facebookresearch.github.io/projectaria_tools/docs/intro) instead. Go to the [Visualization Guide](https://facebookresearch.github.io/projectaria_tools/docs/data_utilities/visualization_guide) in Project Aria Tools for the most recent information and tooling for visualizing Aria data.
:::

## Introduction

The AriaViewer allows users to visualize time-synced recordings for one or more Project Aria sequences. It has the ability to visualize recordings and see 3D visualizations of pre-computed trajectory using following time-synced data:
Expand Down
4 changes: 4 additions & 0 deletions website/docs/install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ sidebar_position: 2
id: Install
title: Install
---
:::info
These instructions will install Aria Data Tools. We recommend using [Project Aria Tools](https://facebookresearch.github.io/projectaria_tools/docs/intro) instead, wherever possible. It does not have the aria_multi_viewer utility for visualizing multiple time-synchronized recordings, but it is more up to date and will continue to be maintained. [Getting Started With Aria Data Utilities](https://facebookresearch.github.io/projectaria_tools/docs/data_utilities/getting_started) in Project Aria Tools includes Jupyter Notebook Tutorials that can be run locally, or on Google Colab.
:::

# Install

## What is it?
Expand Down
39 changes: 11 additions & 28 deletions website/docs/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,40 +1,25 @@
---
sidebar_position: 1
id: overview
title: Overview
title: About Aria Data Tools
---
# Overview

Project Aria makes open data and open tooling available to support researchers expand the horizons of Augmented Reality, Machine Perception and Artificial Intelligence by releasing the Aria Pilot Dataset and Aria Research Kit: Aria Data Tools.

On June 19 2022, Meta presented a tutorial at CVPR: [Towards always-on egocentric vision research using Meta’s Aria glasses](https://ariatutorial2022.github.io/), which went over Aria Data Tools and the Aria Pilot Dataset in detail.

## What is Project Aria?

[Project Aria](https://about.facebook.com/realitylabs/projectaria/) is a research device that collects first-person view (egocentric) data to accelerate machine perception and AI research for future AR glasses. Sensors on Project Aria capture egocentric video and audio, in addition to eye-gaze, inertial, and location information. On-device compute power is used to encrypt and store information that, when uploaded to separate designated back-end storage, helps researchers build the capabilities necessary for AR to work in the real world.

:::caution
Aria Data Tools is an archive of the original Aria open source tooling. Only use this for the Aria Pilot Dataset. Go to [Project Aria Tools](https://facebookresearch.github.io/projectaria_tools/docs/intro) if you're working with any other Aria data.
:::

![image of Project Aria device with sensor information](/img/Aria-technical-specs.jpeg)

Go to [Sensors & Measurements](/sensors-measurements.mdx) for more information about the data Project Aria sensors can collect.

## What is Aria Data Tools?

Aria Data Tools provides C++ and Python3 tools to interact with [Project Aria](https://about.facebook.com/realitylabs/projectaria/) data to:
# Overview

* Read and visualize Project Aria sequences and sensor data
* Retrieve calibration data and interact with Project Aria camera models
Aria Data Tools was [Project Aria's](https://www.projectaria.com/) first open source release, go to [projectaria.com](https://www.projectaria.com/) to find out about more recent open science initiatives and how to get involved.

These tools provide additional functions when used with the Aria Pilot Dataset’s derived data.
## Aria Data Tools

## What is the Aria Pilot Dataset?
Aria Data Tools was released on June 19 2022 for a tutorial at CVPR: [Towards always-on egocentric vision research using Meta’s Aria glasses](https://ariatutorial2022.github.io/). This repo was deprecated in June 2023 when [Project Aria Tools](https://facebookresearch.github.io/projectaria_tools/docs/intro) was released.

The Aria Pilot Dataset provides data from a variety of egocentric scenarios, including cooking, exercising, playing games and spending time with friends. This release also provides egocentric Project Aria data time synched with a multi-view camera recording rig. We believe these datasets can enable researchers to build and foster reproducible research on Computer Vision and AI/ML algorithms for scene perception, reconstruction and user surrounding understanding.
We recommend using [Project Aria Tools](https://facebookresearch.github.io/projectaria_tools/docs/intro) wherever possible. Project Aria Tools does not have Aria Data Tool's aria_multi_viewer utility for visualizing multiple time-synchronized recordings, but it is more up to date and will continue to be maintained. [Getting Started With Aria Data Utilities](https://facebookresearch.github.io/projectaria_tools/docs/data_utilities/getting_started) in Project Aria Tools includes Jupyter Notebook Tutorials that can be run locally, or on Google Colab.

Go to the [Project Aria website](https://about.facebook.com/realitylabs/projectaria/datasets) to access the Aria Pilot Dataset.
## Aria Pilot Dataset

## What is the Aria Research Kit?
The Aria Research Kit provides tooling, documentation and resources to support researchers participating in Project Aria. Aria Data Tools is one component of the Aria Research Kit. If you need access to the full Aria Research Kit, please fill out the [Project Aria: Partnership Interest Form](https://docs.google.com/forms/d/e/1FAIpQLSdA4Rba4nmsr18VkBcBCCwRnWLgBtX7KoCDH-uWfRdrBxTG1A/viewform).
[Aria Pilot Dataset documentation](/docs/pilotdata/pilotdata-index/) is stored in *Archive: Aria Data Tools*, because it was Project Aria's first open source initiative and it uses a different data structure compared to our latest open releases.

## Privacy

Expand All @@ -45,5 +30,3 @@ The Aria Research Kit provides tooling, documentation and resources to support r
## Contact

ProjectAriaDataset@fb.com

Meta is building an academic program to enable researchers to use Project Aria devices for academic research. Academic and industrial research institutions interested in participating in Project Aria can submit their proposals through the [Project Aria: Partnership Interest Form](https://docs.google.com/forms/d/e/1FAIpQLSdA4Rba4nmsr18VkBcBCCwRnWLgBtX7KoCDH-uWfRdrBxTG1A/viewform).
5 changes: 5 additions & 0 deletions website/docs/pilotdata/desk/desktop_overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ title: Desktop Activities Overview
import useBaseUrl from '@docusaurus/useBaseUrl'

# Desktop Activities Overview

:::caution
Aria Pilot Dataset documentation is stored in *Archive: Aria Data Tools*, because it was Project Aria's first open source initiative and it uses a different data structure compared to our latest open releases. For the most up to date tooling and to find out about our other open datasets go to [Project Aria Tools](https://facebookresearch.github.io/projectaria_tools/docs/intro).
:::

Desktop Activities recorded a single operator manipulating objects over a desktop space. Data was captured by the operator wearing a Project Aria device and by a multi-view motion capture system. Most of the objects manipulated were 10 commonly used objects from the [YCB Benchmark](https://www.ycbbenchmarks.com/) object set.

_Figure 1_ presents these objects with the corresponding YCB object indices. During recording, we also randomized the desktop appearance by placing non-YCB objects on the desk.
Expand Down
4 changes: 4 additions & 0 deletions website/docs/pilotdata/desk/desktop_setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ title: Desktop Activities Capture Setup
---
# Desktop Activities Capture Setup

:::caution
Aria Pilot Dataset documentation is stored in *Archive: Aria Data Tools*, because it was Project Aria's first open source initiative and it uses a different data structure compared to our latest open releases. For the most up to date tooling and to find out about our other open datasets go to [Project Aria Tools](https://facebookresearch.github.io/projectaria_tools/docs/intro).
:::

The Desktop Activities dataset was captured with a Project Aria device and a multi-view motion capture system.

## Hardware setup
Expand Down
4 changes: 4 additions & 0 deletions website/docs/pilotdata/everyday/activities.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ title: Activities
---
# Everyday Activities

:::caution
Aria Pilot Dataset documentation is stored in *Archive: Aria Data Tools*, because it was Project Aria's first open source initiative and it uses a different data structure compared to our latest open releases. For the most up to date tooling and to find out about our other open datasets go to [Project Aria Tools](https://facebookresearch.github.io/projectaria_tools/docs/intro).
:::

When creating recordings for one to two Project Aria device wearers, we created scripts to represent all day long activities with always on sensing. Each script contained multiple scenarios that told a story about people going through their day. The scripts provided general guidance for an improvised scenario. Actors did not have specific lines to learn, instead they followed prompts and went with what felt most natural to to them.


Expand Down
4 changes: 4 additions & 0 deletions website/docs/pilotdata/everyday/everyday.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ title: Everyday Activities File Structure

# Everyday Activities File Structure

:::caution
Aria Pilot Dataset documentation is stored in *Archive: Aria Data Tools*, because it was Project Aria's first open source initiative and it uses a different data structure compared to our latest open releases. For the most up to date tooling and to find out about our other open datasets go to [Project Aria Tools](https://facebookresearch.github.io/projectaria_tools/docs/intro).
:::

The Everyday Activities dataset contains multiple activity sequences for one to two Project Aria device users. We created recordings using scripts to represent all day activities with always on sensing.

Records for each location are stored in their own folder. Each location contains one or several script folders. The script folder contains a .csv file providing details about each sequence, as well as a folder for each sequence. Each sequence has one or several recording folders (one recording folder per Project Aria device wearer in the sequence).
Expand Down
4 changes: 4 additions & 0 deletions website/docs/pilotdata/everyday/scripts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ import useBaseUrl from '@docusaurus/useBaseUrl'

# Aria Wearer Data Scripts

:::caution
Aria Pilot Dataset documentation is stored in *Archive: Aria Data Tools*, because it was Project Aria's first open source initiative and it uses a different data structure compared to our latest open releases. For the most up to date tooling and to find out about our other open datasets go to [Project Aria Tools](https://facebookresearch.github.io/projectaria_tools/docs/intro).
:::

The following scripts were used by actors to collect data for Everyday Activities.

## Script 1: Lazy Morning Before the Party
Expand Down
4 changes: 4 additions & 0 deletions website/docs/pilotdata/everyday/sensor-profiles.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ title: Everyday Activities Sensor Profile

# Everyday Activities Sensor Profile

:::caution
Aria Pilot Dataset documentation is stored in *Archive: Aria Data Tools*, because it was Project Aria's first open source initiative and it uses a different data structure compared to our latest open releases. For the most up to date tooling and to find out about our other open datasets go to [Project Aria Tools](https://facebookresearch.github.io/projectaria_tools/docs/intro).
:::

Sensor profiles allow researchers to choose which sensors on the Project Aria device to use when collecting data. Sensor Profile 9 was used for the Everyday Activities dataset.

**Table 1:** *Everyday Activities Sensor Profile*
Expand Down
3 changes: 3 additions & 0 deletions website/docs/pilotdata/location-output.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ title: Location Output Data
---
import useBaseUrl from '@docusaurus/useBaseUrl'

:::caution
Aria Pilot Dataset documentation is stored in *Archive: Aria Data Tools*, because it was Project Aria's first open source initiative and it uses a different data structure compared to our latest open releases. For the most up to date tooling and to find out about our other open datasets go to [Project Aria Tools](https://facebookresearch.github.io/projectaria_tools/docs/intro).
:::

# Location Output Data

Expand Down
4 changes: 4 additions & 0 deletions website/docs/pilotdata/pilotdata-index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ title: Aria Pilot Dataset Overview
---
import useBaseUrl from '@docusaurus/useBaseUrl'

:::caution
Aria Pilot Dataset documentation is stored in *Archive: Aria Data Tools*, because it was Project Aria's first open source initiative and it uses a different data structure compared to our latest open releases. For the most up to date tooling and to find out about our other open datasets go to [Project Aria Tools](https://facebookresearch.github.io/projectaria_tools/docs/intro).
:::

# Aria Pilot Dataset Overview

The Aria Pilot dataset is the first open dataset captured using [Project Aria](https://about.facebook.com/realitylabs/projectaria/), Meta’s research device used for accelerating machine perception and AI research, developed at Reality-Labs Research.
Expand Down
4 changes: 4 additions & 0 deletions website/docs/pilotdata/reprojected-gaze.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ title: Eye Gaze Data
---
import useBaseUrl from '@docusaurus/useBaseUrl'

:::caution
Aria Pilot Dataset documentation is stored in *Archive: Aria Data Tools*, because it was Project Aria's first open source initiative and it uses a different data structure compared to our latest open releases. For the most up to date tooling and to find out about our other open datasets go to [Project Aria Tools](https://facebookresearch.github.io/projectaria_tools/docs/intro).
:::

# Eye Gaze Data

Eye Gaze derived data uses data from Project Aria devices’ eye tracking cameras to estimate where the user is looking. Data from the eye tracking cameras are used to estimate a vector expressing the gaze direction. That vector is translated into a 2D pixel coordinate on the 120 degree FOV RGB camera image.
Expand Down
3 changes: 3 additions & 0 deletions website/docs/pilotdata/speech2text.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ sidebar_position: 5
id: speech2text
title: Speech2Text Output Data
---
:::caution
Aria Pilot Dataset documentation is stored in *Archive: Aria Data Tools*, because it was Project Aria's first open source initiative and it uses a different data structure compared to our latest open releases. For the most up to date tooling and to find out about our other open datasets go to [Project Aria Tools](https://facebookresearch.github.io/projectaria_tools/docs/intro).
:::

# Speech2Text Output Data

Expand Down

0 comments on commit 536d2bc

Please sign in to comment.