{"data":{"kind":"file","path":"README.md","version_id":"qrav7t2j4rh3jcpnb02tcaq7","entry":{"name":"README.md","path":"README.md","is_directory":false,"size":1653,"modified_at":"2025-10-19T06:06:08.140000","content_hash":"1452cd4be16807b89db1eb3ad97b45977127f9a54d5db2b38926d111c9cb113f"},"entries":[],"content":"# wordle\n\n### Overview\n- **Environment ID**: `wordle`\n- **Short description**: Multi-turn Wordle game environment with optional `<think>` reasoning; rewards correctness, partial credit, turns, and format.\n- **Tags**: games, multi-turn, wordle, xml, feedback\n\n### Datasets\n- **Primary dataset(s)**: TextArena `Wordle-v0` (environment provides episodes)\n- **Source links**: TextArena\n- **Split sizes**: Number of episodes controlled via args\n\n### Task\n- **Type**: multi-turn (game interaction)\n- **Parser**: `XMLParser` with `think`/`guess` or just `guess` depending on `use_think`\n- **Rubric overview**: Exact guess match, partial credit from feedback, turns-based reward, and format check\n\n### Quickstart\nRun an evaluation with default settings:\n\n```bash\nuv run vf-eval wordle\n```\n\nConfigure model and sampling:\n\n```bash\nuv run vf-eval wordle \\\n  -m gpt-4.1-mini \\\n  -n 20 -r 3 -t 1024 -T 0.7 \\\n  -a '{\"num_train_examples\": 2000, \"num_eval_examples\": 20, \"use_think\": true}'\n```\n\n### Environment Arguments\n| Arg | Type | Default | Description |\n| --- | ---- | ------- | ----------- |\n| `num_train_examples` | int | `2000` | Number of training episodes |\n| `num_eval_examples` | int | `20` | Number of evaluation episodes |\n| `use_think` | bool | `true` | Use `<think>` with `guess`; if false, guess-only format |\n\n### Metrics\n| Metric | Meaning |\n| ------ | ------- |\n| `check_answer_reward_func` | 1.0 if final guess equals target, else 0.0 |\n| `partial_credit_reward_func` | Partial credit from greens/yellows in feedback |\n| `count_turns_reward_func` | Higher score for solving in fewer turns |\n| `format_reward` | Adherence to expected XML format |\n","encoding":"utf-8","truncated":false,"total_bytes":1653},"status":null}