headroom/tests/test_dataset_recall_runner.py
Ashish 46d4378cf7
feat(evals): weekly HotpotQA answer-recall report on the prose path (#1188)
## Description

Follow-up to **#1187** (the offline fidelity gate). That gate is
hermetic and **structured-only** (JSON tool outputs via Rust
compressors) so it can block every PR with zero setup. This PR adds the
genuinely-uncovered piece: **prose answer-recall on a real dataset
(HotpotQA)** in the **model-allowed weekly job**, where compression
routes through Kompress (ModernBERT).

> **Stacked on #1187.** Until that merges, this PR's diff shows its
commit too; it reduces to just `c71cc0cb` once #1187 lands. Please
review/merge #1187 first.

Closes #

## Type of Change

- [ ] Bug fix (non-breaking change that fixes an issue)
- [x] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
- [ ] Documentation update
- [ ] Performance improvement
- [ ] Code refactoring (no functional changes)

## Changes Made

- **`CompressionOnlyRunner.evaluate_dataset_recall(suite)`**: for each
QA case, compress the supporting `context` via the production routing
path (`ContentRouter`) and check the `ground_truth` answer survives
(`compute_information_recall`). Counts only **probeable** cases — answer
literally present in the context and non-trivial (skips `yes/no`,
too-short) — so the aggregate is meaningful rather than inflated by
un-measurable cases.
- **`.github/workflows/eval.yml`**: a non-blocking step in the existing
`weekly-suite` job (schedule/manual only) drives it with
`load_hotpotqa(n=50)`. Defensive: a dataset download or model failure
emits `:⚠️:` and `|| true`, never failing the job.
- **Hermetic unit test** (`tests/test_dataset_recall_runner.py`):
exercises the method with synthetic JSON-array contexts (SmartCrusher /
Rust — no model, no network), so it runs in the standard `[dev]` shard.

### Scope notes

- **Prose path only.** BFCL / tool-schema integrity is already covered
by the existing `evaluate_tool_schema_compaction` eval (which runs in
the PR smoke-test), so this targets the previously-uncovered prose
recall path. NQ is an easy further extension using the same method +
`load_natural_questions`.
- **Why weekly, not per-PR.** Real datasets need a network download +
the ModernBERT model. The `weekly-suite` job already installs `[all]`
and genuinely runs every Monday (verified: 5 consecutive successful
scheduled runs), so it's the correct home — keeping PR CI fast and
hermetic.

## Testing

- [x] Unit tests pass (`pytest`)
- [x] Linting passes (`ruff check .`)
- [x] Type checking passes (`mypy headroom`)
- [x] New tests added for new functionality
- [x] Manual testing performed

### Test Output

```text
$ HF_HUB_OFFLINE=1 python -m pytest tests/test_dataset_recall_runner.py -q
..                                                                       [100%]
2 passed in 0.20s
```

## Real Behavior Proof

- Environment: local checkout of `feat/weekly-dataset-recall`, `pip
install -e ".[dev]"`, `HF_HUB_OFFLINE=1` (proves the unit tests need no
model/network)
- Exact command / steps: `HF_HUB_OFFLINE=1 python -m pytest
tests/test_dataset_recall_runner.py -q` -> `6 passed in 0.36s`; coverage
JSON confirms the runner's per-case exception handler and both
`warm_kompress_model` outcomes are exercised
- Observed result: with a synthetic suite of 3 cases (one probeable
answer in an error row, one trivial `yes`, one absent answer),
`evaluate_dataset_recall` counts only the 1 probeable case (`passed=1`,
`accuracy_rate=1.0`, `benchmark="dataset_recall:synthetic"`); a
monkeypatched compressor crash records the error and counts the case
failed instead of aborting; the new weekly-suite YAML step parses via
`yaml.safe_load` and sits under the `schedule || workflow_dispatch`
guard
- Not tested: the live HotpotQA download + ModernBERT compression --
exercised only by the weekly job (or `workflow_dispatch`), by design

## Review Readiness

- [x] I have performed a self-review
- [x] This PR is ready for human review

## Checklist

- [x] My code follows the project's style guidelines
- [x] I have performed a self-review of my code
- [x] I have commented my code, particularly in hard-to-understand areas
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [x] I have added tests that prove my fix is effective or that my
feature works
- [x] New and existing unit tests pass locally with my changes
- [ ] I have updated the CHANGELOG.md if applicable

## Additional Notes

- CHANGELOG/version intentionally untouched: repo uses
**release-please**.
- The weekly job can be triggered on demand via **workflow_dispatch** to
see the HotpotQA recall numbers without waiting for Monday.

---------

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
Co-authored-by: JD Davis <mxjerrett@gmail.com>
2026-07-15 21:40:55 +00:00

119 lines
4.7 KiB
Python

"""Hermetic unit tests for CompressionOnlyRunner.evaluate_dataset_recall.
Exercises the dataset-recall plumbing with synthetic JSON-array contexts (which
route through SmartCrusher / Rust — no model, no network) so it runs in the
standard [dev] shard. The weekly job drives the same method with real prose
datasets (HotpotQA), which is intentionally not exercised here.
"""
from __future__ import annotations
import json
from headroom.evals.core import EvalCase, EvalSuite
from headroom.evals.runners.compression_only import CompressionOnlyRunner
def _array_context_with(answer: str) -> str:
"""A JSON-array tool output whose error row embeds ``answer`` (a kept row)."""
rows = [{"seq": i, "level": "INFO", "status": "ok", "msg": f"heartbeat {i}"} for i in range(30)]
rows[14] = {"seq": 14, "level": "ERROR", "status": "failed", "msg": answer}
return json.dumps(rows)
def _suite() -> EvalSuite:
answer = "PaymentService NullPointerException at charge line 88"
return EvalSuite(
name="synthetic",
cases=[
# Probeable: answer is in an error row -> retained -> recall 1.0.
EvalCase(
id="probeable",
context=_array_context_with(answer),
query="what failed?",
ground_truth=answer,
),
# Skipped: trivial yes/no answer.
EvalCase(
id="trivial",
context=_array_context_with(answer),
query="did it fail?",
ground_truth="yes",
),
# Skipped: answer not present in the context at all.
EvalCase(
id="absent",
context=_array_context_with(answer),
query="?",
ground_truth="totally-absent-token-xyz",
),
],
)
def test_dataset_recall_counts_only_probeable_cases() -> None:
result = CompressionOnlyRunner().evaluate_dataset_recall(_suite())
# Only the "probeable" case is measurable; trivial + absent are skipped.
assert result.total_cases == 1
assert result.passed_cases == 1
assert result.accuracy_rate == 1.0
assert result.benchmark == "dataset_recall:synthetic"
def test_dataset_recall_empty_suite_is_safe() -> None:
result = CompressionOnlyRunner().evaluate_dataset_recall(EvalSuite(name="empty", cases=[]))
assert result.total_cases == 0
assert result.accuracy_rate == 0.0
assert result.errors == []
def test_dataset_recall_records_compression_errors(monkeypatch) -> None:
# A compressor crash on one case must not abort the run: the case counts
# as failed, the error is recorded, and the detail row carries it.
from headroom.transforms.content_router import ContentRouter
def _boom(self, content, context="", question=None, bias=1.0):
raise RuntimeError("router exploded")
monkeypatch.setattr(ContentRouter, "compress", _boom)
result = CompressionOnlyRunner().evaluate_dataset_recall(_suite())
assert result.total_cases == 1
assert result.failed_cases == 1
assert result.passed_cases == 0
assert result.errors and "router exploded" in result.errors[0]
assert result.details[0]["passed"] is False
assert "router exploded" in result.details[0]["error"]
def test_warm_kompress_model_returns_false_when_unavailable(monkeypatch) -> None:
# Guard path: no Kompress backend -> no download attempt, returns False.
import headroom.transforms.kompress_compressor as kc
monkeypatch.setattr(kc, "is_kompress_available", lambda: False)
assert kc.warm_kompress_model() is False
def test_warm_kompress_model_true_when_load_populates_cache(monkeypatch) -> None:
# Success path: the synchronous load lands the model in the cache.
import headroom.transforms.kompress_compressor as kc
cache: dict[str, object] = {}
monkeypatch.setattr(kc, "_kompress_cache", cache)
monkeypatch.setattr(kc, "is_kompress_available", lambda: True)
monkeypatch.setattr(
kc,
"_load_kompress",
lambda model_id, device, allow_download: cache.setdefault(model_id, object()),
)
assert kc.warm_kompress_model("test-model") is True
def test_warm_kompress_model_false_when_load_leaves_cache_empty(monkeypatch) -> None:
# The loader returned without raising but the model never landed in the
# cache (e.g. download disallowed and not cached locally).
import headroom.transforms.kompress_compressor as kc
monkeypatch.setattr(kc, "_kompress_cache", {})
monkeypatch.setattr(kc, "is_kompress_available", lambda: True)
monkeypatch.setattr(kc, "_load_kompress", lambda model_id, device, allow_download: None)
assert kc.warm_kompress_model("test-model", allow_download=False) is False