diff --git a/README.md b/README.md index 6dcb634..27f27eb 100644 --- a/README.md +++ b/README.md @@ -15,49 +15,22 @@ The **unravelsports** package aims to aid researchers, analysts and enthusiasts 🌀 Features ----- - +- ⚽ Converting **positional soccer data** into graphs to train **graph neural networks** by leveraging the powerful [**Kloppy**](https://github.com/PySport/kloppy/tree/master) data conversion standard and [**Spektral**](https://github.com/danielegrattarola/spektral) - a flexible framework for creating graph neural networks. +- ⚽ Randomizing and splitting data into **train, test and validation sets** along matches, sequences or possessions to avoid leakage and improve model quality. +- ⚽ Due to the power of **Kloppy**, **unravelsports** supports these actions for _Metrica_, _Sportec_, _Tracab (CyronHego)_, _SecondSpectrum_, _SkillCorner_ and _StatsPerform_ tracking data. 🌀 Getting Started ----- - +📖 The [**Getting Started Jupyter Notebook**](examples/0_getting_started.ipynb) explains how to convert any positional tracking data from **Kloppy** to **Spektral GNN** in a few easy steps while walking you through the most important features and documentation. + +📖 The [**Graph Converter Tutorial Jupyter Notebook**](examples/1_tutorial_graph_converter.ipynb) gives an in-depth walkthrough. 🌀 Documentation ----- For now, follow the [**Graph Converter Tutorial**](examples/1_tutorial_graph_converter.ipynb), more documentation will follow! Additional reading: - +- 📖 [A Graph Neural Network Deep-dive into Successful Counterattacks {A. Sahasrabudhe & J. Bekkers, 2023}](https://github.com/USSoccerFederation/ussf_ssac_23_soccer_gnn/tree/main) 🌀 Installation ---- @@ -71,7 +44,7 @@ pip install unravelsports 🌀 Contributing ---- -All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome. Feel free to create a Pull Request for any improvements you make that do not contribute to winning more games! +All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome. An overview on how to contribute can be found in the [**contributing guide**](CONTRIBUTING.md). diff --git a/unravel/__init__.py b/unravel/__init__.py index 64e01cc..dcb7b68 100644 --- a/unravel/__init__.py +++ b/unravel/__init__.py @@ -1,3 +1,2 @@ from .soccer import * from .utils import * -from .classifiers import *