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.
New in version 0.20.
 Parameters
 alphafloat, default=1.0
Additive (Laplace/Lidstone) smoothing parameter (0 for no smoothing).
 fit_priorbool, default=True
Only used in edge case with a single class in the training set.
 class_priorarraylike of shape (n_classes,), default=None
Prior probabilities of the classes. Not used.
 normbool, 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_count_ndarray of shape (n_classes,)
Number of samples encountered for each class during fitting. This value is weighted by the sample weight when provided.
 class_log_prior_ndarray of shape (n_classes,)
Smoothed empirical log probability for each class. Only used in edge case with a single class in the training set.
 classes_ndarray of shape (n_classes,)
Class labels known to the classifier
 coef_ndarray of shape (n_classes, n_features)
Mirrors
feature_log_prob_
for interpretingComplementNB
as a linear model.Deprecated since version 0.24:
coef_
is deprecated in 0.24 and will be removed in 1.1 (renaming of 0.26). feature_all_ndarray of shape (n_features,)
Number of samples encountered for each feature during fitting. This value is weighted by the sample weight when provided.
 feature_count_ndarray of 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.
 feature_log_prob_ndarray of shape (n_classes, n_features)
Empirical weights for class complements.
 intercept_ndarray of shape (n_classes,)
Mirrors
class_log_prior_
for interpretingComplementNB
as a linear model.Deprecated since version 0.24:
coef_
is deprecated in 0.24 and will be removed in 1.1 (renaming of 0.26). n_features_int
Number of features of each sample.
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. 616623). https://people.csail.mit.edu/jrennie/papers/icml03nb.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
(X, y[, sample_weight])Fit Naive Bayes classifier according to X, y
get_params
([deep])Get parameters for this estimator.
partial_fit
(X, y[, classes, sample_weight])Incremental fit on a batch of samples.
predict
(X)Perform classification on an array of test vectors X.
Return logprobability estimates for the test vector X.
Return probability estimates for the test vector X.
score
(X, y[, sample_weight])Return the mean accuracy on the given test data and labels.
set_params
(**params)Set the parameters of this estimator.

fit
(X, y, sample_weight=None)[source]¶ Fit Naive Bayes classifier according to X, y
 Parameters
 X{arraylike, sparse matrix} of shape (n_samples, n_features)
Training vectors, where n_samples is the number of samples and n_features is the number of features.
 yarraylike of shape (n_samples,)
Target values.
 sample_weightarraylike of shape (n_samples,), default=None
Weights applied to individual samples (1. for unweighted).
 Returns
 selfobject

get_params
(deep=True)[source]¶ Get parameters for this estimator.
 Parameters
 deepbool, default=True
If True, will return the parameters for this estimator and contained subobjects that are estimators.
 Returns
 paramsdict
Parameter names mapped to their values.

partial_fit
(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 outofcore 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{arraylike, sparse matrix} of shape (n_samples, n_features)
Training vectors, where n_samples is the number of samples and n_features is the number of features.
 yarraylike of shape (n_samples,)
Target values.
 classesarraylike of 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_weightarraylike of shape (n_samples,), default=None
Weights applied to individual samples (1. for unweighted).
 Returns
 selfobject

predict
(X)[source]¶ Perform classification on an array of test vectors X.
 Parameters
 Xarraylike of shape (n_samples, n_features)
 Returns
 Cndarray of shape (n_samples,)
Predicted target values for X

predict_log_proba
(X)[source]¶ Return logprobability estimates for the test vector X.
 Parameters
 Xarraylike of shape (n_samples, n_features)
 Returns
 Carraylike of shape (n_samples, n_classes)
Returns the logprobability 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
(X)[source]¶ Return probability estimates for the test vector X.
 Parameters
 Xarraylike of shape (n_samples, n_features)
 Returns
 Carraylike of 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
(X, y, sample_weight=None)[source]¶ Return the mean accuracy on the given test data and labels.
In multilabel 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
 Xarraylike of shape (n_samples, n_features)
Test samples.
 yarraylike of shape (n_samples,) or (n_samples, n_outputs)
True labels for
X
. sample_weightarraylike of shape (n_samples,), default=None
Sample weights.
 Returns
 scorefloat
Mean accuracy of
self.predict(X)
wrt.y
.

set_params
(**params)[source]¶ Set the parameters of this estimator.
The method works on simple estimators as well as on nested objects (such as
Pipeline
). The latter have parameters of the form<component>__<parameter>
so that it’s possible to update each component of a nested object. Parameters
 **paramsdict
Estimator parameters.
 Returns
 selfestimator instance
Estimator instance.