#classification #algorithm #ml #csv #k-nn

bin+lib knn_classifier

This simple library is a classifier for the k-Nearest Neighbors (kNN/k-nn) algorithm

3 releases

0.1.2 Feb 25, 2024
0.1.1 Feb 24, 2024
0.1.0 Feb 24, 2024

#972 in Algorithms

MIT license

14KB
169 lines

k-nn classifier

This is a library for solving classification problems using the k-nearest neighbor (k-nn) algorithm. Due to the simplicity of the algorithm, it is lightweight and well-suited for easily solving classification problems.

Install

cargo add knn_classifier

Simple Example

The following sample is a program that determines if a person is of normal weight or fat, based on their height(cm) and weight(kg).

use knn_classifier::KnnClassifier;
fn main() {
    // Create the classifier
    let mut clf = KnnClassifier::new(3);
    // Learn from data
    clf.fit(
        &[&[170., 60.], &[166., 58.], &[152., 99.], &[163., 95.], &[150., 90.]],
        &["Normal", "Normal", "Obesity", "Obesity", "Obesity"]);
    // Predict
    let labels = clf.predict(&[vec![159., 85.], vec![165., 55.]]);
    println!("{:?}", labels); // ["Fat", "Normal"]
    assert_eq!(labels, ["Obesity", "Normal"]);
}

Support CSV format

The classifier can be converted to and from CSV format.

// Convert Data to CSV
let s = clf.to_csv(',');
println!("{}", s);

// Convert from CSV
clf.from_csv(&s, ',', 0, false);

// Predict one
let label = clf.predict_one(&[150., 80.]);
assert_eq!(label, "Obesity");

Samples

Reference

No runtime deps