Skip to content

Latest commit

 

History

History
79 lines (56 loc) · 4.44 KB

README.md

File metadata and controls

79 lines (56 loc) · 4.44 KB
Raw

Shadertoys-dataset

This repository contains the code to download, build and update the Shadertoys dataset. The dataset is made up from fragment shader programs published on Shadertoy and annotated with additional metadata for downstream filtering. Evaluation dataset is hosted on Huggingface

The main use case for this dataset is various evaluation benchmarks for (code-) language models.

This project is not affiliated with Shadertoy. It makes use of the Shadertoy.com API.

To-Dos

This project is still in progress, all datasets currently published will see a major refactor.

  • pin and branch/archive Return Completion (shadereval-1) test set
  • dynamically split train/test based on shaderID hash (might not do a train split)
  • [~] public repository for builder scripts (you are here!)
  • (self-)publish TaCoS 2023 paper.
  • [~] redo structure
  • [~] add thumbnails (text2img?)
  • improved license detecting and tagging using scan-code
  • potentially webscraping and tagging sources/unlisted? -> current RFC: pygfx/shadertoy#27

Related work

  • shaders21k also sources shader programs from Shadertoy.com, however it provides rendered frames for visual representation learning. It is available as a alreanative to downloading from the API.
  • The-Stack has a GLSL subset. This data is sourced from GitHub.
  • The-Stack-v2 sources data from a larger archive.

Requirements

Setup

To access shader programs that are published for public+api a Shadertoy account and API key is required. Request a key and setup a SHADERTOY_KEY environment variable.

If you want to use shaders20k (Shadertoy subset of shaders21k), please download the all_codes.zip and place it to ./data/shaders20k/.

Dependencies

Usage

There is currently two out of three scripts available. Plenty of defaults are set and example files are provided in ./data/

Download

$>python download.py --mode full --num_shaders 100

will download the newest 100 shaders from Shadertoy.com via the API and save them to the ./data/raw/ directory as a .jsonl file.

To extract and translate shaders from the shaders20k dataset use:

$>python download.py --mode shaders20k

see download.py --help for more options. Or look at the source

Annotate

$>python annotate.py --mode "redo" --columns "license, functions"
$>python annotate.py --output "./data/annotated/api/" --mode "update" --columns "test" --ids "./data/ids/v4_filtered.txt"

this flattens the nested renderpasses into a single dict and adds relevant information like licenses, function indicies and test-validation. It seems to only do take a few minutes now. alternatively the mode update allows to overwrite the columns of already flattened files. Optionally add --ids with a list of comma separated shaderIDs or path to a file with ids, to only update these.

Filter

$>python filter.py --input "./data/annotated/." --output "./data/prepared/" --filters "all"

This script will use the annoated data and apply a series of filters. Filters are specified in filters.py. The all filter will apply all filters. It outputs a Arrow repo into the specified output directory... allowing it to loaded via datasets.from_disk("../dir/").

License note

The contents of this repository (builder scripts, metadata) are distributed under the Apache 2.0 license. However the contents of the dataset itself are under their respective license. We do our best to annotate licenses to allow for filtering. Please see the field license in the dataset as well as the top of all image_code for details. Some metadata (including licenses) might be out of date, therefore we recommend checking the source