diff --git a/README.md b/README.md index 4858de13..9078eada 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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) | -

+Please see [DOWNLOAD.md](DOWNLOAD.md) for detailed instructions on how to download each dataset. + +

+

Sensor Dataset

-

- -Please refer to the [sensor dataset README](src/av2/datasets/sensor/README.md) for additional details. +
-### Argoverse 2 Lidar Dataset - -

+

+

Lidar Dataset

-

- -Please refer to the [lidar dataset README](src/av2/datasets/lidar/README.md) for additional details. +
-### Argoverse 2 Motion Forecasting Dataset -

+

+

Motion Forecasting Dataset

-

- - -Please refer to the [motion forecasting dataset README](src/av2/datasets/motion_forecasting/README.md) for additional details. - -### Argoverse 2 Map Change Dataset +
-Please refer to the map change dataset (known as the **Trust, but Verify Dataset**) [README](src/av2/datasets/tbv/README.md) for additional details. +
+

Map Change (Trust, but Verify)

+ + + + +
### Map API @@ -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 @@ -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, @@ -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}, @@ -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.