sportslabkit.datasets#

Subpackages#

Overview#

Classes#

KaggleDownloader

-
Function#

get_path(dataset)

Get the path to the data file.
Attributes#

available

-

Classes#

class sportslabkit.datasets.KaggleDownloader[source]#

Overview

Methods#

show_info()

Show the dataset info.

dataset_list_files()

List the files in the dataset.

download(file_name, path, force, quiet, unzip)

Download the dataset from Kaggle.

Members

show_info() → None#

Show the dataset info.

dataset_list_files() → None#

List the files in the dataset.

download(file_name: str | None = None, path: PathLike | None = _module_path, force: bool = False, quiet: bool = False, unzip: bool = True) → None#

Download the dataset from Kaggle.

Parameters:

  • file_name (Optional[str], optional) – Name of the file to download. If None, downloads all data. Defaults to None.

  • path (Optional[PathLike], optional) – Path to download the data to. If None, downloads to soccertrack/datasets/data. Defaults to None.

  • force (bool, optional) – If True, overwrites the existing file. Defaults to False.

  • quiet (bool, optional) – If True, suppresses the output. Defaults to True.

  • unzip (bool, optional) – If True, unzips the file. Defaults to True.

Functions#

sportslabkit.datasets.get_path(dataset: str | None = None) → str[source]#

Get the path to the data file.

Parameters:

dataset (str) – Name of the dataset. If None, print the available datasets.

Returns:

Path to the data file.

Return type:

str

Attributes#

sportslabkit.datasets.available[source]#