Skip to content

docs: track headroom 0.31.0 (no new library compress() knobs) #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lkosewsk wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: track headroom 0.31.0 (no new library compress() knobs) #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -424,13 +424,13 @@ The default configuration (what `GET /config` returns out of the box):
"min_tokens_to_compress": 250,
"kompress_model": null,
"savings_profile": null,
"headroom_version": "0.30.0"
"headroom_version": "0.31.0"
}
```

`headroom_version` is read-only — the headroom-ai version tsheadroom detected on its workers (omitted until the first worker reports ready). It's informational and reflects which knobs the running headroom can actually honor.

The tunable surface below tracks headroom-ai's library `compress()` API, which is intentionally stable: 0.27.0 through 0.30.0 added no new `CompressConfig` knobs, so the fields here are unchanged since 0.26.0 (which introduced `savings_profile`). The one profile-surface change is that 0.30.0 added the `coding` and `general` presets alongside `agent-90` and `balanced`. Newer headroom releases still improve the compression that runs *inside* `compress()` — you get those automatically with no config change. The extra power those releases added (e.g. `force_kompress`, `--protect-tool-results`) lives in headroom's proxy pipeline, which `compress()` does not expose.
The tunable surface below tracks headroom-ai's library `compress()` API, which is intentionally stable: 0.27.0 through 0.31.0 added no new `CompressConfig` knobs, so the fields here are unchanged since 0.26.0 (which introduced `savings_profile`). The one profile-surface change is that 0.30.0 added the `coding` and `general` presets alongside `agent-90` and `balanced`. Newer headroom releases still improve the compression that runs *inside* `compress()` — you get those automatically with no config change. The extra power those releases added (e.g. `force_kompress`, `--protect-tool-results`) lives in headroom's proxy pipeline, which `compress()` does not expose.

Changes take effect on the next request. Invalid values are rejected with `400` and leave the current configuration untouched (for example, `target_ratio: 5` → `target_ratio must be in (0, 1] or null`; `savings_profile: "fast"` → `savings_profile must be one of agent-90, balanced, coding, general, or null`). You can also edit the `-config` JSON file directly and restart.

Expand Down
Loading