Skip to content

Commit 9cdc95c

Browse files
committed
Add README to nearest neighbor
1 parent d2d0e67 commit 9cdc95c

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

algorithms/linfa-nn/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Nearest Neighbor
2+
3+
`linfa-nn` provides a pure Rust implementation of nearest neighbor algorithms.
4+
5+
## The Big Picture
6+
7+
`linfa-nn` is a crate in the [`linfa`](https://crates.io/crates/linfa) ecosystem, an effort to create a toolkit for classical Machine Learning implemented in pure Rust, akin to Python's `scikit-learn`.
8+
9+
Nearest neighbor search (NNS), as a form of proximity search, is the optimization problem of finding the point in a given set that is closest (or most similar) to a given point. Closeness is typically expressed in terms of a dissimilarity function: the less similar the objects, the larger the function values.
10+
11+
## Current State
12+
13+
linfa-nn currently provides the following implementations:
14+
- linear
15+
- balltree
16+
- KDTree
17+
18+
19+
## License
20+
Dual-licensed to be compatible with the Rust project.
21+
22+
Licensed under the Apache License, Version 2.0 <http://www.apache.org/licenses/LICENSE-2.0> or the MIT license <http://opensource.org/licenses/MIT>, at your option. This file may not be copied, modified, or distributed except according to those terms.

0 commit comments

Comments
 (0)