Update readme for ultimate

README.md

@@ -34,6 +34,7 @@ pip install -e .
 #### Space Data
 - [Space data in Basketball 🏀](https://github.com/open-starlab/PreProcessing/blob/master/preprocessing/sports/space_data/basketball/README.md)
 - [Space data in Football/Soccer ⚽](https://github.com/open-starlab/PreProcessing/blob/master/preprocessing/sports/space_data/soccer/README.md)
+- [Space data in Ultimate 🥏](https://github.com/open-starlab/PreProcessing/blob/master/preprocessing/sports/space_data/ultimate/README.md)
 
 ## RoadMap
 - [x] Release the package
@@ -54,6 +55,7 @@ pip install -e .
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/calvinyeungck"><img src="https://github.com/calvinyeungck.png" width="100px;" alt="Calvin Yeung"/><br /><sub><b>Calvin Yeung</b></sub></a><br /><a href="#Developer-CalvinYeung" title="Lead Developer">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/kenjiro-mk"><img src="https://github.com/kenjiro-mk.png" width="100px;" alt="Kenjiro Ide"/><br /><sub><b>Kenjiro Ide</b></sub></a><br /><a href="#Developer-KenjiroIde" title="Developer">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/czzzzz129"><img src="https://github.com/czzzzz129.png" width="100px;" alt="Zheng Chen"/><br /><sub><b>Zheng Chen</b></sub></a><br /><a href="#Developer-ZhengChen" title="Developer">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/shunsuke-iwashita"><img src="https://github.com/shunsuke-iwashita.png" width="100px;" alt="Shunsuke Iwashita"/><br /><sub><b>Shunsuke Iwashita</b></sub></a><br /><a href="#Developer-ShunsukeIwashita" title="Developer">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/keisuke198619"><img src="https://github.com/keisuke198619.png" width="100px;" alt="Keisuke Fujii"/><br /><sub><b>Keisuke Fujii</b></sub></a><br /><a href="#lead-KeisukeFujii" title="Team Leader">🧑‍💻</a></td>
     </tr>
   </tbody>

preprocessing/sports/space_data/space_class.py

@@ -2,7 +2,7 @@ class Space_data:
     # Modified the sports list to only include fully supported providers
     basketball_data_provider = ["SportVU_NBA"]
     soccer_data_provider = ["fifa_wc_2022"]
-    ultimate_data_provider = ["UltimateTrack", "UFA"]
+    ultimate_data_provider = ["UltimateTrack", "UFATrack"]
 
     def __new__(cls, data_provider, *args, **kwargs):
         if data_provider in cls.basketball_data_provider:

preprocessing/sports/space_data/ultimate/README.md

@@ -0,0 +1,9 @@
+# Space data in Ultimate 🥏
+[![Documentation Status](https://readthedocs.org/projects/openstarlab/badge/?version=latest)](https://openstarlab.readthedocs.io/en/latest/Pre_Processing/Sports/index.html)
+## Introduction
+This package offers functions to load and preprocess space data from various sources in Ultimate.
+## Supported Data Providers
+You can find detailed documentation on supported data providers [here](https://openstarlab.readthedocs.io/en/latest/Pre_Processing/Sports/Space_Eval/Data_Provider/Ultimate/index.html). The supported providers include:
+
+- UFATrack
+- UltimateTrack

preprocessing/sports/space_data/ultimate/ultimate_space_class.py

@@ -18,7 +18,7 @@ def __init__(
         self.out_path = out_path
         if self.data_provider == "UltimateTrack":
             self.tracking_herz = 15
-        elif self.data_provider == "UFA":
+        elif self.data_provider == "UFATrack":
             self.tracking_herz = 10
 
     def get_files(self):

preprocessing/sports/space_data/ultimate/ultimate_space_preprocessing.py

@@ -251,10 +251,10 @@ def create_events_metrica(df, tracking_herz):
 
 def create_tracking_metrica(df, team, tracking_herz):
     """
-    Create the Metrica format DataFrame for team tracking data from UFA data
+    Create the Metrica format DataFrame for team tracking data from UFATrack data
 
     Args:
-        df (DataFrame): The UFA intermediate DataFrame containing tracking data
+        df (DataFrame): The UFATrack intermediate DataFrame containing tracking data
             with columns: frame, class, x, y, id, closest
         team (str): Team designation ("Home" for offense, "Away" for defense)
         tracking_herz (int): Frequency of tracking data (frames per second)