dataset

Dataset pre-processing & model training scripts for BeatSketch, the in-VR Beat Saber level editor.

Contributing

BSOR Files

BeatSketch models are trained using BSOR replay files. This repository handles all needed preprocessing.

If you can't code but want to help out, uploading BSOR files is an easy way.

Checkout

Please note that all model files are stored using git-lfs. (see man git-lfs)

In short, install git-lfs and run

git lfs install

Now, any git command (pull, push, etc.) will also handle LFS files.

Alternatively, run git lfs pull to pull the LFS files explicitly.

Usage

The script beatsketch_dataset.py has a CLI for common tasks.

The CLI features three primary commands:

• Create dataset file:

  ./beatsketch_dataset.py preprocess folder /path/to/folder path/to/dataset.json

• Train model (and if -o specified, save dataset) from folder after preprocessing:

  ./beatsketch_dataset.py train folder /path/to/folder [-o path/to/dataset.json]

• Train models using pre-saved dataset file:

  ./beatsketch_dataset.py train dataset path/to/dataset.json

For other commands, see ./beatsketch_dataset.py help