AV2 API v0.1.0 release

.darglint

@@ -0,0 +1,3 @@
+# .darglint
+[darglint]
+strictness = short

.github/pull_request_template.md

@@ -0,0 +1,21 @@
+## PR Summary
+<!-- Authors: Add a description immediately below this line, explaining what was done and why it was done, and check the applicable boxes below. -->
+
+## Testing
+<!-- Authors: Add testing details here, explaining your overall strategy, and check the applicable boxes below. -->
+
+In order to ensure this PR works as intended, it is:
+
+* [ ] unit tested.
+* [ ] other or not applicable (*additional detail/rationale required*)
+
+## Compliance with Standards
+<!-- Authors: Check each item below to certify that this PR is ready for review. -->
+
+As the author, I certify that this PR conforms to the following standards:
+
+* [ ] Code changes conform to [PEP8](https://www.python.org/dev/peps/pep-0008) and docstrings conform to the Google Python [style guide](https://google.github.io/styleguide/pyguide.html?showone=Comments#38-comments-and-docstrings).
+* [ ] A well-written summary explains what was done and why it was done.
+* [ ] The PR is adequately tested and the testing details and links to external results are included.
+
+<!-- Authors: If this PR is not ready for review, please create a "Draft Pull Request" using the dropdown below. -->

.github/workflows/ci.yml

@@ -0,0 +1,46 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test_and_build:
+    name: ${{ matrix.os }}_${{ matrix.venv_backend }}_py${{ matrix.python_version }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [macos-latest, ubuntu-latest, windows-latest]
+        python_version:
+          ["3.8", "3.9", "3.10"]
+        venv_backend:
+          ["virtualenv", "mamba"]  # Testing two different resolvers (pip, mamba).
+    defaults:
+      run:
+        shell: bash -l {0}
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: conda-incubator/setup-miniconda@v2
+        with:
+          mamba-version: "*"
+          miniforge-version: latest
+          python-version: ${{ matrix.python_version }}
+
+      - name: Install prerequisites.
+        run: |
+          mamba install -y nox pip pyyaml
+
+      - name: Run nox with ${{ matrix.venv_backend }}.
+        run: |  # Cache the environments (-r), fail on missing python interpreters (--error-on-missing-interpreters), set dependency resolver backend.
+          python -m nox -r --error-on-missing-interpreters --python ${{ matrix.python_version }} --default-venv-backend ${{ matrix.venv_backend }}
+
+      - name: Build wheels.
+        if: ${{ matrix.python_version }} == "virtualenv"
+        run: |
+          python -m pip wheel --wheel-dir=/tmp/wheelhouse .
+          
+      - name: Publish package to PyPI.
+        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -0,0 +1,158 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+*.pkl
+
+.vscode/
+outputs/
+condaenv*
+
+/data/
+
+*.jpg
+*.png
+*.svg
+
+.DS_Store
+*/**/.DS_Store
+experiments
+
+*.parquet
+*.pt
+*.mp4

.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+-   repo: local
+    hooks:
+    -   id: nox
+        name: Run nox.
+        language: python
+        entry: nox -rs black isort mypy
+        pass_filenames: false

CITATION.cff

@@ -0,0 +1,65 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+authors:
+- family-names: "Wilson"
+  given-names: "Benjamin"
+- family-names: "Qi"
+  given-names: "William"
+- family-names: "Agarwal"
+  given-names: "Tanmay"
+- family-names: "Lambert"
+  given-names: "John"
+- family-names: "Singh"
+  given-names: "Jagjeet"
+- family-names: "Khandelwal"
+  given-names: "Siddhesh"
+- family-names: "Pan"
+  given-names: "Bowen"
+- family-names: "Kumar"
+  given-names: "Ratnesh"
+- family-names: "Hartnett"
+  given-names: "Andrew"
+- family-names: "Pontes"
+  given-names: "Jhony Kaesemodel"
+- family-names: "Ramanan"
+  given-names: "Deva"
+- family-names: "Carr"
+  given-names: "Peter"
+- family-names: "Hays"
+  given-names: "James"
+title: "Argoverse 2 API"
+version: 1.0.0
+date-released: 2022-03-15
+url: "https://github.com/argoai/argoverse2-api/"
+preferred-citation:
+  type: conference-paper
+  authors:
+  - family-names: "Wilson"
+    given-names: "Benjamin"
+  - family-names: "Qi"
+    given-names: "William"
+  - family-names: "Agarwal"
+    given-names: "Tanmay"
+  - family-names: "Lambert"
+    given-names: "John"
+  - family-names: "Singh"
+    given-names: "Jagjeet"
+  - family-names: "Khandelwal"
+    given-names: "Siddhesh"
+  - family-names: "Pan"
+    given-names: "Bowen"
+  - family-names: "Kumar"
+    given-names: "Ratnesh"
+  - family-names: "Hartnett"
+    given-names: "Andrew"
+  - family-names: "Pontes"
+    given-names: "Jhony Kaesemodel"
+  - family-names: "Ramanan"
+    given-names: "Deva"
+  - family-names: "Carr"
+    given-names: "Peter"
+  - family-names: "Hays"
+    given-names: "James"
+  conference:
+    name: "NeurIPS 2021"
+  title: "Argoverse 2: Next Generation Datasets for Self-Driving Perception and Forecasting"

DOWNLOAD.md

@@ -0,0 +1,38 @@
+# Downloading the Argoverse 2 Datasets
+Our datasets are available for download from [AWS S3](https://aws.amazon.com/s3/). For the best experience, we highly recommend using the open-source [s5cmd](https://github.com/peak/s5cmd) tool to transfer the data to your local filesystem (additional info available [here](https://aws.amazon.com/blogs/opensource/parallelizing-s3-workloads-s5cmd/)). Please note that an AWS account is not required to download the datasets.
+
+### Installing `s5cmd`
+
+`s5cmd` can be easily installed with the following script:
+
+```bash
+#!/usr/bin/env bash
+
+export INSTALL_DIR=$HOME/.local/bin
+export PATH=$PATH:$INSTALL_DIR
+export S5CMD_URI=https://github.com/peak/s5cmd/releases/download/v1.4.0/s5cmd_1.4.0_$(uname | sed 's/Darwin/macOS/g')-64bit.tar.gz
+
+mkdir -p $INSTALL_DIR
+curl -sL $S5CMD_URI | tar -C $INSTALL_DIR -xvzf - s5cmd
+```
+
+Note that it will install `s5cmd` in your local bin directory. You can always change the path if you prefer installing it in another directory.
+
+### Downloading Datasets
+Once `s5cmd` is installed installed, downloading a dataset is as easy as running the following (using the sensor dataset as an example):
+
+```bash
+s5cmd --no-sign-request cp s3://argoai-argoverse/av2/sensor/* target-directory
+```
+
+The command will download all S3 objects to the target directory (for example, `target-directory` can be `/home/av2/sensors/`). Given the size of the dataset, it might take a couple of hours depending on the network connectivity.
+
+When the download is finished, the dataset is ready to use!
+
+### Dataset S3 Locations
+```bash
+s3://argoai-argoverse/av2/sensor/
+s3://argoai-argoverse/av2/lidar/
+s3://argoai-argoverse/av2/motion-forecasting/
+s3://argoai-argoverse/av2/tbv/
+```

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Argo AI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.