Commit 46b5c40
committed
feat(rust): add validated IndexParamsBuilder / SearchParamsBuilder
Add `IndexParams::builder()` / `SearchParams::builder()` entry points
to the CAGRA, IVF-PQ, IVF-Flat, and Vamana Rust bindings.
## Problem
The existing `IndexParams::new()?.set_graph_degree(0)` setter chain
accepts invalid values silently. Errors surface as an opaque CUDA
assertion inside `Index::build()` — up to 1.8s after the bad config
was written, after GPU memory is already allocated.
## Solution
Each `XxxParamsBuilder`:
- Stores parameters as Rust-native values (no FFI struct allocated yet)
- Exposes `validate() -> Result<()>`: pure-Rust constraint checks,
no GPU work; callable before any device is present
- Exposes `build() -> Result<XxxParams>`: calls `validate()`, then
allocates the FFI struct via the existing `new()?.set_*()` chain
- Fully additive — the existing `new()` + setter API is unchanged
Validation rules enforced:
- CAGRA `IndexParams`: graph_degree > 0, intermediate_graph_degree >=
graph_degree, nn_descent_niter > 0
- CAGRA `SearchParams`: itopk_size is a power of 2 (or 0 for auto),
team_size ∈ {0,4,8,16,32}, hashmap_max_fill_rate ∈ (0.1, 0.9)
- IVF-PQ / IVF-Flat `IndexParams`: n_lists > 0,
kmeans_trainset_fraction ∈ (0, 1]
- Vamana `IndexParams`: graph_degree > 0, visited_size >= graph_degree,
alpha > 0
## Changes
- `src/error.rs`: add `impl From<String> for Error` for ergonomic
validation errors (private-field CuvsError constructed in-module)
- `src/cagra/index_params.rs`: `IndexParamsBuilder` + `IndexParams::builder()`
- `src/cagra/search_params.rs`: `SearchParamsBuilder` + `SearchParams::builder()`
- `src/cagra/mod.rs`: re-export `IndexParamsBuilder`, `SearchParamsBuilder`
- `examples/cagra.rs`: updated to demonstrate builder API
- `src/ivf_pq/index_params.rs`: `IndexParamsBuilder`
- `src/ivf_flat/index_params.rs`: `IndexParamsBuilder`
- `src/vamana/index_params.rs`: `IndexParamsBuilder`
- `src/{ivf_pq,ivf_flat,vamana}/mod.rs`: re-export `IndexParamsBuilder`
## Tests added (all 6 PR gate tests from issue spec)
- `builder_rejects_zero_graph_degree` (validate only, no GPU)
- `builder_rejects_invalid_intermediate_degree` (validate only)
- `builder_rejects_zero_niter` (validate only)
- `builder_accepts_valid_params` (validate only)
- `builder_round_trips_to_ffi` (requires GPU — compares builder output
to manual setter chain at FFI struct level)
- `existing_setter_api_unchanged` (requires GPU — confirms no regression)1 parent 105c61e commit 46b5c40
File tree
11 files changed
+985
-8
lines changed- rust/cuvs
- examples
- src
- cagra
- ivf_flat
- ivf_pq
- vamana
11 files changed
+985
-8
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
13 | | - | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
14 | 18 | | |
15 | 19 | | |
16 | 20 | | |
| |||
20 | 24 | | |
21 | 25 | | |
22 | 26 | | |
23 | | - | |
24 | | - | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
25 | 35 | | |
26 | 36 | | |
27 | 37 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
137 | 137 | | |
138 | 138 | | |
139 | 139 | | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
140 | 165 | | |
141 | 166 | | |
142 | 167 | | |
| |||
177 | 202 | | |
178 | 203 | | |
179 | 204 | | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
| 212 | + | |
| 213 | + | |
| 214 | + | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
| 231 | + | |
| 232 | + | |
| 233 | + | |
| 234 | + | |
| 235 | + | |
| 236 | + | |
| 237 | + | |
| 238 | + | |
| 239 | + | |
| 240 | + | |
| 241 | + | |
| 242 | + | |
| 243 | + | |
| 244 | + | |
| 245 | + | |
| 246 | + | |
| 247 | + | |
| 248 | + | |
| 249 | + | |
| 250 | + | |
| 251 | + | |
| 252 | + | |
| 253 | + | |
| 254 | + | |
| 255 | + | |
| 256 | + | |
| 257 | + | |
| 258 | + | |
| 259 | + | |
| 260 | + | |
| 261 | + | |
| 262 | + | |
| 263 | + | |
| 264 | + | |
| 265 | + | |
| 266 | + | |
| 267 | + | |
| 268 | + | |
| 269 | + | |
| 270 | + | |
| 271 | + | |
| 272 | + | |
| 273 | + | |
| 274 | + | |
| 275 | + | |
| 276 | + | |
| 277 | + | |
| 278 | + | |
| 279 | + | |
| 280 | + | |
| 281 | + | |
| 282 | + | |
| 283 | + | |
| 284 | + | |
| 285 | + | |
| 286 | + | |
| 287 | + | |
| 288 | + | |
| 289 | + | |
| 290 | + | |
| 291 | + | |
| 292 | + | |
| 293 | + | |
| 294 | + | |
| 295 | + | |
| 296 | + | |
| 297 | + | |
| 298 | + | |
| 299 | + | |
| 300 | + | |
| 301 | + | |
| 302 | + | |
| 303 | + | |
| 304 | + | |
| 305 | + | |
| 306 | + | |
| 307 | + | |
| 308 | + | |
| 309 | + | |
| 310 | + | |
| 311 | + | |
| 312 | + | |
| 313 | + | |
180 | 314 | | |
181 | 315 | | |
182 | 316 | | |
| |||
206 | 340 | | |
207 | 341 | | |
208 | 342 | | |
| 343 | + | |
| 344 | + | |
| 345 | + | |
| 346 | + | |
| 347 | + | |
| 348 | + | |
| 349 | + | |
| 350 | + | |
| 351 | + | |
| 352 | + | |
| 353 | + | |
| 354 | + | |
| 355 | + | |
| 356 | + | |
| 357 | + | |
| 358 | + | |
| 359 | + | |
| 360 | + | |
| 361 | + | |
| 362 | + | |
| 363 | + | |
| 364 | + | |
| 365 | + | |
| 366 | + | |
| 367 | + | |
| 368 | + | |
| 369 | + | |
| 370 | + | |
| 371 | + | |
| 372 | + | |
| 373 | + | |
| 374 | + | |
| 375 | + | |
| 376 | + | |
| 377 | + | |
| 378 | + | |
| 379 | + | |
| 380 | + | |
| 381 | + | |
| 382 | + | |
| 383 | + | |
| 384 | + | |
| 385 | + | |
| 386 | + | |
| 387 | + | |
| 388 | + | |
| 389 | + | |
| 390 | + | |
| 391 | + | |
| 392 | + | |
| 393 | + | |
| 394 | + | |
| 395 | + | |
| 396 | + | |
| 397 | + | |
| 398 | + | |
| 399 | + | |
| 400 | + | |
| 401 | + | |
| 402 | + | |
| 403 | + | |
| 404 | + | |
| 405 | + | |
| 406 | + | |
| 407 | + | |
| 408 | + | |
| 409 | + | |
| 410 | + | |
| 411 | + | |
| 412 | + | |
| 413 | + | |
| 414 | + | |
| 415 | + | |
| 416 | + | |
| 417 | + | |
| 418 | + | |
| 419 | + | |
| 420 | + | |
| 421 | + | |
| 422 | + | |
| 423 | + | |
| 424 | + | |
| 425 | + | |
| 426 | + | |
| 427 | + | |
| 428 | + | |
| 429 | + | |
| 430 | + | |
| 431 | + | |
| 432 | + | |
| 433 | + | |
209 | 434 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
71 | 71 | | |
72 | 72 | | |
73 | 73 | | |
74 | | - | |
75 | | - | |
| 74 | + | |
| 75 | + | |
0 commit comments