sc2_datasets.lightning.datamodules.sc2_replaypack_datamodule
============================================================

.. py:module:: sc2_datasets.lightning.datamodules.sc2_replaypack_datamodule


Classes
-------

.. autoapisummary::

   sc2_datasets.lightning.datamodules.sc2_replaypack_datamodule.SC2ReplaypackDataModule


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

.. py:class:: SC2ReplaypackDataModule(replaypack_name: str, unpack_dir: pathlib.Path | str = Path('./data/unpack').resolve(), download_dir: pathlib.Path | str = Path('./data/download').resolve(), url: str = '', download: bool = True, transform: Callable | None = None, batch_size: int = 256, num_workers: int = 0, unpack_n_workers: int = 16, validator: Callable | None = None)

   Bases: :py:obj:`pytorch_lightning.LightningDataModule`


   Defines a LightningDataModule abstraction for a single StarCraft II replaypack.

   :param replaypack_name: Specifies a replaypack name which will be used as a directory name.
   :type replaypack_name: str
   :param unpack_dir: Specifies the path where the replaypack (dataset)        will be unpacked into a custom directory structure, by default "./data/unpack"
   :type unpack_dir: Path | str, optional
   :param download_dir: Specifies the path where the replaypack (dataset)        will be downloaded, by default "./data/download"
   :type download_dir: Path | str, optional
   :param url: Specifies the url which will be used to download        the replaypack (dataset), by default ""
   :type url: str, optional
   :param download: Specifies if the dataset should be downloaded.        Otherwise the dataset is loaded from the unpack_dir        and a custom directory structure is assumed, 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 | None, optional
   :param batch_size: Batch size which will be used for learning tasks, by default 256
   :type batch_size: int, optional
   :param num_workers: Number of workers used for dataloaders, 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,        this can also act as a filtering function that will be        applied for the entirety of the dataset, by default None
   :type validator: Callable | None, optional


   .. py:attribute:: transform
      :value: None



   .. py:attribute:: batch_size
      :value: 256



   .. py:attribute:: num_workers
      :value: 0



   .. py:attribute:: replaypack_name


   .. py:attribute:: unpack_dir


   .. py:attribute:: download_dir


   .. py:attribute:: url
      :value: ''



   .. py:attribute:: download
      :value: True



   .. py:attribute:: unpack_n_workers
      :value: 16



   .. py:attribute:: validator
      :value: None



   .. py:method:: prepare_data() -> None


   .. py:method:: setup(stage: str | None = None) -> None


   .. py:method:: train_dataloader() -> torch.utils.data.dataloader.DataLoader


   .. py:method:: val_dataloader() -> torch.utils.data.dataloader.DataLoader


   .. py:method:: test_dataloader() -> torch.utils.data.dataloader.DataLoader


   .. py:method:: teardown(stage: str | None = None) -> None