Package: sc2image
StarCraftImage DatasetWelcome! This is the repository for the StarCraftImage dataset from the paper:StarCraftImage: A Dataset For Prototyping Spatial Reasoning Methods For Multi-Agent Environments.
This README has basic installation and quickstart usage but our project webpage has more documentation:StarCraftImage project webpage.If you use this dataset, please cite the following paper:@inproceedings{kulinski2023starcraftimage,
  title={StarCraftImage: A Dataset for Prototyping Spatial Reasoning Methods for Multi-Agent Environments},
  author={Kulinski, Sean and Waytowich, Nicholas R and Hare, James Z and Inouye, David I},
  booktitle={Proceedings of the IEEE/CVF Conference on Computer Vision and Pattern Recognition},
  pages={22004--22013},
  year={2023}
}InstallationWe recommend using thepippackage manager to installsc2image.pipinstallsc2imageNote, this does not include thedataset-demosfolder which contains jupyter notebooks which show example uses of the dataset.
To use them, you should install from source via:gitclonegit@github.com:inouye-lab/starcraftimage.gitcdstarcraftimage
pipinstall-e.Quickstart:warning:For more detailed documentation and example uses, visit thedataset docsfor usingsc2image.There are three main StarCraftII datasets.
Each dataset includes images summarize a 10 second window (255 frames) of a StarCraftII replay.StarCraftImage: This is the main 3.6 million sample dataset which includes multiple image formats:'sparse-hyperspectral','dense-hyperspectral','bag-of-units','bag-of-units-first', and contains all unit positioning information throughout the window.
This dataset can be used via the following:fromsc2image.datasetimportStarCraftImagesc2image=StarCraftImage(root="data",download=True)This will download the StarCraftImage dataset to thedatadirectory (if it does not already exist there).
As this dataset has over 3.6 million samples, this might take a while to download. However, you can use the standalone StarCraftCIFAR10 and StarCraftMNIST versions below.StarCraftCIFAR10: This is a simplified version of theStarCraftImagedataset which exactly matches the setup of the CIFAR10 dataset.
All images have been condensed into a three channel (RGB) image where the Red channel corresponds to Player 2 units, Green correspond to neutral units, and Blue to Player 1 units.
The 10 classes equate to:(map_name, did_window_happen_in_first_half_of_replay).
The dataset can be loaded via:fromsc2image.datasetimportStarCraftCIFAR10sc2image_cifar10=StarCraftCIFAR10(root="data",download=True)StarCraftMNIST: This is a further simplified version of theStarCraftImagedataset which exactly matches the setup of the MNIST dataset.
The grayscale images show to the seen last seen timestamps for units each pixel location, and the 10 classes match that ofStarCraftCIFAR10.
The dataset can be loaded via:fromsc2image.datasetimportStarCraftMNISTsc2image_mnist=StarCraftMNIST(root="data",download=True)Example usesPlease see thestarcraftimage-quickstartjupyter notebook in thedataset-demosfolder to see details on using this dataset!Bug reportsIf you run into any issues, please feel free to open an issue in this repository or email us via the corresponding author email in themain paper.Cheers!