Files

T

Shunsuke 54e4b3eafb docs: align benchmark guide and template with dataloader.py naming

The new-benchmark guide and the env template README referred to the data
loader file as loader.py, but all six built-in benchmarks name it
dataloader.py (skillopt/envs/<name>/dataloader.py). Update the docs and
the template rename step to match the actual convention.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

2026-06-09 12:20:01 +08:00

config_template.yaml

envs/_template: make template instantiable against real EnvAdapter ABC

2026-06-01 20:15:12 +00:00

env_template.py

envs/_template: make template instantiable against real EnvAdapter ABC

2026-06-01 20:15:12 +00:00

loader_template.py

envs/_template: make template instantiable against real EnvAdapter ABC

2026-06-01 20:15:12 +00:00

README.md

docs: align benchmark guide and template with dataloader.py naming

2026-06-09 12:20:01 +08:00

README.md

Benchmark Template

This directory provides scaffold files for adding a new benchmark to SkillOpt.

Files

env_template.py — Environment adapter template (subclasses EnvAdapter; implements the 5 abstract methods so the file is instantiable out of the box).
loader_template.py — Data loader template (subclasses SplitDataLoader; implements load_split_items for .json/.jsonl).
config_template.yaml — Config file template.

Usage

Copy the directory:

cp -r skillopt/envs/_template skillopt/envs/your_benchmark

Rename the files (drop the _template suffix):
```
cd skillopt/envs/your_benchmark
mv env_template.py    adapter.py
mv loader_template.py dataloader.py
```
…and inside each file rename the classes (TemplateBenchmarkEnv → YourBenchmarkAdapter, TemplateBenchmarkLoader → YourBenchmarkLoader) and fix the cross-import in adapter.py.
Implement the TODO blocks inside adapter.py:rollout and the _normalize_item helper in dataloader.py. If you want real reflection, uncomment the run_minibatch_reflect block in adapter.py:reflect.
Register the adapter — add a try / except ImportError block in scripts/train.py's _register_builtins() mapping the registry key to your YourBenchmarkAdapter class. There is no BENCHMARK_REGISTRY dict in skillopt/envs/__init__.py; the live registry is _ENV_REGISTRY in scripts/train.py.
Create the config at configs/your_benchmark/default.yaml (start from config_template.yaml). _base_ is a string path, not a list.

See the Add a New Benchmark guide for the full step-by-step with a worked docfaithful example.