Argoverse 1.0

Author: mgilson-argo

.gitattributes

@@ -0,0 +1,6 @@
+demo_usage/* linguist-vendored
+test_data/* linguist-vendored
+*.md linguist-vendored
+*.ini linguist-vendored
+*.in linguist-vendored
+*.yml linguist-vendored

.gitignore

@@ -0,0 +1,39 @@
+# Ignoring data files #
+#######################
+*.pkl
+*.npy
+
+# We'll ignore all of the following:
+
+dist/*
+
+.DS_Store
+.idea
+map_files/*
+*.jpg
+!/images/*.jpg
+!/docs/_images/*.jpg
+*.pyc
+city_archive.json
+.mypy_cache
+.coverage
+htmlcov
+
+utils/__pycache__/*
+prediction/__pycache__/*
+map_files/__pycache__/*
+top_k_prediction/__pycache__/*
+argoverse.egg-info/top_level.txt
+argoverse.egg-info/SOURCES.txt
+argoverse.egg-info/requires.txt
+argoverse.egg-info/PKG-INFO
+argoverse.egg-info/dependency_links.txt
+*.egg
+*.log
+.tox/*
+tests/test_data/tmp
+._map_files
+.eggs/
+/sphinx/source
+/docs/.buildinfo
+/docs/_sources

.pre-commit-config.yaml

@@ -0,0 +1,21 @@
+fail_fast: false
+
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks.git
+    rev: 0b70e28
+    hooks:
+    - id: check-json
+    - id: mixed-line-ending
+      args: ['--fix=lf']
+    - id: end-of-file-fixer
+    - id: debug-statements
+-   repo: https://github.com/pre-commit/mirrors-isort.git
+    rev: dc9ed97
+    hooks:
+    - id: isort
+      args: ["-w", "120", "--multi-line=3", "--trailing-comma", "--force-grid-wrap=0", "--use-parentheses"]
+-   repo: https://github.com/python/black.git
+    rev: 1bbb01b
+    hooks:
+    - id: black
+      args: ["-l", "120"]

.travis.yml

@@ -0,0 +1,26 @@
+language: python
+python:
+    - 3.6
+
+before_install:
+    - sudo apt-get update
+
+    - wget https://repo.continuum.io/miniconda/Miniconda2-latest-Linux-x86_64.sh -O miniconda.sh;
+    - bash miniconda.sh -b -p $HOME/miniconda
+    - export PATH="$HOME/miniconda/bin:$PATH"
+    - conda update --yes conda
+    - conda config --add channels conda-forge
+install:
+    - conda install --yes python=$TRAVIS_PYTHON_VERSION pip numpy scipy matplotlib
+    #- pip install -r requirements.txt
+
+# command to run tests
+script:
+    - if [[ $TRAVIS_PYTHON_VERSION == '3.6' ]]; then pytest tests/*; fi
+
+notifications:
+    email:
+        recipients:
+            - psangkloy@argo.ai
+        on_success: change
+        on_failure: change

Argoverse-Terms_of_Use.txt

@@ -0,0 +1,28 @@
+Terms of Use 
+ 
+Argo AI, LLC, and its affiliates (“Argo”) strive to promote future development in the field of self-driving cars. Using its autonomous vehicles, Argo collected, annotated and organized videos, maps and lidar data in a dataset (the “Argoverse”). By using or downloading the Argoverse, you are agreeing to comply with the terms of this page and any licensing terms referenced below.
+
+License - Data and Documentation.  Argoverse and any associated data or documentation are provided free of charge under the terms of the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Public License (“CC BY-NC-SA 4.0”). The full text of the license is accessible at https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode.  
+
+License - Code and Documentation.  Argoverse code and APIs are licensed under the MIT license, the full text of which can be found at https://opensource.org/licenses/MIT.
+Using Argoverse Non-Commercially.  We license Argoverse data and documents for non-commercial use only.  Under the terms of the CC BY-NC-SA 4.0 “non-commercial” means “not primarily intended for or directed towards commercial advantage or monetary compensation.” To assist you in determining whether your contemplated use is non-commercial, we make available the following examples:
+
+Example 1, Acceptable Use: 
+You are a researcher at an academic institution, working on computer vision and prediction. You use the Argoverse dataset to further your research and publish results based on the Argoverse benchmark. Your published paper includes imagery and figures derived from the Argoverse dataset. The imagery and figures are attributed to Argo and a hyperlink to the text of the CC-BY-NC-SA 4.0 license is provided.
+
+Example 2, Acceptable Use:
+You are a researcher at an AV company. You are submitting your image-based pose estimation algorithm to a major conference for public review. You use the Argoverse dataset to train and evaluate your method. You publish the results of the comparison publicly. The Argoverse data in your paper is attributed in accordance with the CC-BY-NC-SA 4.0 license.
+
+Example 3, Unacceptable Use:
+You are an engineer at an AV company. You use the Argoverse dataset to train a prototype detection model for use on your company’s AV at a test track. You use this prototype detection model as a placeholder until you build a large enough internal dataset to train your model against.
+
+Example 4, Unacceptable Use:
+You are an engineer at a company that produces a robotics platform for sale. You train the prediction and detection machine learning model in your company’s product on data from the Argoverse dataset. Your company releases the product for sale with the model you trained against Argoverse data.
+
+Suggestions:  If you use Argoverse and identify areas that could benefit from changes, we would like to hear from you. Please submit any comments on the issues page of our GitHub repository. If you submit your changes, you may be required to confirm that your changes are subject to CC BY-NC-SA 4.0.
+
+Attribution.  Please follow the attribution guidelines provided in section 3.A. of CC-BY-NC-SA 4.0 license with the copyright notice being “© 2018-2019 Argo AI, LLC”. APIs attribution shall comply with the MIT license.
+
+Privacy.  Argo takes steps to protect the privacy of individuals in Argoverse imagery by blurring faces and license plates. If you notice that your face or licence plate is still identifiable, or if you have any privacy concerns pertaining to Argoverse, please submit a request here: https://www.argoverse.org/about.html#privacy.  
+
+Marketing.  You may not use Argo’s trademark, logo, or name without Argo’s express written permission in connection with Argoverse.

CONTRIBUTING.md

@@ -0,0 +1,39 @@
+# Contributing to Argoverse
+
+Contributions to Argoverse are welcomed!  If you find a bug please open an issue on the github page describing the problem with steps to reproduce.  Better yet, if you figure out a fix, please open a pull request!
+
+To open a pull request here are some steps to get you started:
+
+- [Fork the Argoverse repository](https://help.github.com/en/articles/fork-a-repo) and [clone to your machine](https://help.github.com/en/articles/cloning-a-repository).
+
+- Create a branch for your changes.
+  - `$ git checkout -b <name of your branch>`
+
+- [Install pre-commit](https://pre-commit.com/#install)
+- Run `pre-commit install --install-hooks` to install the [git hooks](https://githooks.com/) for this repo, so your changes get auto-formatted as you commit.
+
+- Validate that your changes do not break any existing unit tests.
+  - Run all unit tests: `$ pytest tests`
+
+- Please provide documentation for any new code your pull request provides.
+
+- Push your branch to the remote when it is complete.
+  - `$ git push --set-upstream origin <name of your branch>`
+
+- [Open a pull request](https://help.github.com/en/articles/creating-a-pull-request-from-a-fork) https://github.com/argoai/argoverse-api/pulls from your branch.
+  - Hint: having unit tests that validate your changes with your pull
+    request will help to land your changes faster.
+
+
+## Helpful documentation
+
+Making a contribution to Argoverse will require some basic knowledge of Git and Github.  If these tools are new to you, here are is some documentation that might be helpful.
+
+- Basic tutorial for using Git and Github: https://guides.github.com/activities/hello-world/
+- Forking a repository: https://help.github.com/en/articles/fork-a-repo
+- Examples for formatting documentation: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html#example-google
+- Creating a pull request from a fork: https://help.github.com/en/articles/creating-a-pull-request-from-a-fork
+
+## License
+
+By contributing to this project you are acknowledging and agreeing that all contributions made by you are submitted under the terms of the [MIT license](./LICENSE).

LICENSE

@@ -0,0 +1,205 @@
+The majority of our code is released under the MIT license below. We retain 
+the Apache 2.0 license on certain files that we include or modify from other
+open source projects: vis_mask.py, colormap.py, and cuboid_interior.py. The 
+full text of the Apache 2.0 license is below.
+
+The MIT License
+
+Copyright (c) 2019 Argo AI, LLC.
+
+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.
+
+
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

MANIFEST.in

@@ -0,0 +1,2 @@
+# include the LICENSE
+include LICENSE