Skip to content

docs: document fit_mode="fit_with_cache" in the README - #354

Merged
ggprior merged 2 commits into
mainfrom
docs/kv-cache-readme
Aug 11, 2026
Merged

docs: document fit_mode="fit_with_cache" in the README#354
ggprior merged 2 commits into
mainfrom
docs/kv-cache-readme

Conversation

@ggprior

@ggprior ggprior commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Georg written description: just docs

Claude generated description

fit_mode and api_mode are the headline additions of 0.4.x and neither appears in the README. This adds a KV Cache section next to Thinking Mode, matching its shape: one-line purpose, a snippet, the model_id_ fit-once-predict-many pattern, and three notes.

Kept to the caller's view — what the flag does for them, not how it is served.

Two claims I checked against prod rather than assuming: predictions match the uncached path, and a reused model_id_ returns the original class labels without setting classes_ (an earlier draft said otherwise).

api_mode is still undocumented; separate PR.

ggprior and others added 2 commits August 11, 2026 10:31
Adds a KV Cache section next to Thinking Mode: what the flag is for, the
fit-once-predict-many shape via `model_id_`, and the thinking-mode
incompatibility.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The cache is built during fit(), not warmed by the first predict.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@ggprior
ggprior marked this pull request as ready for review August 11, 2026 10:05
@ggprior
ggprior requested a review from a team as a code owner August 11, 2026 10:05
@ggprior
ggprior added this pull request to the merge queue Aug 11, 2026
Merged via the queue into main with commit 4707595 Aug 11, 2026
10 checks passed
@ggprior
ggprior deleted the docs/kv-cache-readme branch August 11, 2026 11:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants