mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-08-27 14:17:10 -04:00
## Description
`compute_optimal_k` in the adaptive sizer takes a `max_k` argument
documented as "Never return more than this (None = no cap)". Every tier
honors that contract except the small-input fast path.
```python
n = len(items)
effective_max = max_k if max_k is not None else n
# Tier 1: Fast path
if n <= 8:
return n
```
The near-total-redundancy branch returns `min(k, effective_max)`, the
standard tier ends with `k = max(min_k, min(k, effective_max))`, and the
zlib validator clamps to `max_k` too. Only the `n <= 8` fast path
returns the raw item count, ignoring the cap.
So a caller that passes a tight budget on a small list gets back more
items than it asked for. For example `compute_optimal_k(items_of_len_8,
max_k=5)` returns `8`, not `5`. The downstream compressor then keeps 8
items when it budgeted for 5, over-filling whatever search/log budget
the cap represented.
## Fix
Return `min(n, effective_max)` on the fast path, matching what the other
tiers already do:
```python
if n <= 8:
return min(n, effective_max)
```
When `max_k` is `None`, `effective_max` is `n`, so `min(n, n) == n` and
the existing "return n unchanged" behavior is preserved. Only the capped
case changes.
## Type of Change
- [x] Bug fix (non-breaking change that fixes an issue)
- [ ] 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
- `headroom/transforms/adaptive_sizer.py`: clamp the `n <= 8` fast path
to `effective_max` so `max_k` is honored on small inputs.
- `tests/test_adaptive_sizer.py`: add `test_small_array_respects_max_k`
asserting a small array honors a tight `max_k` and is unchanged when the
cap is loose.
- `CHANGELOG.md`: Bug Fixes entry.
## Testing
- [ ] Unit tests pass (`pytest`)
- [x] Linting passes (`ruff check .`)
- [x] Type checking passes (`mypy headroom`)
- [x] New tests added for new functionality
- [ ] Manual testing performed
### Test Output
```text
$ uvx ruff@0.15.17 check headroom/transforms/adaptive_sizer.py tests/test_adaptive_sizer.py
All checks passed!
$ uvx ruff@0.15.17 format --check headroom/transforms/adaptive_sizer.py tests/test_adaptive_sizer.py
2 files already formatted
$ uvx mypy@1.20.2 --ignore-missing-imports headroom/transforms/adaptive_sizer.py
Success: no issues found in 1 source file
```
## Real Behavior Proof
- Environment: Windows 11, Python 3.12, `uvx ruff@0.15.17` / `uvx
mypy@1.20.2`. A full `pytest` OOMs this box (ML-stack import), so I
reproduced the tier-1 logic with a dependency-free script and left the
full pytest to CI.
- Exact command / steps: ran both the OLD (`return n`) and NEW (`return
min(n, effective_max)`) fast-path logic for `n=8` across `max_k` in `{3,
5, 20, None}` in a standalone script.
- Observed result: OLD returned `8` for every case (ignoring the cap);
NEW returned `3, 5, 8, 8` respectively, matching the documented contract
and leaving the uncapped case unchanged.
- Not tested: the end-to-end search/log compressor path that supplies
`max_k`; the added unit test exercises `compute_optimal_k` directly, and
the standalone proof pins the fast-path arithmetic.
## 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
- [ ] 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
- [ ] New and existing unit tests pass locally with my changes
- [x] I have updated the CHANGELOG.md if applicable
## Additional Notes
The "unit tests pass locally" box is unchecked because this box's
ML-stack import OOMs a local pytest run; the added test is a pure
dataclass-free check that runs under the normal CI pytest job, and the
behavior is corroborated by the standalone proof above.
---------
Co-authored-by: JerrettDavis <mxjerrett@gmail.com>
222 lines
8 KiB
Python
222 lines
8 KiB
Python
"""Tests for diversity-aware compute_optimal_k in adaptive_sizer."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import json
|
|
|
|
from headroom.transforms.adaptive_sizer import (
|
|
compute_optimal_k,
|
|
compute_unique_bigram_curve,
|
|
)
|
|
|
|
|
|
def test_bigram_curve_cjk_uses_char_bigrams():
|
|
# Spaceless CJK: char bigrams give a real coverage curve (was 1 per item).
|
|
# Same input + expected as the Rust reference test -> proves byte-exact parity.
|
|
assert compute_unique_bigram_curve(["数据库连接失败", "数据库连接成功"]) == [6, 8]
|
|
|
|
|
|
def test_bigram_curve_cjk_single_char_is_unigram():
|
|
assert compute_unique_bigram_curve(["中", "文"]) == [1, 2]
|
|
|
|
|
|
def test_bigram_curve_ascii_unchanged():
|
|
# non-CJK behavior is byte-identical to before the CJK branch
|
|
assert compute_unique_bigram_curve(["the cat", "the dog", "a fish"]) == [1, 2, 3]
|
|
assert compute_unique_bigram_curve(["hello", "world", "hello"]) == [1, 2, 2]
|
|
|
|
|
|
def test_bigram_curve_empty_string_contributes_one():
|
|
# mirrors the Rust reference test for the empty-item ("", "") path
|
|
assert compute_unique_bigram_curve(["", "a", "a b"]) == [1, 2, 3]
|
|
|
|
|
|
def _make_unique_items(n: int) -> list[str]:
|
|
"""Create n completely unique JSON items (high diversity)."""
|
|
return [
|
|
json.dumps(
|
|
{
|
|
"id": i,
|
|
"title": f"Unique topic number {i} about subject area {chr(65 + i % 26)}",
|
|
"content": (
|
|
f"This is document {i} discussing a completely different subject. "
|
|
f"It covers concepts like {chr(65 + i % 26)}-theory, "
|
|
f"methodology-{i * 7 % 100}, and framework-{i * 13 % 50}. "
|
|
f"The key finding is result-{i} which has implications for field-{i % 10}."
|
|
),
|
|
"source": f"source_{i}.pdf",
|
|
"score": round(0.99 - i * 0.03, 2),
|
|
}
|
|
)
|
|
for i in range(n)
|
|
]
|
|
|
|
|
|
def _make_repetitive_items(n: int, templates: int = 3) -> list[str]:
|
|
"""Create n items from a few templates (low diversity)."""
|
|
base_templates = [
|
|
{
|
|
"status": "ok",
|
|
"message": "Health check passed",
|
|
"latency_ms": 12,
|
|
"service": "api-gateway",
|
|
},
|
|
{
|
|
"status": "ok",
|
|
"message": "Health check passed",
|
|
"latency_ms": 15,
|
|
"service": "auth-service",
|
|
},
|
|
{
|
|
"status": "ok",
|
|
"message": "Health check passed",
|
|
"latency_ms": 8,
|
|
"service": "db-proxy",
|
|
},
|
|
]
|
|
return [
|
|
json.dumps({**base_templates[i % templates], "timestamp": f"2026-03-25T10:{i:02d}:00Z"})
|
|
for i in range(n)
|
|
]
|
|
|
|
|
|
def _make_mixed_items(n: int, unique_fraction: float) -> list[str]:
|
|
"""Create items where unique_fraction are unique, rest are duplicates."""
|
|
unique_count = int(n * unique_fraction)
|
|
dup_count = n - unique_count
|
|
items = _make_unique_items(unique_count)
|
|
if dup_count > 0:
|
|
template = json.dumps(
|
|
{
|
|
"status": "ok",
|
|
"message": "Routine health check passed successfully",
|
|
"latency_ms": 10,
|
|
}
|
|
)
|
|
items.extend([template] * dup_count)
|
|
return items
|
|
|
|
|
|
class TestSmallArrays:
|
|
def test_small_array_returns_n(self):
|
|
"""Arrays with n <= 8 should always return n (unchanged)."""
|
|
items = _make_unique_items(5)
|
|
assert compute_optimal_k(items) == 5
|
|
|
|
def test_eight_items_returns_eight(self):
|
|
items = _make_unique_items(8)
|
|
assert compute_optimal_k(items) == 8
|
|
|
|
def test_small_array_respects_max_k(self):
|
|
"""A small array (n <= 8) must still honor a tight ``max_k`` cap.
|
|
|
|
``max_k`` is documented as "never return more than this"; the fast path
|
|
used to return the raw ``n`` and blow past a small cap.
|
|
"""
|
|
items = _make_unique_items(8)
|
|
assert compute_optimal_k(items, max_k=5) == 5
|
|
assert compute_optimal_k(items, max_k=3) == 3
|
|
# A cap >= n leaves the array unchanged.
|
|
assert compute_optimal_k(items, max_k=20) == 8
|
|
|
|
|
|
class TestNearTotalRedundancy:
|
|
def test_identical_items_returns_min(self):
|
|
"""20 identical items should return ~3 (near-total redundancy)."""
|
|
items = [json.dumps({"status": "ok", "msg": "healthy"})] * 20
|
|
k = compute_optimal_k(items)
|
|
assert k <= 3
|
|
|
|
def test_two_groups_returns_small_k(self):
|
|
"""Items from 2 groups should return small k."""
|
|
items = [json.dumps({"type": "A", "val": 1})] * 10 + [
|
|
json.dumps({"type": "B", "val": 2})
|
|
] * 10
|
|
k = compute_optimal_k(items)
|
|
assert k <= 5
|
|
|
|
|
|
class TestHighDiversity:
|
|
def test_all_unique_keeps_most(self):
|
|
"""15 completely unique items → should keep >= 10 (not 4 like before)."""
|
|
items = _make_unique_items(15)
|
|
k = compute_optimal_k(items)
|
|
assert k >= 10, f"Expected k >= 10 for 15 unique items, got k={k}"
|
|
|
|
def test_twenty_unique_keeps_most(self):
|
|
"""20 unique items → should keep >= 14."""
|
|
items = _make_unique_items(20)
|
|
k = compute_optimal_k(items)
|
|
assert k >= 14, f"Expected k >= 14 for 20 unique items, got k={k}"
|
|
|
|
def test_twelve_unique_rag_chunks(self):
|
|
"""12 unique RAG chunks → should keep >= 8."""
|
|
items = _make_unique_items(12)
|
|
k = compute_optimal_k(items)
|
|
assert k >= 8, f"Expected k >= 8 for 12 unique RAG chunks, got k={k}"
|
|
|
|
|
|
class TestLowDiversity:
|
|
def test_repetitive_items_unchanged(self):
|
|
"""15 items from 3 templates → k should stay small (same as before)."""
|
|
items = _make_repetitive_items(15, templates=3)
|
|
k = compute_optimal_k(items)
|
|
assert k <= 8, f"Expected k <= 8 for repetitive items, got k={k}"
|
|
|
|
def test_twenty_repetitive_stays_small(self):
|
|
"""20 items from 3 templates → k stays small."""
|
|
items = _make_repetitive_items(20, templates=3)
|
|
k = compute_optimal_k(items)
|
|
assert k <= 10, f"Expected k <= 10 for 20 repetitive items, got k={k}"
|
|
|
|
|
|
class TestModerateDiversity:
|
|
def test_half_unique_scales(self):
|
|
"""20 items, 50% unique → k should be in middle range."""
|
|
items = _make_mixed_items(20, unique_fraction=0.5)
|
|
k = compute_optimal_k(items)
|
|
assert 6 <= k <= 16, f"Expected 6 <= k <= 16 for 50% unique, got k={k}"
|
|
|
|
|
|
class TestKneeInteraction:
|
|
def test_knee_with_high_diversity_gets_floor(self):
|
|
"""Even if knee is found at low value, high diversity boosts k."""
|
|
# Create items that have a weak bigram knee but are all unique via SimHash
|
|
items = _make_unique_items(15)
|
|
k = compute_optimal_k(items)
|
|
# With diversity_ratio ~1.0, diversity_floor should boost k
|
|
assert k >= 10, f"Expected k >= 10 with high diversity floor, got k={k}"
|
|
|
|
def test_knee_with_low_diversity_stays(self):
|
|
"""Low diversity + knee found → k stays at knee."""
|
|
items = _make_repetitive_items(15, templates=3)
|
|
k = compute_optimal_k(items)
|
|
assert k <= 8, f"Expected knee-derived k <= 8 for low diversity, got k={k}"
|
|
|
|
|
|
class TestBiasAndCaps:
|
|
def test_bias_increases_k(self):
|
|
"""Bias > 1 should increase k."""
|
|
items = _make_unique_items(15)
|
|
k_normal = compute_optimal_k(items, bias=1.0)
|
|
k_biased = compute_optimal_k(items, bias=1.5)
|
|
assert k_biased >= k_normal
|
|
|
|
def test_bias_decreases_k(self):
|
|
"""Bias < 1 should decrease k."""
|
|
items = _make_unique_items(15)
|
|
k_normal = compute_optimal_k(items, bias=1.0)
|
|
k_biased = compute_optimal_k(items, bias=0.5)
|
|
assert k_biased <= k_normal
|
|
|
|
def test_max_k_cap_respected(self):
|
|
"""Even with high diversity, max_k cap is honored."""
|
|
items = _make_unique_items(20)
|
|
k = compute_optimal_k(items, max_k=5)
|
|
assert k <= 5
|
|
|
|
def test_min_k_floor_respected(self):
|
|
"""Even with low diversity, min_k floor is honored."""
|
|
items = [json.dumps({"x": 1})] * 20
|
|
k = compute_optimal_k(items, min_k=3)
|
|
assert k >= 3
|