new setup with the github actions updates.

README.md

@@ -4,25 +4,43 @@ license: mit
 
 # statcast-era-pitches
 
-This is a tabular dataset that contains all mlb pitch data in the modern statcast era (2015-2023) up through last year. In order to update this each season in the future, I will just need to run the cells located in the `statcast_through_last_year.ipynb` jupyter notebook.
+This dataset contains every pitch thrown in Major League Baseball from 2015 through present, and is updated weekly. See the **Updates** section for detials. 
 
-## Variable Docs
+## Usage
 
-Documentation on the columns in this dataset can be found [here](https://baseballsavant.mlb.com/csv-docs).
+***Tidyverse***
+```r
+library(tidyverse)
 
-## Use
+statcast_pitches <- read_parquet(
+    "https://huggingface.co/datasets/Jensen-holm/statcast-era-pitches/resolve/main/data/statcast_era_pitches.parquet"
+)
+```
 
-**HuggingFace Dataset**
+***Pandas***
 
-``` python
-from datasets import load_dataset
+```python
+import pandas as pd
 
-dataset = load_dataset("Jensen-holm/statcast-era-pitches")
+statcast_pitches = pd.read_parquet(
+    "https://huggingface.co/datasets/Jensen-holm/statcast-era-pitches/resolve/main/data/statcast_era_pitches.parquet"
+)
 ```
 
+***Polars***
+
+```python
+import polars as pl
+
+statcast_pitches = pl.read_parquet(
+    "https://huggingface.co/datasets/Jensen-holm/statcast-era-pitches/resolve/main/data/statcast_era_pitches.parquet"
+)
+```
+
+## Variable Docs
 
-**Polars / Pandas**
+Documentation on the columns/features in this dataset can be found [here](https://baseballsavant.mlb.com/csv-docs).
 
-1. clone the repo
-2. import the data/statcast.parquet file into library of choice
+## Updates
 
+This data set is updated once per week through GitHub Actions in [this repository](). the [pybaseball]() package is used to retrieve new statcast pitch level data each monday morning at 12:00 PM ET. It is then pushed to this huggingface dataset.  

requirements.txt

@@ -1,2 +0,0 @@
-polars==1.9.0
-pybaseball==2.2.7

src/dtypes.py

@@ -1,91 +0,0 @@
-import polars as pl
-
-# statcast data types: https://baseballsavant.mlb.com/csv-docs (this is where pybaseball gets the data from)
-
-
-COLUMN_DTYPES: dict[str, pl.DataTypeClass] = {
-    # string columns
-    "pitch_type": pl.String,
-    "game_date": pl.String,
-    "game_type": pl.String,
-    "p_throws": pl.String,
-    "stand": pl.String,
-    "home_team": pl.String,
-    "away_team": pl.String,
-    "description": pl.String,
-    "des": pl.String,
-    "events": pl.String,
-    "type": pl.String,
-    "if_fielding_alignment": pl.String,
-    "of_fielding_alignment": pl.String,
-    "sv_id": pl.String,  # has an underscore in it so pl.Int64 failed
-    # float columns
-    "release_speed": pl.Float64,
-    "release_pos_x": pl.Float64,
-    "release_pos_y": pl.Float64,
-    "release_pos_z": pl.Float64,
-    "spin_rate": pl.Float64,
-    "release_spin": pl.Float64,
-    "break_angle": pl.Float64,
-    "zone": pl.Int64,  # ??
-    "hit_location": pl.Float64,
-    "pfx_x": pl.Float64,
-    "pfx_z": pl.Float64,
-    "plate_x": pl.Float64,
-    "plate_z": pl.Float64,
-    "inning": pl.Float64,
-    "vx0": pl.Float64,
-    "vy0": pl.Float64,
-    "vz0": pl.Float64,
-    "ax": pl.Float64,
-    "ay": pl.Float64,
-    "az": pl.Float64,
-    "sz_top": pl.Float64,
-    "sz_bot": pl.Float64,
-    "hit_distance": pl.Float64,
-    "launch_speed": pl.Float64,
-    "launch_angle": pl.Float64,
-    "launch_speed_angle": pl.Float64,
-    "effective_speed": pl.Float64,
-    "release_spin": pl.Float64,
-    "release_extension": pl.Float64,
-    "release_pos_y": pl.Float64,
-    "estimated_ba_using_speedangle": pl.Float64,
-    "estimated_woba_using_speedangle": pl.Float64,
-    "woba_value": pl.Float64,
-    "woba_denom": pl.Float64,
-    "babip_value": pl.Float64,
-    "iso_value": pl.Float64,
-    "spin_axis": pl.Int64,
-    "delta_home_win_exp": pl.Float64,
-    "delta_run_exp": pl.Float64,
-    # int columns
-    "balls": pl.Int64,
-    "strikes": pl.Int64,
-    "outs_when_up": pl.Int64,
-    "batter": pl.Int64,
-    "pitcher": pl.Int64,
-    "game_year": pl.Int64,
-    "on_3b": pl.Int64,
-    "on_2b": pl.Int64,
-    "on_1b": pl.Int64,
-    "game_pk": pl.Int64,
-    "fielder_2": pl.Int64,
-    "fielder_3": pl.Int64,
-    "fielder_4": pl.Int64,
-    "fielder_5": pl.Int64,
-    "fielder_6": pl.Int64,
-    "fielder_7": pl.Int64,
-    "fielder_8": pl.Int64,
-    "fielder_9": pl.Int64,
-    "at_bat_number": pl.Int64,
-    "pitch_number": pl.Int64,
-    "home_score": pl.Int64,
-    "away_score": pl.Int64,
-    "bat_score": pl.Int64,
-    "post_home_score": pl.Int64,
-    "post_away_score": pl.Int64,
-    "post_bat_score": pl.Int64,
-    "bat_speed": pl.Float64,
-    "swing_length": pl.Float64,
-}

src/statcast_era_pitches.py

@@ -1,51 +0,0 @@
-import polars as pl
-import pybaseball
-import datetime
-import os
-
-from dtypes import COLUMN_DTYPES
-
-import warnings
-
-# pybaseball has a lot of FutureWarnings with pandas
-warnings.filterwarnings("ignore", category=FutureWarning)
-
-
-DATA_DIR = os.path.join("..", "data")
-COMPRESSION = "zstd"
-
-
-def get_statcast_era_pitches(
-    end_year: int = datetime.datetime.now().year - 1,
-) -> pl.DataFrame:
-    assert end_year > 2015, f"end year must be > 2015, not '{end_year}'"
-
-    pitches_by_year: list[pl.DataFrame] = []
-    dt_range = range(2015, end_year)
-
-    for i, year in enumerate(dt_range):
-        print(f"Season {i + 1} / {len(dt_range)}")
-        _pitches: pl.DataFrame = pl.from_pandas(
-            pybaseball.statcast(
-                start_dt=f"{year}-03-01",
-                end_dt=f"{year}-12-01",
-                verbose=False,
-                parallel=True,
-            ),
-            schema_overrides=COLUMN_DTYPES,
-            rechunk=True,
-        )
-        pitches_by_year.append(_pitches)
-
-    return pl.concat(
-        pitches_by_year,
-        rechunk=True,
-    )
-
-
-if __name__ == "__main__":
-    statcast_era_pitches: pl.DataFrame = get_statcast_era_pitches(end_year=2024)
-    statcast_era_pitches.write_parquet(
-        os.path.join(DATA_DIR, "statcast_era_pitches.parquet"),
-        compression=COMPRESSION,
-    )

statcast_era_pitches.parquet

@@ -1,3 +0,0 @@
-version https://git-lfs.github.com/spec/v1
-oid sha256:e9b897ae79e9d3d135aad9be485924825f953aea9f9252c6f04b560b727d6e41
-size 575389953