Skip to content

Commit a6c87f5

Browse files
committed
0.8.0: bump Cargo.toml + CHANGELOG + module-doc version refs
Cuts the 0.8.0 release branch. Tagging and publishing held for explicit trigger; this commit is local-only and only updates version metadata. Cargo.toml: 0.7.2 -> 0.8.0 CHANGELOG.md: new [0.8.0] - 2026-04-27 section under Keep-a-Changelog format. Documents the two breaking changes (esg -> range_filtered rename + spectral pub -> pub(crate)) under "Changed (breaking)" and includes a diff-style migration block from 0.7.x. src/lib.rs install snippet + 19 module-level //! doc snippets bumped from `version = "0.7"` to `version = "0.8"`. README install block unchanged (was already 0.7-pinned; bumped to 0.8 in the same sweep). Verification at this commit: cargo fmt --check clean cargo clippy --no-default-features --features hnsw --all-targets -- -D warnings clean cargo clippy --all-features --all-targets -- -D warnings clean cargo nextest run --no-default-features --features hnsw 314/314 pass cargo nextest run --lib --all-features 400/400 pass Tag + publish workflow trigger held: per personal-style rule, version bumps only land in-tree when about to publish, but the user wants the release-ready state captured. Next step is `git tag v0.8.0 && git push --tags` followed by `gh workflow run publish.yml -f confirm=publish`, gated on user say-so.
1 parent 25c8d7d commit a6c87f5

22 files changed

Lines changed: 67 additions & 26 deletions

File tree

CHANGELOG.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,47 @@ series is unstable: minor bumps may break the public API.
77

88
## [Unreleased]
99

10+
## [0.8.0] - 2026-04-27
11+
12+
### Changed (breaking)
13+
14+
- Renamed `esg` module to `range_filtered`. The 0.7.x `esg` name implied
15+
fidelity to the partition-aware structure of Yang et al. 2025
16+
(arXiv:2504.04018); the shipped implementation is the paper's
17+
strawman baseline (HNSW + attribute-range post-filter), so the rename
18+
reflects what the module actually does. A paper-fidelity ESG variant
19+
is planned as a separate module.
20+
- `EsgIndex` -> `RangeFilteredIndex`
21+
- `EsgParams` -> `RangeFilteredParams`
22+
- feature `esg` -> `range_filtered`
23+
- module path `vicinity::esg::*` -> `vicinity::range_filtered::*`
24+
- `RangeFilteredParams::num_checkpoints` removed (was deprecated in
25+
0.7.3; the partition-aware path that consumed it was never
26+
implemented).
27+
- `vicinity::spectral` module visibility downgraded from `pub` to
28+
`pub(crate)`. The Marchenko-Pastur helpers were reachable only via
29+
`ADSamplingState::new_auto`, which has no production consumer. The
30+
`rmt-spectral` feature and the `rmt` dep remain available for the
31+
internal `new_auto` path; the public wrappers `mp_lambda_plus` and
32+
`count_mp_outliers` are no longer accessible from outside the crate.
33+
34+
### Migration from 0.7.x
35+
36+
```diff
37+
-vicinity = { version = "0.7", features = ["esg"] }
38+
+vicinity = { version = "0.8", features = ["range_filtered"] }
39+
40+
-use vicinity::esg::{EsgIndex, EsgParams};
41+
+use vicinity::range_filtered::{RangeFilteredIndex, RangeFilteredParams};
42+
43+
let params = EsgParams {
44+
- num_checkpoints: 16, // remove
45+
hnsw_m: 16,
46+
hnsw_ef_construction: 200,
47+
ef_search: 100,
48+
};
49+
```
50+
1051
## [0.7.2] - 2026-04-27
1152

1253
### Changed

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "vicinity"
3-
version = "0.7.2"
3+
version = "0.8.0"
44
authors = ["Arc <attobop@gmail.com>"]
55
edition = "2021"
66
rust-version = "1.89"

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ Each algorithm is a separate feature. Enable what you need:
3737

3838
```toml
3939
[dependencies]
40-
vicinity = { version = "0.7", features = ["hnsw"] } # graph index
41-
# vicinity = { version = "0.7", features = ["ivf_pq"] } # compressed index
42-
# vicinity = { version = "0.7", features = ["nsw"] } # flat graph
40+
vicinity = { version = "0.8", features = ["hnsw"] } # graph index
41+
# vicinity = { version = "0.8", features = ["ivf_pq"] } # compressed index
42+
# vicinity = { version = "0.8", features = ["nsw"] } # flat graph
4343
```
4444

4545
## Usage
@@ -82,7 +82,7 @@ Save and load indexes with the `serde` feature:
8282

8383
```toml
8484
[dependencies]
85-
vicinity = { version = "0.7", features = ["hnsw", "serde"] }
85+
vicinity = { version = "0.8", features = ["hnsw", "serde"] }
8686
```
8787

8888
```rust

src/binary_index/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
//! # Feature Flag
1414
//!
1515
//! ```toml
16-
//! vicinity = { version = "0.7", features = ["binary_index"] }
16+
//! vicinity = { version = "0.8", features = ["binary_index"] }
1717
//! ```
1818
//!
1919
//! # Quick Start

src/curator/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
//! # Feature Flag
1010
//!
1111
//! ```toml
12-
//! vicinity = { version = "0.7", features = ["curator"] }
12+
//! vicinity = { version = "0.8", features = ["curator"] }
1313
//! ```
1414
//!
1515
//! # Quick Start

src/diskann/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
//! # Feature Flag
1010
//!
1111
//! ```toml
12-
//! vicinity = { version = "0.7", features = ["diskann"] }
12+
//! vicinity = { version = "0.8", features = ["diskann"] }
1313
//! ```
1414
//!
1515
//! # Status: Experimental

src/emg/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
//! # Feature Flag
1010
//!
1111
//! ```toml
12-
//! vicinity = { version = "0.7", features = ["emg"] }
12+
//! vicinity = { version = "0.8", features = ["emg"] }
1313
//! ```
1414
//!
1515
//! # Quick Start

src/filtered_graph/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
//! # Feature Flag
1515
//!
1616
//! ```toml
17-
//! vicinity = { version = "0.7", features = ["filtered_graph"] }
17+
//! vicinity = { version = "0.8", features = ["filtered_graph"] }
1818
//! ```
1919
//!
2020
//! # Quick Start

src/finger/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
//! # Feature Flag
1111
//!
1212
//! ```toml
13-
//! vicinity = { version = "0.7", features = ["finger"] }
13+
//! vicinity = { version = "0.8", features = ["finger"] }
1414
//! ```
1515
//!
1616
//! # Quick Start

src/fresh_graph/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
//! # Feature Flag
1111
//!
1212
//! ```toml
13-
//! vicinity = { version = "0.7", features = ["fresh_graph"] }
13+
//! vicinity = { version = "0.8", features = ["fresh_graph"] }
1414
//! ```
1515
//!
1616
//! # Quick Start

0 commit comments

Comments
 (0)