docs: fix stale --features gpu references - #19
Conversation
|
| Filename | Overview |
|---|---|
| ARCHITECTURE.md | Replaces stale GPU feature instructions and clarifies the current separation between the engine and standalone GPU backend. |
| crates/compass-vector-gpu/src/lib.rs | Updates the crate-level Cargo example to depend directly on compass-vector-gpu. |
Reviews (2): Last reviewed commit: "docs: fix stale --features gpu reference..." | Re-trigger Greptile
|
@EdgarBabajanyan mind taking a look? Small docs fix. CI needs your approval to run. |
|
running it, thanks @Karanjot786 |
The compass crate has no gpu feature. ARCHITECTURE.md:66 already says so; two other spots still tell you to build with it. Signed-off-by: Karanjot786 <karanjots801@gmail.com>
924cb62 to
d028521
Compare
|
Pushed the sign-off, dco should pass now. The audit failure is unrelated to this PR. It touches two doc lines and no lockfile. |
ARCHITECTURE.md tells you to build the GPU backend with
--features gpuon the umbrella crate. No such feature exists.crates/compass/Cargo.tomldeclares one opt-in feature,object-storage, and carries no dependency oncompass-vector-gpu.Line 66 of the same file already states this, added by the v0.4 docs truth sweep (1f53904). Two earlier mentions stayed behind. The crate docs in
compass-vector-gpu/src/lib.rsshow a second broken snippet:Wrong feature, and the workspace sits at 0.4.0.
Changes
ARCHITECTURE.md:19, point readers at a direct dependency oncompass-vector-gpu. Adds a note on thegpufeature incompass-index-api, which toggles thegpu_available()helper and pulls in no backend.ARCHITECTURE.md:101, GPU acceleration today covers the embedding step. The CAGRA build path lives in the unwired crate.compass-vector-gpu/src/lib.rs:18, replace the snippet with a git dependency on the crate.Docs only. No behavior change.
Checks
cargo fmt --all --checkcleancargo clippy --workspace --exclude compass-vector-gpu --all-targets -- -D warningscleancargo test --workspace --exclude compass-vector-gpu: 109 passed, 0 failedNeed help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.