/SoccerTrack

A module and dataset to conduct tracking in sports (work in progress).

Primary LanguageJupyter NotebookMIT LicenseMIT

SoccerTrack

Documentation Status Codacy Badge

SoccerTrack is a dataset and for tracking soccer players and balls.

Installation

User Guide

See the User Guide for more information.

Project Organization

This project was based on the cookiecutter data science template, but some folders were removed. Below is a brief overview of the current project structure.

    │
    ├── docs               <- Sphinx project.
    │
    ├── notebooks          <- Jupyter notebooks for example usage.
    │
    ├── reports            <- Generated analysis including references
    │
    ├── soccertrack        <- Source code. See API Refence.
    │
    ├── data               <- (Only minimum stuff on github).
    │   ├── external       <- Data from third party sources.
    │   ├── interim        <- Intermediate data that has been transformed.
    │   ├── processed      <- The final, canonical data sets for modeling.
    │   └── raw            <- The original, immutable data dump.
    │
    └── models             <- Trained model weights (only minimum stuff on github).

Roadmap

Release 0.0.1 !

  • [] Add a simple example notebook.
  • [] Add auto summary to docs (fork apidoc and include module members to jinja context).

Contributing

See the Contributing Guide for more information.