UniRL
Guides

Data and Models

Prompt data contracts, local datasets, model packages, and checkpoint mounts.

Data Contract

User-facing datasets are prompt-first. Committed prompt lists live under datasets/ (for example datasets/pickscore/train.txt), while larger datasets should be symlinked or mounted under datasets/ and passed through DATA_PATH or the recipe's data_source block.

DATA_PATH=/abs/path/train.json \
bash examples/run_experiment_single_node.sh diffusion/sd3_trainside

See Data Preparation for the prompt-file formats and the per-prompt schema.

Runtime Model Code

Model implementation packages live under unirl/models/. Use the generated Model Package README for package layout and extension contracts.

Local Checkpoint Mounts

The repository-root models/ directory is for local artifacts (e.g. models/local/), not Python model code. Experiment YAMLs and model configs provide HuggingFace fallbacks through Hydra environment interpolation, for example:

pretrained_model_ckpt_path: ${oc.env:PRETRAINED_MODEL,stabilityai/stable-diffusion-3.5-medium}

Do not commit large model weights such as .bin, .safetensors, .pt, .pth, or .ckpt.

Edit on GitHub

Experiment Recipes

Recipes in the bucketed examples/ tree and how to select one per entrypoint.

Data Preparation

Prompt file formats, the per-prompt schema, image/condition inputs, and how prompts expand into rollout groups.

On this page

Data ContractRuntime Model CodeLocal Checkpoint Mounts