microsoft-SkillOpt/skillopt/envs/_template

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 4 abstract methods so the file is instantiable out of the box — reflect is inherited).
• loader_template.py — Data loader template (subclasses SplitDataLoader; implements load_split_items for .json/.jsonl).
• config_template.yaml — Config file template.

Usage

1. Copy the directory:

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

2. 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.
3. Implement the TODO blocks inside adapter.py:rollout and the _normalize_item helper in dataloader.py. (reflect is inherited from EnvAdapter; override it only for custom reflection logic.)
4. 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.
5. 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.