Skip to content

Commit 8444609

Browse files
committed
Fix docs for nearest_neighbour & hamming_matcher
Updated the limitation for n_dist paramter in nearest_neighbour and hamming_matcher functions.
1 parent 418a005 commit 8444609

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/vision/mod.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -393,7 +393,7 @@ where
393393
/// - `train` - Array containing the data to be used as training data
394394
/// - `dist_dims` - indicates the dimension to analyze for distance (the dimension indicated here
395395
/// must be of equal length for both query and train arrays)
396-
/// - `n_dist` - is the number of smallest distances to return (currently, only 1 is supported)
396+
/// - `n_dist` - is the number of smallest distances to return (currently, only values <= 256 are supported)
397397
///
398398
///
399399
/// # Return Values
@@ -452,7 +452,7 @@ where
452452
/// - `query` is the array containing the data to be queried
453453
/// - `train` is the array containing the data used as training data
454454
/// - `dist_dim` indicates the dimension to analyze for distance (the dimension indicated here must be of equal length for both query and train arrays)
455-
/// - `n_dist` is the number of smallest distances to return (currently, only 1 is supported)
455+
/// - `n_dist` is the number of smallest distances to return (currently, only values <= 256 are supported)
456456
/// - `dist_type` is the distance computation type. Currently [`MatchType::SAD`](./enum.MatchType.html), [`MatchType::SSD`](./enum.MatchType.html), and [`MatchType::SHD`](./enum.MatchType.html) are supported.
457457
///
458458
/// # Return Values

0 commit comments

Comments
 (0)