`sklearn.naive_bayes`.ComplementNB¶

class sklearn.naive_bayes.ComplementNB(alpha=1.0, fit_prior=True, class_prior=None, norm=False)[source]¶

The Complement Naive Bayes classifier described in Rennie et al. (2003).

The Complement Naive Bayes classifier was designed to correct the “severe assumptions” made by the standard Multinomial Naive Bayes classifier. It is particularly suited for imbalanced data sets.

Read more in the User Guide.

Parameters

alphafloat, optional (default=1.0): Additive (Laplace/Lidstone) smoothing parameter (0 for no smoothing).
fit_priorboolean, optional (default=True): Only used in edge case with a single class in the training set.
class_priorarray-like, size (n_classes,), optional (default=None): Prior probabilities of the classes. Not used.
normboolean, optional (default=False): Whether or not a second normalization of the weights is performed. The default behavior mirrors the implementations found in Mahout and Weka, which do not follow the full algorithm described in Table 9 of the paper.

Attributes

class_log_prior_array, shape (n_classes, ): Smoothed empirical log probability for each class. Only used in edge case with a single class in the training set.
feature_log_prob_array, shape (n_classes, n_features): Empirical weights for class complements.
class_count_array, shape (n_classes,): Number of samples encountered for each class during fitting. This value is weighted by the sample weight when provided.
classes_array, shape (n_classes,): Class labels known to the classifier
feature_count_array, shape (n_classes, n_features): Number of samples encountered for each (class, feature) during fitting. This value is weighted by the sample weight when provided.
n_features_int: Number of features of each sample.
feature_all_array, shape (n_features,): Number of samples encountered for each feature during fitting. This value is weighted by the sample weight when provided.
classes_array of shape = [n_classes]: The classes labels.

References

Rennie, J. D., Shih, L., Teevan, J., & Karger, D. R. (2003). Tackling the poor assumptions of naive bayes text classifiers. In ICML (Vol. 3, pp. 616-623). https://people.csail.mit.edu/jrennie/papers/icml03-nb.pdf

Examples

>>> import numpy as np
>>> rng = np.random.RandomState(1)
>>> X = rng.randint(5, size=(6, 100))
>>> y = np.array([1, 2, 3, 4, 5, 6])
>>> from sklearn.naive_bayes import ComplementNB
>>> clf = ComplementNB()
>>> clf.fit(X, y)
ComplementNB()
>>> print(clf.predict(X[2:3]))
[3]

Methods

`fit`(self, X, y[, sample_weight])	Fit Naive Bayes classifier according to X, y
`get_params`(self[, deep])	Get parameters for this estimator.
`partial_fit`(self, X, y[, classes, sample_weight])	Incremental fit on a batch of samples.
`predict`(self, X)	Perform classification on an array of test vectors X.
`predict_log_proba`(self, X)	Return log-probability estimates for the test vector X.
`predict_proba`(self, X)	Return probability estimates for the test vector X.
`score`(self, X, y[, sample_weight])	Returns the mean accuracy on the given test data and labels.
`set_params`(self, \\params)	Set the parameters of this estimator.

__init__(self, alpha=1.0, fit_prior=True, class_prior=None, norm=False)[source]¶: Initialize self. See help(type(self)) for accurate signature.

fit(self, X, y, sample_weight=None)[source]¶

Fit Naive Bayes classifier according to X, y

Parameters

X{array-like, sparse matrix}, shape = [n_samples, n_features]: Training vectors, where n_samples is the number of samples and n_features is the number of features.
yarray-like, shape = [n_samples]: Target values.
sample_weightarray-like, shape = [n_samples], (default=None): Weights applied to individual samples (1. for unweighted).

Returns

selfobject

get_params(self, deep=True)[source]¶

Get parameters for this estimator.

Parameters

deepboolean, optional: If True, will return the parameters for this estimator and contained subobjects that are estimators.

Returns

paramsmapping of string to any: Parameter names mapped to their values.

partial_fit(self, X, y, classes=None, sample_weight=None)[source]¶

Incremental fit on a batch of samples.

This method is expected to be called several times consecutively on different chunks of a dataset so as to implement out-of-core or online learning.

This is especially useful when the whole dataset is too big to fit in memory at once.

This method has some performance overhead hence it is better to call partial_fit on chunks of data that are as large as possible (as long as fitting in the memory budget) to hide the overhead.

Parameters

X{array-like, sparse matrix}, shape = [n_samples, n_features]

Training vectors, where n_samples is the number of samples and n_features is the number of features.

yarray-like, shape = [n_samples]

Target values.

classesarray-like, shape = [n_classes] (default=None)

List of all the classes that can possibly appear in the y vector.

Must be provided at the first call to partial_fit, can be omitted in subsequent calls.

sample_weightarray-like, shape = [n_samples] (default=None)

Weights applied to individual samples (1. for unweighted).

Returns

selfobject

predict(self, X)[source]¶

Perform classification on an array of test vectors X.

Parameters

Xarray-like, shape = [n_samples, n_features]

Returns

Carray, shape = [n_samples]: Predicted target values for X

predict_log_proba(self, X)[source]¶

Return log-probability estimates for the test vector X.

Parameters

Xarray-like, shape = [n_samples, n_features]

Returns

Carray-like, shape = [n_samples, n_classes]: Returns the log-probability of the samples for each class in the model. The columns correspond to the classes in sorted order, as they appear in the attribute classes_.

predict_proba(self, X)[source]¶

Return probability estimates for the test vector X.

Parameters

Xarray-like, shape = [n_samples, n_features]

Returns

Carray-like, shape = [n_samples, n_classes]: Returns the probability of the samples for each class in the model. The columns correspond to the classes in sorted order, as they appear in the attribute classes_.

score(self, X, y, sample_weight=None)[source]¶

Returns the mean accuracy on the given test data and labels.

In multi-label classification, this is the subset accuracy which is a harsh metric since you require for each sample that each label set be correctly predicted.

Parameters

Xarray-like, shape = (n_samples, n_features): Test samples.
yarray-like, shape = (n_samples) or (n_samples, n_outputs): True labels for X.
sample_weightarray-like, shape = [n_samples], optional: Sample weights.

Returns

scorefloat: Mean accuracy of self.predict(X) wrt. y.

set_params(self, **params)[source]¶

Set the parameters of this estimator.

The method works on simple estimators as well as on nested objects (such as pipelines). The latter have parameters of the form <component>__<parameter> so that it’s possible to update each component of a nested object.

Returns

self

sklearn.naive_bayes.ComplementNB¶

`sklearn.naive_bayes`.ComplementNB¶