Package: sc2-datasets
StarCraft II DatasetsLibrary can be used to interface with datasets that were pre-processed with our pipeline
as described in:SC2DatasetPreparatorCurrently we have exposed PyTorch and PyTorch Lightning API. Our goal is to provide
infrastructure used for StarCraft II analytics.Please refer to theofficial documentation, or contact contributors directly for all of the details.Supported DatasetsSC2EGSet: StarCraft II Esport Game State DatasetThis project contains official API implementation for theSC2EGSet: StarCraft II Esport Game State Dataset, which is built based onSC2ReSet: StarCraft II Esport Replaypack Set.
Contents of this library provide PyTorch and PyTorch Lightning API for pre-processed StarCraft II dataset.InstallationManually install PyTorch with minimal version of^1.11.0+cu116.Perform the following command:$pipinstallsc2_datasetsUsageBasic example usage can be seen below. For advanced interactions with the datasets
please refer to the documentation.UseSC2EGSetwith PyTorch:fromsc2_datasets.torch.sc2_egset_datasetimportSC2EGSetDatasetfromsc2_datasets.available_replaypacksimportEXAMPLE_SYNTHETIC_REPLAYPACKSif__name__=="__main__":# Initialize the dataset:sc2_egset_dataset=SC2EGSetDataset(unpack_dir="./unpack_dir_path",# Specify existing directory path, where the data will be unpacked.download_dir="./download_dir_path",# Specify existing directory path, where the data will be downloaded.download=True,names_urls=EXAMPLE_SYNTHETIC_REPLAYPACKS,# Use a synthetic replaypack containing 1 replay.)# Iterate over instances:foriinrange(len(sc2_egset_dataset)):sc2_egset_dataset[i]UseSC2EGSetwith PyTorch Lightning:fromsc2_datasets.lightning.sc2egset_datamoduleimportSC2EGSetDataModulefromsc2_datasets.available_replaypacksimportEXAMPLE_SYNTHETIC_REPLAYPACKSif__name__=="__main__":sc2_egset_datamodule=SC2EGSetDataModule(unpack_dir="./unpack_dir_path",# Specify existing directory path, where the data will be unpacked.download_dir="./download_dir_path",# Specify existing directory path, where the data will be downloaded.download=False,replaypacks=EXAMPLE_SYNTHETIC_REPLAYPACKS,# Use a synthetic replaypack containing 1 replay.)ContributingInterested in contributing? Check out the contributing guidelines. Please note that this project is released with a Contributor License Agreement (CLA) and a Code of Conduct. By contributing to this project, you agree to abide by its terms.Licensesc2egset_datasetwas created by Andrzej Białecki. It is licensed under the terms of the GNU General Public License v3.0 license.CitationsThis RepositoryIf you wish to cite the official API for the SC2EGSet: StarCraft II Esport Game State Dataset.@software{bialecki_andrzej_2022_6930224,author={Białecki, Andrzej andBiałecki, Piotr andSzczap, Andrzej andKrupiński, Leszek},title={Kaszanas/SC2\_Datasets: 1.0.0 SC2\_Datasets Release},month=jul,year=2022,publisher={Zenodo},version={1.0.0},doi={10.5281/zenodo.6629005},url={https://doi.org/10.5281/zenodo.6629005}}Dataset Description Pre-printTo cite the article that introducesSC2ReSetandSC2EGSetuse this:@misc{https://doi.org/10.48550/arxiv.2207.03428,doi={10.48550/ARXIV.2207.03428},url={https://arxiv.org/abs/2207.03428},author={Białecki, Andrzej and Jakubowska, Natalia and Dobrowolski, Paweł and Białecki, Piotr and Krupiński, Leszek and Szczap, Andrzej and Białecki, Robert and Gajewski, Jan},keywords={Machine Learning (cs.LG), Artificial Intelligence (cs.AI), Machine Learning (stat.ML), FOS: Computer and information sciences, FOS: Computer and information sciences},title={SC2EGSet: StarCraft II Esport Replay and Game-state Dataset},publisher={arXiv},year={2022},copyright={Creative Commons Attribution 4.0 International}}SC2ReSet: StarCraft II Esport Replaypack SetTo cite the replay collection that was used to generate the dataset use this:@dataset{bialecki_andrzej_2022_5575797,author={Białecki, Andrzej},title={SC2ReSet: StarCraft II Esport Replaypack Set},month=jun,year=2022,publisher={Zenodo},version={1.0.0},doi={10.5281/zenodo.5575797},url={https://doi.org/10.5281/zenodo.5575797}}SC2EGSet: StarCraft II Esport Game State DatasetTo cite the data itself use this:@dataset{bialecki_andrzej_2022_6629349,author={Białecki, Andrzej andJakubowska, Natalia andDobrowolski, Paweł andSzczap, Andrzej andBiałecki, Robert andGajewski, Jan},title={SC2EGSet: StarCraft II Esport Game State Dataset},month=jun,year=2022,publisher={Zenodo},version={1.0.0},doi={10.5281/zenodo.6629349},url={https://doi.org/10.5281/zenodo.6629349}}