feat: Add getters for naive bayes structs (#74)
* feat: Add getters for GaussianNB * Add classes getter to BernoulliNB Add classes getter to CategoricalNB Add classes getter to MultinomialNB * Add feature_log_prob getter to MultinomialNB * Add class_count to NB structs * Add n_features getter for NB * Add feature_count to MultinomialNB and BernoulliNB * Add n_categories to CategoricalNB * Implement feature_log_prob and category_count getter for CategoricalNB * Implement feature_log_prob for BernoulliNB
This commit is contained in:
+132
-21
@@ -43,14 +43,31 @@ use serde::{Deserialize, Serialize};
|
||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||
#[derive(Debug)]
|
||||
struct CategoricalNBDistribution<T: RealNumber> {
|
||||
/// number of training samples observed in each class
|
||||
class_count: Vec<usize>,
|
||||
/// class labels known to the classifier
|
||||
class_labels: Vec<T>,
|
||||
/// probability of each class
|
||||
class_priors: Vec<T>,
|
||||
coefficients: Vec<Vec<Vec<T>>>,
|
||||
/// Number of features of each sample
|
||||
n_features: usize,
|
||||
/// Number of categories for each feature
|
||||
n_categories: Vec<usize>,
|
||||
/// Holds arrays of shape (n_classes, n_categories of respective feature)
|
||||
/// for each feature. Each array provides the number of samples
|
||||
/// encountered for each class and category of the specific feature.
|
||||
category_count: Vec<Vec<Vec<usize>>>,
|
||||
}
|
||||
|
||||
impl<T: RealNumber> PartialEq for CategoricalNBDistribution<T> {
|
||||
fn eq(&self, other: &Self) -> bool {
|
||||
if self.class_labels == other.class_labels && self.class_priors == other.class_priors {
|
||||
if self.class_labels == other.class_labels
|
||||
&& self.class_priors == other.class_priors
|
||||
&& self.n_features == other.n_features
|
||||
&& self.n_categories == other.n_categories
|
||||
&& self.class_count == other.class_count
|
||||
{
|
||||
if self.coefficients.len() != other.coefficients.len() {
|
||||
return false;
|
||||
}
|
||||
@@ -90,8 +107,8 @@ impl<T: RealNumber, M: Matrix<T>> NBDistribution<T, M> for CategoricalNBDistribu
|
||||
let mut likelihood = T::zero();
|
||||
for feature in 0..j.len() {
|
||||
let value = j.get(feature).floor().to_usize().unwrap();
|
||||
if self.coefficients[class_index][feature].len() > value {
|
||||
likelihood += self.coefficients[class_index][feature][value];
|
||||
if self.coefficients[feature][class_index].len() > value {
|
||||
likelihood += self.coefficients[feature][class_index][value];
|
||||
} else {
|
||||
return T::zero();
|
||||
}
|
||||
@@ -149,12 +166,12 @@ impl<T: RealNumber> CategoricalNBDistribution<T> {
|
||||
let class_labels: Vec<T> = (0..*y_max + 1)
|
||||
.map(|label| T::from(label).unwrap())
|
||||
.collect();
|
||||
let mut classes_count: Vec<T> = vec![T::zero(); class_labels.len()];
|
||||
let mut class_count = vec![0_usize; class_labels.len()];
|
||||
for elem in y.iter() {
|
||||
classes_count[*elem] += T::one();
|
||||
class_count[*elem] += 1;
|
||||
}
|
||||
|
||||
let mut feature_categories: Vec<Vec<T>> = Vec::with_capacity(n_features);
|
||||
let mut n_categories: Vec<usize> = Vec::with_capacity(n_features);
|
||||
for feature in 0..n_features {
|
||||
let feature_max = x
|
||||
.get_col_as_vec(feature)
|
||||
@@ -167,18 +184,15 @@ impl<T: RealNumber> CategoricalNBDistribution<T> {
|
||||
feature
|
||||
))
|
||||
})?;
|
||||
let feature_types = (0..feature_max + 1)
|
||||
.map(|feat| T::from(feat).unwrap())
|
||||
.collect();
|
||||
feature_categories.push(feature_types);
|
||||
n_categories.push(feature_max + 1);
|
||||
}
|
||||
|
||||
let mut coefficients: Vec<Vec<Vec<T>>> = Vec::with_capacity(class_labels.len());
|
||||
for (label, label_count) in class_labels.iter().zip(classes_count.iter()) {
|
||||
let mut category_count: Vec<Vec<Vec<usize>>> = Vec::with_capacity(class_labels.len());
|
||||
for (feature_index, &n_categories_i) in n_categories.iter().enumerate().take(n_features) {
|
||||
let mut coef_i: Vec<Vec<T>> = Vec::with_capacity(n_features);
|
||||
for (feature_index, feature_options) in
|
||||
feature_categories.iter().enumerate().take(n_features)
|
||||
{
|
||||
let mut category_count_i: Vec<Vec<usize>> = Vec::with_capacity(n_features);
|
||||
for (label, &label_count) in class_labels.iter().zip(class_count.iter()) {
|
||||
let col = x
|
||||
.get_col_as_vec(feature_index)
|
||||
.iter()
|
||||
@@ -186,33 +200,41 @@ impl<T: RealNumber> CategoricalNBDistribution<T> {
|
||||
.filter(|(i, _j)| T::from(y[*i]).unwrap() == *label)
|
||||
.map(|(_, j)| *j)
|
||||
.collect::<Vec<T>>();
|
||||
let mut feat_count: Vec<T> = vec![T::zero(); feature_options.len()];
|
||||
let mut feat_count: Vec<usize> = vec![0_usize; n_categories_i];
|
||||
for row in col.iter() {
|
||||
let index = row.floor().to_usize().unwrap();
|
||||
feat_count[index] += T::one();
|
||||
feat_count[index] += 1;
|
||||
}
|
||||
|
||||
let coef_i_j = feat_count
|
||||
.iter()
|
||||
.map(|c| {
|
||||
((*c + alpha)
|
||||
/ (*label_count + T::from(feature_options.len()).unwrap() * alpha))
|
||||
((T::from(*c).unwrap() + alpha)
|
||||
/ (T::from(label_count).unwrap()
|
||||
+ T::from(n_categories_i).unwrap() * alpha))
|
||||
.ln()
|
||||
})
|
||||
.collect::<Vec<T>>();
|
||||
category_count_i.push(feat_count);
|
||||
coef_i.push(coef_i_j);
|
||||
}
|
||||
category_count.push(category_count_i);
|
||||
coefficients.push(coef_i);
|
||||
}
|
||||
|
||||
let class_priors = classes_count
|
||||
.into_iter()
|
||||
.map(|count| count / T::from(n_samples).unwrap())
|
||||
let class_priors = class_count
|
||||
.iter()
|
||||
.map(|&count| T::from(count).unwrap() / T::from(n_samples).unwrap())
|
||||
.collect::<Vec<T>>();
|
||||
|
||||
Ok(Self {
|
||||
class_count,
|
||||
class_labels,
|
||||
class_priors,
|
||||
coefficients,
|
||||
n_categories,
|
||||
n_features,
|
||||
category_count,
|
||||
})
|
||||
}
|
||||
}
|
||||
@@ -287,6 +309,41 @@ impl<T: RealNumber, M: Matrix<T>> CategoricalNB<T, M> {
|
||||
pub fn predict(&self, x: &M) -> Result<M::RowVector, Failed> {
|
||||
self.inner.predict(x)
|
||||
}
|
||||
|
||||
/// Class labels known to the classifier.
|
||||
/// Returns a vector of size n_classes.
|
||||
pub fn classes(&self) -> &Vec<T> {
|
||||
&self.inner.distribution.class_labels
|
||||
}
|
||||
|
||||
/// Number of training samples observed in each class.
|
||||
/// Returns a vector of size n_classes.
|
||||
pub fn class_count(&self) -> &Vec<usize> {
|
||||
&self.inner.distribution.class_count
|
||||
}
|
||||
|
||||
/// Number of features of each sample
|
||||
pub fn n_features(&self) -> usize {
|
||||
self.inner.distribution.n_features
|
||||
}
|
||||
|
||||
/// Number of features of each sample
|
||||
pub fn n_categories(&self) -> &Vec<usize> {
|
||||
&self.inner.distribution.n_categories
|
||||
}
|
||||
|
||||
/// Holds arrays of shape (n_classes, n_categories of respective feature)
|
||||
/// for each feature. Each array provides the number of samples
|
||||
/// encountered for each class and category of the specific feature.
|
||||
pub fn category_count(&self) -> &Vec<Vec<Vec<usize>>> {
|
||||
&self.inner.distribution.category_count
|
||||
}
|
||||
/// Holds arrays of shape (n_classes, n_categories of respective feature)
|
||||
/// for each feature. Each array provides the empirical log probability
|
||||
/// of categories given the respective feature and class, ``P(x_i|y)``.
|
||||
pub fn feature_log_prob(&self) -> &Vec<Vec<Vec<T>>> {
|
||||
&self.inner.distribution.coefficients
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
@@ -315,6 +372,60 @@ mod tests {
|
||||
let y = vec![0., 0., 1., 1., 1., 0., 1., 0., 1., 1., 1., 1., 1., 0.];
|
||||
|
||||
let cnb = CategoricalNB::fit(&x, &y, Default::default()).unwrap();
|
||||
|
||||
// checking parity with scikit
|
||||
assert_eq!(cnb.classes(), &[0., 1.]);
|
||||
assert_eq!(cnb.class_count(), &[5, 9]);
|
||||
assert_eq!(cnb.n_features(), 4);
|
||||
assert_eq!(cnb.n_categories(), &[3, 3, 2, 2]);
|
||||
assert_eq!(
|
||||
cnb.category_count(),
|
||||
&vec![
|
||||
vec![vec![3, 0, 2], vec![2, 4, 3]],
|
||||
vec![vec![1, 2, 2], vec![3, 4, 2]],
|
||||
vec![vec![1, 4], vec![6, 3]],
|
||||
vec![vec![2, 3], vec![6, 3]]
|
||||
]
|
||||
);
|
||||
|
||||
assert_eq!(
|
||||
cnb.feature_log_prob(),
|
||||
&vec![
|
||||
vec![
|
||||
vec![
|
||||
-0.6931471805599453,
|
||||
-2.0794415416798357,
|
||||
-0.9808292530117262
|
||||
],
|
||||
vec![
|
||||
-1.3862943611198906,
|
||||
-0.8754687373538999,
|
||||
-1.0986122886681098
|
||||
]
|
||||
],
|
||||
vec![
|
||||
vec![
|
||||
-1.3862943611198906,
|
||||
-0.9808292530117262,
|
||||
-0.9808292530117262
|
||||
],
|
||||
vec![
|
||||
-1.0986122886681098,
|
||||
-0.8754687373538999,
|
||||
-1.3862943611198906
|
||||
]
|
||||
],
|
||||
vec![
|
||||
vec![-1.252762968495368, -0.3364722366212129],
|
||||
vec![-0.45198512374305727, -1.0116009116784799]
|
||||
],
|
||||
vec![
|
||||
vec![-0.8472978603872037, -0.5596157879354228],
|
||||
vec![-0.45198512374305727, -1.0116009116784799]
|
||||
]
|
||||
]
|
||||
);
|
||||
|
||||
let x_test = DenseMatrix::from_2d_array(&[&[0., 2., 1., 0.], &[2., 2., 0., 0.]]);
|
||||
let y_hat = cnb.predict(&x_test).unwrap();
|
||||
assert_eq!(y_hat, vec![0., 1.]);
|
||||
|
||||
Reference in New Issue
Block a user