Repository navigation
feat: add performance overhead benchmark, link checker & prepare v0.2.5 - #25
Merged
MUDASSIR-75 merged 7 commits intoNov 13, 2026
Conversation
…nchmark and add Roadmap sections
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
Implements the deliverables for v0.2.5, replacing anecdotal overhead claims with a reproducible benchmark harness, verifying documentation links, and entering feature freeze ahead of the v0.3.0 stable release.
Key Changes
tests/benchmarks/): Added a 1,000-step synthetic stream generator and runner to measure per-step check latency across all detectors and embedder backends.docs/performance.mdexplaining the benchmark methodology, memory profile, and local reproduction steps.README.mdto reflect measured performance and distinguish hash-based embeddings from neural embeddings.README.mdandCONTRIBUTING.md.scripts/check_links.py): Added automated validation for local markdown links and anchors, wired into CI and release gates.0.2.5, updatedCHANGELOG.md, and locked runtime changes for feature freeze.Compatibility