Release 1.5.0 - #23
Merged
Merged
Conversation
Cut the accumulated Unreleased work as 1.5.0 rather than a patch: the release adds two environment variables (TRAVSR_EMBED_ENGINE, TRAVSR_EMBED_TOKEN_BUDGET) and the macos_engine model.toml field, and changes the macOS default engine, which is minor-bump surface under the semver policy this changelog states. Changelog: document the two PRs that landed without entries, #18 (free the old HNSW before reload, cap ORT thread pools, mmap the serving index, chunk the pending query) and #22 (budget inference tokens across workers instead of per worker). README: the Apple Silicon guidance still claimed CoreML runs by default, which the 1.5.0 engine flip reverses. Rewrite that row and the asset intro, and document engine selection on macOS plus the environment variables, none of which were described anywhere.
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.
Cuts the accumulated
Unreleasedwork as 1.5.0.Why 1.5.0 and not 1.4.1
This was scoped as a patch, but the unreleased work is minor-bump surface under the semver policy the changelog states:
TRAVSR_EMBED_ENGINEandTRAVSR_EMBED_TOKEN_BUDGETmodel.tomlfield,macos_engineConsumers pinning
~1.4.0should not silently inherit the macOS engine flip.Changelog
Two merged PRs had landed with no changelog entry at all. Both are now documented:
available_parallelism()and inter-op at 1 (ORT otherwise sizes pools from the host, so a 2-CPU container on a 64-core host got roughly 64 spinning threads), mmap the serving index on Linux/macOS, and chunk the pending query instead of materialising the whole corpus.workers x budget, so a fixed per-worker 4,096 made memory grow linearly with-j. A total of 8,192 is now divided by workers, floored at 1,024, capped at 4,096. One and two workers keep exactly 4,096, so the configurations where the old default was right do not regress.The pre-existing entries for the macOS engine flip and the travsr#735 crash-residue hardening are unchanged apart from the release heading.
afc6ca8(clippychunks_exactmigration for Rust 1.98) is deliberately not listed: no behaviour change, CI lint only.README
The Apple Silicon guidance had gone stale, claiming CoreML runs by default, which is exactly what this release reverses. Updated:
macos_enginevalues, including the caveat thattravsr embed initrewritesmodel.tomland drops a hand-set valueTRAVSR_EMBED_ENGINE,TRAVSR_EMBED_TOKEN_BUDGETandORT_DYLIB_PATH, none of which were described anywhere beforeVerification
cargo metadata --lockedpasses, soCargo.lockagrees with the bumped manifest and the release build will not fail on a stale lock.A local
cargo build --releasecould not complete on this machine: theusearch2.24 build script fails compilingsimsimd's AVX-512 FP16 intrinsics under gcc 11.4 (Ubuntu 22.04). That is a pre-existing environment limitation in a third-party build script that runs before any crate source compiles, unrelated to these changes, all of which are docs plus a version string. CI is the real check here.Next step
Tag
v1.5.0on the merge commit to triggerrelease.yml.