Skip to content
Merged
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
18 changes: 18 additions & 0 deletions diskann/src/graph/config/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -555,6 +555,24 @@ impl Builder {
/// Construct a new builder with the basic values.
///
/// All other parameters will use their default values.
///
/// # Note
///
/// The choice of [`prune_kind`](PruneKind) is distance-function-dependent and can have a
/// profoundly negative impact on the graph quality if chosen incorrectly. When in doubt
/// prefer to use [`diskann_vector::distance::Metric`]'s conversion function like the
/// example below:
/// ```rust
/// use diskann::graph::config;
/// use diskann_vector::distance::Metric;
///
/// let _ = config::Builder::new(
/// 10,
/// config::MaxDegree::default_slack(),
/// 20,
/// (Metric::L2).into()
/// );
/// ```
pub fn new(
pruned_degree: usize,
max_degree: MaxDegree,
Expand Down