sc2_datasets.torch.sc2_egset_dataset
====================================

.. py:module:: sc2_datasets.torch.sc2_egset_dataset


Classes
-------

.. autoapisummary::

   sc2_datasets.torch.sc2_egset_dataset.SC2EGSetDatasetSingleJSON
   sc2_datasets.torch.sc2_egset_dataset.SC2EGSetDataset


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

.. py:class:: SC2EGSetDatasetSingleJSON(dataset_name, unpack_dir, download_dir, dataset_url, transform, validator)

   Bases: :py:obj:`sc2_datasets.torch.datasets.sc2_dataset_single_json.SC2DatasetSingleJSON`


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

   Bases: :py:obj:`sc2_datasets.torch.datasets.sc2_dataset.SC2Dataset`


   Inherits from SC2Dataset and ensures that the dataset for SC2EGSet is downloaded.

   :param unpack_dir: Specifies the path of a directory where the dataset files will be unpacked,        by default "./data/unpack/sc2egset_dataset".
   :type unpack_dir: Path | str
   :param download_dir: Specifies the path of a directory where the dataset files will be downloaded,        by default "./data/download/sc2egset_dataset".
   :type download_dir: Path | str
   :param names_urls: Specifies the URL of the dataset which will be used to download the files,        by default SC2EGSET_DATASET_REPLAYPACKS.
   :type names_urls: list[DatasetProperties]
   :param unpack_n_workers: Specifies the number of workers that will be used for unpacking the archive,        defaults to 16.
   :type unpack_n_workers: int, optional
   :param transform: PyTorch transform function that takes SC2ReplayData and returns something.
   :type transform: Func[SC2ReplayData, T]
   :param validator: Specifies the validation option for fetched data, defaults to None.
   :type validator: Callable | None, optional