Struct smartcore::neighbors::knn_classifier::KNNClassifier

pub struct KNNClassifier<T: RealNumber, D: Distance<Vec<T>, T>> { /* fields omitted */ }

K Nearest Neighbors Classifier

Implementations

impl<T: RealNumber, D: Distance<Vec<T>, T>> KNNClassifier<T, D>

pub fn fit<M: Matrix<T>>(
    x: &M,
    y: &M::RowVector,
    parameters: KNNClassifierParameters<T, D>
) -> Result<KNNClassifier<T, D>, Failed>

Fits KNN classifier to a NxM matrix where N is number of samples and M is number of features.

• x - training data
• y - vector with target values (classes) of length N
• parameters - additional parameters like search algorithm and k

pub fn predict<M: Matrix<T>>(&self, x: &M) -> Result<M::RowVector, Failed>

Estimates the class labels for the provided data.

• x - data of shape NxM where N is number of data points to estimate and M is number of features. Returns a vector of size N with class estimates.

Trait Implementations

impl<T: Debug + RealNumber, D: Debug + Distance<Vec<T>, T>> Debug for KNNClassifier<T, D>

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de, T: RealNumber, D: Distance<Vec<T>, T>> Deserialize<'de> for KNNClassifier<T, D> where
    T: Deserialize<'de>,
    D: Deserialize<'de>, 

pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T: RealNumber, D: Distance<Vec<T>, T>> PartialEq<KNNClassifier<T, D>> for KNNClassifier<T, D>

pub fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: RealNumber, M: Matrix<T>, D: Distance<Vec<T>, T>> Predictor<M, <M as BaseMatrix<T>>::RowVector> for KNNClassifier<T, D>

pub fn predict(&self, x: &M) -> Result<M::RowVector, Failed>

Estimate target values from new data.

impl<T: RealNumber, D: Distance<Vec<T>, T>> Serialize for KNNClassifier<T, D> where
    T: Serialize,
    D: Serialize, 

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<T: RealNumber, M: Matrix<T>, D: Distance<Vec<T>, T>> SupervisedEstimator<M, <M as BaseMatrix<T>>::RowVector, KNNClassifierParameters<T, D>> for KNNClassifier<T, D>

pub fn fit(
    x: &M,
    y: &M::RowVector,
    parameters: KNNClassifierParameters<T, D>
) -> Result<Self, Failed>

Fit a model to a training dataset, estimate model's parameters.