docs: add concise evaluation section with CLI workflows
Browse files
README.md
CHANGED
|
@@ -84,6 +84,53 @@ Full benchmark execution code and reproducibility artifacts are available in the
|
|
| 84 |
|
| 85 |
Evaluation note: initial_state, expected_outcome, required_effects, oracle_spec, and fault-injection metadata are published for reproducibility and are not provided to evaluated agents as privileged runtime inputs.
|
| 86 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 87 |
## Paper & Code
|
| 88 |
|
| 89 |
* [Paper (arXiv)](https://arxiv.org/abs/2610.05622)
|
|
|
|
| 84 |
|
| 85 |
Evaluation note: initial_state, expected_outcome, required_effects, oracle_spec, and fault-injection metadata are published for reproducibility and are not provided to evaluated agents as privileged runtime inputs.
|
| 86 |
|
| 87 |
+
## Evaluation
|
| 88 |
+
|
| 89 |
+
The executable UndoBench evaluation harness is available in the [GitHub repository](https://github.com/tradertanmay/undobench).
|
| 90 |
+
|
| 91 |
+
Install and verify the benchmark:
|
| 92 |
+
|
| 93 |
+
```bash
|
| 94 |
+
git clone https://github.com/tradertanmay/undobench.git
|
| 95 |
+
cd undobench
|
| 96 |
+
pip install -e ".[all]"
|
| 97 |
+
undobench doctor
|
| 98 |
+
undobench smoke
|
| 99 |
+
```
|
| 100 |
+
|
| 101 |
+
Evaluate a custom agent on the validation split:
|
| 102 |
+
|
| 103 |
+
```bash
|
| 104 |
+
undobench run \
|
| 105 |
+
--agent my_agent.py:MyAgent \
|
| 106 |
+
--split validation \
|
| 107 |
+
--recovery none \
|
| 108 |
+
--seeds 42 \
|
| 109 |
+
--output runs
|
| 110 |
+
```
|
| 111 |
+
|
| 112 |
+
Or evaluate an OpenAI-compatible model endpoint:
|
| 113 |
+
|
| 114 |
+
```bash
|
| 115 |
+
undobench run \
|
| 116 |
+
--model openai/<model-name> \
|
| 117 |
+
--split validation \
|
| 118 |
+
--recovery naive \
|
| 119 |
+
--seeds 42 \
|
| 120 |
+
--output runs
|
| 121 |
+
```
|
| 122 |
+
|
| 123 |
+
After a run, recompute metrics and generate a standardized report:
|
| 124 |
+
|
| 125 |
+
```bash
|
| 126 |
+
undobench evaluate runs/<run_id>
|
| 127 |
+
undobench report runs/<run_id>
|
| 128 |
+
```
|
| 129 |
+
|
| 130 |
+
UndoBench reports task competence and recovery metrics including Control Pass Rate, RSR, CRSR, EOR, DER, and MER.
|
| 131 |
+
|
| 132 |
+
The frozen test split is protected from accidental execution by default. See the GitHub documentation for TEST execution, custom-agent integration, HTTP agents, recovery baselines, and result submission.
|
| 133 |
+
|
| 134 |
## Paper & Code
|
| 135 |
|
| 136 |
* [Paper (arXiv)](https://arxiv.org/abs/2610.05622)
|