Skip to content
Merged
76 changes: 43 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,20 @@

# Argoverse 2 API

Official GitHub repository for the [Argoverse 2](https://www.argoverse.org) family of datasets.
> _Official_ GitHub repository for the [Argoverse 2](https://www.argoverse.org) family of datasets.

If you have any questions or run into any problems with either the data or API, please feel free to open a [GitHub issue](https://github.com/argoai/argoverse2-api/issues)!

## TL;DR

- Install the API: `pip install av2`
- Read the [instructions](DOWNLOAD.md) to download the data.

## Overview

- [Setup](#setup)
- [Usage](#usage)
- [Testing](#testing-automation)
- [Datasets](#datasets)
- [Testing](#testing)
- [Contributing](#contributing)
- [Citing](#citing)
- [License](#license)
Expand All @@ -27,45 +32,50 @@ The easiest way to install the API is via [pip](https://pypi.org/project/av2/) b
pip install av2
```

### Downloading the datasets
Please see [the Download README](DOWNLOAD.md) for detailed instructions on how to download each dataset.
### Datasets

The _Argoverse 2_ family consists of **four** distinct datasets:

### Argoverse 2 Sensor Dataset
| Dataset Name | Scenarios | Camera Imagery | Lidar| Maps | Additional Information|
| ---------------| --------: | :------------: | :--: | :--: | :--------------------:|
| Sensor | 1,000 | :white_check_mark: | :white_check_mark: | :white_check_mark: | [Sensor Dataset README](src/av2/datasets/sensor/README.md) |
| Lidar | 20,000 | | :white_check_mark: | :white_check_mark: | [Lidar Dataset README](src/av2/datasets/lidar/README.md) |
| Motion Forecasting | 250,000 | | | :white_check_mark: | [Motion Forecasting Dataset README](src/av2/datasets/motion_forecasting/README.md) |
| Map Change (Trust, but Verify) | 1,045 | :white_check_mark: | :white_check_mark: | :white_check_mark: | [Map Change Dataset README](src/av2/datasets/tbv/README.md) |

<p align="center">
Please see [DOWNLOAD.md](DOWNLOAD.md) for detailed instructions on how to download each dataset.

<div align="center">
<h4> <a href="src/av2/datasets/sensor/README.md"> Sensor Dataset </a> </h4>
<img src="https://user-images.githubusercontent.com/29715011/158742778-557f31a4-569d-44aa-a032-99836094dc97.gif" height="150">
<img src="https://user-images.githubusercontent.com/29715011/158742776-069501c4-8dd4-4f9d-ac8c-f0421f855607.gif" height="150">
<img src="https://user-images.githubusercontent.com/29715011/158739736-fe876299-23da-46ed-98ce-173f938d1702.gif" height="150">
<img src="https://user-images.githubusercontent.com/29715011/158739767-886e1c2f-4613-495d-9204-a7b4813af16d.gif" height="150">
</p>

Please refer to the [sensor dataset README](src/av2/datasets/sensor/README.md) for additional details.
</div>

### Argoverse 2 Lidar Dataset

<p align="center">
<div align="center">
<h4> <a href="src/av2/datasets/lidar/README.md"> Lidar Dataset </a> </h4>
<img src="https://user-images.githubusercontent.com/29715011/158715494-472339d1-a5d5-4d33-8fcf-3455c0d78d27.gif" height="150">
<img src="https://user-images.githubusercontent.com/29715011/158715496-f439ccad-71af-4880-8b43-ade7b6c8f333.gif" height="150">
<img src="https://user-images.githubusercontent.com/29715011/158715498-23d7a11f-12a1-4aeb-b9af-dbced217b340.gif" height="150">
<img src="https://user-images.githubusercontent.com/29715011/158715497-d1603423-c32f-4cf0-ab1e-6bbc9c458535.gif" height="150">
</p>

Please refer to the [lidar dataset README](src/av2/datasets/lidar/README.md) for additional details.
</div>

### Argoverse 2 Motion Forecasting Dataset

<p align="center">
<div align="center">
<h4> <a href="src/av2/datasets/motion_forecasting/README.md"> Motion Forecasting Dataset </a> </h4>
<img src="https://user-images.githubusercontent.com/29715011/158486284-1a0df794-ee0a-4ae6-a320-0dd0d1daad06.gif" height="150">
<img src="https://user-images.githubusercontent.com/29715011/158486286-e734e654-b879-4994-a129-9957cc591af4.gif" height="150">
<img src="https://user-images.githubusercontent.com/29715011/158486288-5e7c0971-de0c-4ff5-bea7-76f7922dd1e0.gif" height="150">
</p>


Please refer to the [motion forecasting dataset README](src/av2/datasets/motion_forecasting/README.md) for additional details.

### Argoverse 2 Map Change Dataset
</div>

Please refer to the map change dataset (known as the **Trust, but Verify Dataset**) [README](src/av2/datasets/tbv/README.md) for additional details.
<div align="center">
<h4> <a href="src/av2/datasets/tbv/README.md"> Map Change (Trust, but Verify) </a> </h4>
<img src="https://user-images.githubusercontent.com/29715011/159150544-93ed1b7e-242a-416e-ac01-e1df3ff9be8b.gif" height="150">
<img src="https://user-images.githubusercontent.com/29715011/159150539-e5d14886-4b5c-4e10-96e1-6fdf5696d430.gif" height="150">
<img src="https://user-images.githubusercontent.com/29715011/159152108-3c3001fe-ec7c-48fd-8c08-4a473affb2a3.gif" height="150">
<img src="https://user-images.githubusercontent.com/29715011/159152102-27c04180-9ca4-4725-be81-95ee6858d367.gif" height="150">
</div>

### Map API

Expand All @@ -74,11 +84,11 @@ raster maps that we employ across all AV2 datasets.

## Compatibility Matrix

| `Python Version` | `linux` | `macOS` | `windows` |
| ------------- | ----------------- | ------------------ | ------------------ |
| `3.8` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| `3.9` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| `3.10` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| `Python Version` | `linux` | `macOS` | `windows` |
| ------------- | :----------------: | :----------------: | :----------------: |
| `3.8` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `3.9` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `3.10` | :white_check_mark: | :white_check_mark: | :white_check_mark: |

## Testing

Expand All @@ -97,7 +107,7 @@ the open source community - please open a PR using the following [template](.git

## Citing

Please use the following citation when referencing the [Argoverse 2](https://datasets-benchmarks-proceedings.neurips.cc/paper/2021/file/4734ba6f3de83d861c3176a6273cac6d-Paper-round2.pdf) Sensor, Lidar, or Motion Forecasting Datasets:
Please use the following citation when referencing the [Argoverse 2](https://datasets-benchmarks-proceedings.neurips.cc/paper/2021/file/4734ba6f3de83d861c3176a6273cac6d-Paper-round2.pdf) _Sensor_, _Lidar_, or _Motion Forecasting_ Datasets:

```BibTeX
@INPROCEEDINGS { Argoverse2,
Expand All @@ -108,7 +118,7 @@ Please use the following citation when referencing the [Argoverse 2](https://dat
}
```

Use the following citation when referencing the [Argoverse 2](https://datasets-benchmarks-proceedings.neurips.cc/paper/2021/file/6f4922f45568161a8cdf4ad2299f6d23-Paper-round2.pdf) Map Change Dataset:
Use the following citation when referencing the [Argoverse 2](https://datasets-benchmarks-proceedings.neurips.cc/paper/2021/file/6f4922f45568161a8cdf4ad2299f6d23-Paper-round2.pdf) _Map Change_ Dataset:
```BibTeX
@INPROCEEDINGS { TrustButVerify,
author = {John Lambert and James Hays},
Expand All @@ -120,5 +130,5 @@ Use the following citation when referencing the [Argoverse 2](https://datasets-b

## License

All code provided within this repository is released under the MIT license and bound by the Argoverse terms of use,
All code provided within this repository is released under the **MIT license** and bound by the _Argoverse_ **terms of use**,
please see [LICENSE](LICENSE) and [NOTICE](NOTICE) for additional details.