feat: add dataset abstraction

ML-KULeuven · Jul 27, 2024 · f704641 · f704641
1 parent a9a3791
commit f704641
Show file tree

Hide file tree

Showing 80 changed files with 4,316 additions and 1,889 deletions.
diff --git a/docs/api/data.rst b/docs/api/data.rst
@@ -3,6 +3,39 @@
 socceraction.data
 =================
 
+socceraction.data.dataset
+-------------------------
+
+.. autosummary::
+  :toctree: generated
+  :nosignatures:
+  :template: class.rst
+
+  ~socceraction.data.dataset.HDFDataset
+  ~socceraction.data.dataset.SQLDataset
+
+
+socceraction.data.transforms
+----------------------------
+
+
+.. autosummary::
+  :toctree: generated
+  :nosignatures:
+
+  ~socceraction.data.transforms.PlayActionsLeftToRight
+  ~socceraction.data.transforms.PlayAtomicActionsLeftToRight
+  ~socceraction.data.transforms.StatsBombEventsToActions
+  ~socceraction.data.transforms.OptaEventsToActions
+  ~socceraction.data.transforms.WyscoutEventsToActions
+  ~socceraction.data.transforms.ActionsToFeatures
+  ~socceraction.data.transforms.StatsBombEventsToFeatures
+
+
+
+socceraction.data.providers
+---------------------------
+
 .. list-table::
    :widths: 30 70
 

diff --git a/docs/api/data_base.rst b/docs/api/data_base.rst
@@ -1,7 +1,7 @@
 .. _api-data-base:
 
-socceraction.data.base
-======================
+socceraction.data.providers.base
+================================
 
 .. automodule:: socceraction.data
 
@@ -13,7 +13,7 @@ Serializers
   :nosignatures:
   :template: class.rst
 
-  socceraction.data.base.EventDataLoader
+  socceraction.data.providers.base.EventDataLoader
 
 
 Schema

diff --git a/docs/api/data_opta.rst b/docs/api/data_opta.rst
@@ -1,9 +1,9 @@
 .. _api-data-opta:
 
-socceraction.data.opta
-======================
+socceraction.data.providers.opta
+================================
 
-.. automodule:: socceraction.data.opta
+.. automodule:: socceraction.data.providers.opta
 
 Serializers
 ------------
@@ -13,7 +13,7 @@ Serializers
   :nosignatures:
   :template: class.rst
 
-  socceraction.data.opta.OptaLoader
+  socceraction.data.providers.opta.OptaLoader
 
 
 Schema
@@ -24,8 +24,8 @@ Schema
   :nosignatures:
   :template: schema.rst
 
-  socceraction.data.opta.OptaCompetitionSchema
-  socceraction.data.opta.OptaTeamSchema
-  socceraction.data.opta.OptaPlayerSchema
-  socceraction.data.opta.OptaGameSchema
-  socceraction.data.opta.OptaEventSchema
+  socceraction.data.providers.opta.OptaCompetitionSchema
+  socceraction.data.providers.opta.OptaTeamSchema
+  socceraction.data.providers.opta.OptaPlayerSchema
+  socceraction.data.providers.opta.OptaGameSchema
+  socceraction.data.providers.opta.OptaEventSchema
diff --git a/docs/api/data_statsbomb.rst b/docs/api/data_statsbomb.rst
@@ -1,9 +1,9 @@
 .. _api-data-statsbomb:
 
-socceraction.data.statsbomb
-===========================
+socceraction.data.providers.statsbomb
+=====================================
 
-.. automodule:: socceraction.data.statsbomb
+.. automodule:: socceraction.data.providers.statsbomb
 
 Serializers
 ------------
@@ -13,7 +13,7 @@ Serializers
   :nosignatures:
   :template: class.rst
 
-  socceraction.data.statsbomb.StatsBombLoader
+  socceraction.data.providers.statsbomb.StatsBombLoader
 
 Schema
 ------
@@ -23,8 +23,8 @@ Schema
    :nosignatures:
    :template: schema.rst
 
-    socceraction.data.statsbomb.StatsBombCompetitionSchema
-    socceraction.data.statsbomb.StatsBombTeamSchema
-    socceraction.data.statsbomb.StatsBombPlayerSchema
-    socceraction.data.statsbomb.StatsBombGameSchema
-    socceraction.data.statsbomb.StatsBombEventSchema
+    socceraction.data.providers.statsbomb.StatsBombCompetitionSchema
+    socceraction.data.providers.statsbomb.StatsBombTeamSchema
+    socceraction.data.providers.statsbomb.StatsBombPlayerSchema
+    socceraction.data.providers.statsbomb.StatsBombGameSchema
+    socceraction.data.providers.statsbomb.StatsBombEventSchema
diff --git a/docs/api/data_wyscout.rst b/docs/api/data_wyscout.rst
@@ -1,9 +1,9 @@
 .. _api-data-wyscout:
 
-socceraction.data.wyscout
-=========================
+socceraction.data.providers.wyscout
+===================================
 
-.. automodule:: socceraction.data.wyscout
+.. automodule:: socceraction.data.providers.wyscout
 
 Serializers
 ------------
@@ -13,8 +13,8 @@ Serializers
   :nosignatures:
   :template: class.rst
 
-  socceraction.data.wyscout.WyscoutLoader
-  socceraction.data.wyscout.PublicWyscoutLoader
+  socceraction.data.providers.wyscout.WyscoutLoader
+  socceraction.data.providers.wyscout.PublicWyscoutLoader
 
 Schema
 ------
@@ -24,8 +24,8 @@ Schema
   :nosignatures:
   :template: schema.rst
 
-  socceraction.data.wyscout.WyscoutCompetitionSchema
-  socceraction.data.wyscout.WyscoutTeamSchema
-  socceraction.data.wyscout.WyscoutPlayerSchema
-  socceraction.data.wyscout.WyscoutGameSchema
-  socceraction.data.wyscout.WyscoutEventSchema
+  socceraction.data.providers.wyscout.WyscoutCompetitionSchema
+  socceraction.data.providers.wyscout.WyscoutTeamSchema
+  socceraction.data.providers.wyscout.WyscoutPlayerSchema
+  socceraction.data.providers.wyscout.WyscoutGameSchema
+  socceraction.data.providers.wyscout.WyscoutEventSchema
diff --git a/docs/documentation/data/index.rst b/docs/documentation/data/index.rst
@@ -1,4 +1,4 @@
-.. currentmodule:: socceraction.data
+.. currentmodule:: socceraction.data.providers
 
 *************
 Loading data

diff --git a/docs/documentation/data/opta.rst b/docs/documentation/data/opta.rst
@@ -1,4 +1,4 @@
-.. currentmodule:: socceraction.data.opta
+.. currentmodule:: socceraction.data.providers.opta
 
 =========================
 Loading Opta data

diff --git a/docs/documentation/data/statsbomb.rst b/docs/documentation/data/statsbomb.rst
@@ -1,4 +1,4 @@
-.. currentmodule:: socceraction.data.statsbomb
+.. currentmodule:: socceraction.data.providers.statsbomb
 
 =========================
 Loading StatsBomb data

diff --git a/docs/documentation/data/wyscout.rst b/docs/documentation/data/wyscout.rst
@@ -1,5 +1,5 @@
 
-.. currentmodule:: socceraction.data.wyscout
+.. currentmodule:: socceraction.data.providers.wyscout
 
 =========================
 Loading Wyscout data

diff --git a/socceraction/__init__.py b/socceraction/__init__.py
@@ -5,7 +5,7 @@
 SoccerAction is a Python package for objectively quantifying the impact of the
 individual actions performed by soccer players using event stream data.
 
-Full documentation is at <https://ml-kuleuven.github.io/socceraction/>.
+Full documentation is at <https://socceraction.readthedocs.io>.
 :copyright: (c) 2020 by DTAI KU Leuven.
 :license: MIT, see LICENSE for more details.
 """

diff --git a/socceraction/atomic/features/__init__.py b/socceraction/atomic/features/__init__.py
@@ -0,0 +1,42 @@
+"""A collection of feature generators."""
+
+from socceraction.features import (
+    actiontype,
+    bodypart,
+    bodypart_detailed,
+    bodypart_detailed_onehot,
+    bodypart_onehot,
+    player_possession_time,
+    speed,
+    team,
+    time,
+    time_delta,
+)
+
+from .spadl import (
+    actiontype_onehot,
+    direction,
+    goalscore,
+    location,
+    movement_polar,
+    polar,
+)
+
+__all__ = [
+    "actiontype",
+    "actiontype_onehot",
+    "bodypart",
+    "bodypart_detailed",
+    "bodypart_onehot",
+    "bodypart_detailed_onehot",
+    "team",
+    "time",
+    "time_delta",
+    "speed",
+    "location",
+    "polar",
+    "movement_polar",
+    "direction",
+    "goalscore",
+    "player_possession_time",
+]