docs(workers): document per-operation slot reservations (#1199)#1207
Merged
nicoloboschi merged 2 commits intoApr 23, 2026
Merged
Conversation
nicoloboschi
approved these changes
Apr 23, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
#1199 (merged 2026-04-22 by @nicoloboschi) added three new worker-slot reservation env vars and introduced a shared-pool overflow model, but
hindsight-docs/docs/developer/configuration.mdstill only documents the pre-#1199 two-slot-pool model. Users following the docs won't know they can reserve slots forretain/file_convert_retain/refresh_mental_model, and the admonition's claim that "retain and other non-consolidation tasks may use at most 10 − 2 = 8 concurrent slots" no longer reflects the new semantics.This PR:
sum of reservations > WORKER_MAX_SLOTSraisesValueErrorat startup).skills/hindsight-docs/references/developer/configuration.md.Values verified against
hindsight-api-slim/hindsight_api/config.py:WORKER_SLOT_RESERVATION_TYPESdict (defaults:consolidation=2,retain=0,file_convert_retain=0,refresh_mental_model=0).total_reserved > self.worker_max_slotsraisingValueErrorwith message "Reduce reservations or increase HINDSIGHT_API_WORKER_MAX_SLOTS".Pure docs, no behavior change.