sc2_datasets.lightning.sc2_egset_datamodule
===========================================

.. py:module:: sc2_datasets.lightning.sc2_egset_datamodule


Classes
-------

.. autoapisummary::

   sc2_datasets.lightning.sc2_egset_datamodule.SC2EGSetDataModuleSingleJSON
   sc2_datasets.lightning.sc2_egset_datamodule.SC2EGSetDataModule


Module Contents
---------------

.. py:class:: SC2EGSetDataModuleSingleJSON(dataset_name: str = SC2EGSET_SINGLE_JSON.name, unpack_dir: pathlib.Path | str = Path('./data/unpack/sc2egset_single_json'), download=True, download_dir: pathlib.Path | str = Path('./data/download/sc2egset_single_json'), dataset_url: str = SC2EGSET_SINGLE_JSON.url, transform: Callable | None = None, validator: Callable | None = None)

   Bases: :py:obj:`sc2_datasets.lightning.datamodules.sc2_datamodule.SC2DataModuleSingleJSON`


.. py:class:: SC2EGSetDataModule(replaypacks: list[sc2_datasets.available_replaypacks.DatasetProperties] = SC2EGSET_DATASET_REPLAYPACKS, download_dir: pathlib.Path | str = Path('./data/download/sc2egset_dataset'), unpack_dir: pathlib.Path | str = Path('./data/unpack/sc2egset_dataset'), download: bool = True, transform: Callable = None, batch_size: int = 256, num_workers: int = 0, unpack_n_workers: int = 16, validator: Callable | None = None)

   Bases: :py:obj:`sc2_datasets.lightning.datamodules.sc2_datamodule.SC2DataModule`


   Defines a LightningDataModule abstraction for the
   SC2EGSet: StarCraft II Esport Game-State Dataset

   :param replaypacks: Specifies a list of tuples (replaypack_name, replaypack download url),        by default SC2EGSET_DATASET_REPLAYPACKS
   :type replaypacks: list[DatasetProperties], optional
   :param download_dir: Specifies the path where the dataset will be downloaded,        by default "./data/download"
   :type download_dir: Path | str, optional
   :param unpack_dir: Specifies the path where the dataset will be unpacked        into a custom directory structure, by default "./data/unpack"
   :type unpack_dir: Path | str, optional
   :param download: _description_, by default True
   :type download: bool, optional
   :param transform: Specifies the PyTorch transforms to be used        on the replaypack (dataset),         Deprecated since version v1.5: Will be removed in v1.7.0, by default None
   :type transform: Callable, optional
   :param batch_size: Specifies the size of collating individual        fetched data samples, by default 256
   :type batch_size: int, optional
   :param num_workers: Specifies the data loader instance how many sub-processes        to use for data loading, by default 0
   :type num_workers: int, optional
   :param unpack_n_workers: Specifies the number of workers        that will be used for unpacking the archive, by default 16
   :type unpack_n_workers: int, optional
   :param validator: Specifies the validation option for fetched data, by default None
   :type validator: Callable | None, optional