Kaszanas/DatasetPreparator: 2.1.0 DatasetPreparator Release

What's Changed [PR] Moving Maps to SC2 Installation Directory by @Kaszanas in https://github.com/Kaszanas/DatasetPreparator/pull/75 [PR] Automatic SC2 Cache Seeding by @Kaszanas in https://github.com/Kaszanas/DatasetPreparator/pull/73 [PR] Creating directories if they do not exist by @Kaszanas in https://github.com/Kaszanas/DatasetPreparator/pull/77 [PR] Type Hints Without Imports by @Kaszanas in https://github.com/Kaszanas/DatasetPreparator/pull/79 [PR] Preparing 2.1.0 Release by @Kaszanas in https://github.com/Kaszanas/DatasetPreparator/pull/80 Full Changelog: https://github.com/Kaszanas/DatasetPreparator/compare/2.0.0...2.1.0 DatasetPreparator This project contains various scripts that can assist in the process of preparing datasets. To have a broad overview of the tools please refer to the Detailed Tools Description. Tools in this repository were used to create the SC2ReSet: StarCraft II Esport Replaypack Set, and finally SC2EGSet: StarCraft II Esport Game State Dataset, citation information Cite Us!. Installation [!NOTE] To run this project there are some prerequisites that you need to have installed on your system: Docker Optional make (if you do not wish to use make, please refer to the commands defined in the makefile and run them manually) Our prefered way of distributing the toolset is through DockerHub. We use the Docker Image to provide a fully reproducible environment for our scripts. To pull the image from DockerHub, run the following command: docker pull kaszanas/datasetpreparator:latest If you wish to clone the repository and build the Docker image yourself, run the following command: make docker_build After building the image, please refer to the Command Line Arguments Usage section for the usage of the scripts and for a full description for each of the scripts refer to Detailed Tools Description. Command Line Arguments Usage When using Docker, you will have to pass the arguments through the docker run command and mount the input/output directory. Below is an example of how to run the directory_flattener script using Docker. For ease of use we have prepared example directory structure in the processing directory. The command below uses that to issue a command to flatten the directory structure: docker run -rm \ -v ".\processing:/app/processing" \ datasetpreparator:latest \ python3 directory_flattener.py \ --input_path ./processing/input/directory_flattener \ --output_path ./processing/output/directory_flattener \ --n_processes 8 \ --force_overwrite True \ SC2EGSet Dataset Reproduction Steps [!NOTE] Instructions below are for reproducing the result of the SC2EGSet dataset. If you wish to use the tools in this repository separately for your own dataset, please refer to the Detailed Tools Description. Using Docker We provide a release image containing all of the scripts. To see the usage of these scripts please refer to their respective README.md files as described in Detailed Tools Description. The following steps were used to prepare the SC2ReSet and SC2EGSet datasets: Build the docker image for the DatasetPreparator using the provided makefile target: make docker_build. This will load all of the dependencies such as the SC2InfoExtractorGo. Place the input replaypacks into ./processing/input/directory_flattener directory. Run the command make sc2reset_sc2egset_pipeline to process the replaypacks and create the datasets. The output will be placed in ./processing/output/SC2ReSet and ./processing/output/SC2EGSet directories. Detailed Tools Description Each of the scripts has its usage described in their respective README.md files, you can find the detailed description of the available tools below. CLI Usage; Generic scripts Directory Packager (dir_packager): README Directory Flattener (directory_flattener): README File Renamer (file_renamer): README JSON Merger (json_merger): README Processed Mapping Copier (processed_mapping_copier): README CLI Usage; StarCraft 2 Specific Scripts SC2 Map Downloader (sc2_map_downloader): README SC2EGSet Pipeline (sc2egset_pipeline): README SC2EGSet Replaypack Processor (sc2egset_replaypack_processor): README SC2ReSet Replaypack Downloader (sc2reset_replaypack_downloader): README Contributing and Reporting Issues If you want to report a bug, request a feature, or open any other issue, please do so in the issue tracker. Please see CONTRIBUTING.md for detailed development instructions and contribution guidelines. Cite Us! This Repository SC2EGSet: Dataset Description @article{Bialecki2023_SC2EGSet, author = {Bia{\l}ecki, Andrzej and Jakubowska, Natalia and Dobrowolski, Pawe{\l} and Bia{\l}ecki, Piotr and Krupi{\'{n}}ski, Leszek and Szczap, Andrzej and Bia{\l}ecki, Robert and Gajewski, Jan}, title = {SC2EGSet: StarCraft II Esport Replay and Game-state Dataset}, journal = {Scientific Data}, year = {2023}, month = {Sep}, day = {08}, volume = {10}, number = {1}, pages = {600}, issn = {2052-4463}, doi = {10.1038/s41597-023-02510-7}, url = {https://doi.org/10.1038/s41597-023-02510-7} } @software{Białecki_2022_6366039, author = {Białecki, Andrzej and Białecki, Piotr and Krupiński, Leszek}, title = {{Kaszanas/SC2DatasetPreparator: 1.2.0 SC2DatasetPreparator Release}}, month = {jun}, year = {2022}, publisher = {Zenodo}, version = {2.0.1}, doi = {10.5281/zenodo.5296664}, url = {https://doi.org/10.5281/zenodo.5296664} }