Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ exclude = ["crates/micro-hnsw-wasm", "crates/ruvector-hyperbolic-hnsw", "crates/
# land in iters 92-97.
"crates/ruos-thermal"]
members = [
"crates/ruvector-muvera",
"crates/ruvector-acorn",
"crates/ruvector-acorn-wasm",
"crates/ruvector-rabitq",
Expand Down
27 changes: 27 additions & 0 deletions crates/ruvector-muvera/Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
[package]
name = "ruvector-muvera"
version.workspace = true
edition.workspace = true
rust-version.workspace = true
license.workspace = true
authors.workspace = true
repository.workspace = true
description = "MUVERA: Multi-Vector Retrieval via Fixed Dimensional Encodings — compress ColBERT-style token sets to single vectors for HNSW-compatible search (NeurIPS 2024)"

[[bin]]
name = "muvera-demo"
path = "src/main.rs"

[[bench]]
name = "muvera_bench"
harness = false

[dependencies]
rand = { workspace = true }
rand_distr = { workspace = true }
serde = { workspace = true }
thiserror = { workspace = true }

[dev-dependencies]
criterion = { workspace = true }
rand = { workspace = true }
101 changes: 101 additions & 0 deletions crates/ruvector-muvera/benches/muvera_bench.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
use criterion::{
black_box, criterion_group, criterion_main, BenchmarkId, Criterion, Throughput,
};
use rand::rngs::StdRng;
use rand::{Rng, SeedableRng};
use ruvector_muvera::{FdeConfig, FdeEncoder, MuveraIndex};

const DIM: usize = 128;
const N_TOKENS: usize = 32;
const N_DOCS_BENCH: usize = 1_000;

fn random_unit_vec(rng: &mut impl Rng, dim: usize) -> Vec<f32> {
let v: Vec<f32> = (0..dim).map(|_| rng.gen::<f32>() * 2.0 - 1.0).collect();
let norm: f32 = v.iter().map(|x| x * x).sum::<f32>().sqrt().max(f32::EPSILON);
v.into_iter().map(|x| x / norm).collect()
}

fn maxsim(doc: &[Vec<f32>], query: &[Vec<f32>]) -> f32 {
query
.iter()
.map(|q| {
doc.iter()
.map(|d| q.iter().zip(d.iter()).map(|(a, b)| a * b).sum::<f32>())
.fold(f32::NEG_INFINITY, f32::max)
})
.sum()
}

// ── Encode benchmark (single document) ────────────────────────────────────────

fn bench_encode(c: &mut Criterion) {
let mut rng = StdRng::seed_from_u64(42);
let tokens: Vec<Vec<f32>> =
(0..N_TOKENS).map(|_| random_unit_vec(&mut rng, DIM)).collect();

let mut g = c.benchmark_group("fde_encode_single_doc");
g.throughput(Throughput::Elements(N_TOKENS as u64));

for (label, cfg) in [
("B=8,dp=8,R=4", FdeConfig { dim: DIM, buckets: 8, d_proj: 8, reps: 4 }),
("B=16,dp=16,R=4", FdeConfig { dim: DIM, buckets: 16, d_proj: 16, reps: 4 }),
("B=32,dp=16,R=4", FdeConfig { dim: DIM, buckets: 32, d_proj: 16, reps: 4 }),
] {
let mut enc_rng = StdRng::seed_from_u64(7);
let encoder = FdeEncoder::new(cfg, &mut enc_rng).unwrap();
g.bench_with_input(BenchmarkId::new("encode", label), &encoder, |b, enc| {
b.iter(|| enc.encode(black_box(&tokens)).unwrap())
});
}
g.finish();
}

// ── Search benchmark (1 K docs, flat scan) ────────────────────────────────────

fn bench_search(c: &mut Criterion) {
let mut rng = StdRng::seed_from_u64(42);
let docs: Vec<Vec<Vec<f32>>> = (0..N_DOCS_BENCH)
.map(|_| (0..N_TOKENS).map(|_| random_unit_vec(&mut rng, DIM)).collect())
.collect();
let query: Vec<Vec<f32>> =
(0..N_TOKENS).map(|_| random_unit_vec(&mut rng, DIM)).collect();

let mut g = c.benchmark_group("search_1k_docs");
g.throughput(Throughput::Elements(N_DOCS_BENCH as u64));

// Baseline: brute-force MaxSim.
g.bench_function("brute_force_maxsim", |b| {
b.iter(|| {
let mut best = f32::NEG_INFINITY;
let mut best_idx = 0usize;
for (i, doc) in black_box(&docs).iter().enumerate() {
let s = maxsim(doc, black_box(&query));
if s > best {
best = s;
best_idx = i;
}
}
black_box(best_idx)
})
});

for (label, cfg) in [
("fde_B8_dp8_R4", FdeConfig { dim: DIM, buckets: 8, d_proj: 8, reps: 4 }),
("fde_B16_dp16_R4", FdeConfig { dim: DIM, buckets: 16, d_proj: 16, reps: 4 }),
("fde_B32_dp16_R4", FdeConfig { dim: DIM, buckets: 32, d_proj: 16, reps: 4 }),
] {
let mut enc_rng = StdRng::seed_from_u64(7);
let encoder = FdeEncoder::new(cfg, &mut enc_rng).unwrap();
let mut index = MuveraIndex::new(encoder);
for (i, doc) in docs.iter().enumerate() {
index.insert(i.to_string(), doc).unwrap();
}
g.bench_with_input(BenchmarkId::new("muvera_flat", label), &index, |b, idx| {
b.iter(|| idx.search(black_box(&query), 10).unwrap())
});
}
g.finish();
}

criterion_group!(benches, bench_encode, bench_search);
criterion_main!(benches);
Loading
Loading