/tutorials

Tutorials for onboarding of the GNN Tracking project

Primary LanguageJupyter NotebookMIT LicenseMIT

GNN Tracking Tutorials

pre-commit.ci status link checker gitmoji License Black PR welcome

📝 Description

Tutorials and onboarding for the GNN Tracking project

📦 Installation

  1. Follow the instructions from the main library to set up the conda environment and install the package.

  2. Run pytest on the main package

  3. Download the trackml dataset (see note below). Note that the full dataset is linked in "Dataset description and other files" in the "Participate" tab (O(100GB) of data). The data files of the "Starting Kit"/"Public Data" are only a tiny fraction of this. If you just want to check that everything works or are currently waiting to get access to the data (see note below), you can use the small dataset from test-data.

Note

The website competitions.codalab.org does no longer accept new registrations (needed to access the data set). If you do not already have an account there, contact us for the dataset.

Warning

Do not use the data from the similar Kaggle challenge: This is an older version of the same data that is missing some bug fixes!

🧰 Development setup

pip3 install pre-commit
pre-commit install
nbdime config-git enable