imblearn.over_sampling
.BorderlineSMOTE¶

class
imblearn.over_sampling.
BorderlineSMOTE
(sampling_strategy='auto', random_state=None, k_neighbors=5, n_jobs=None, m_neighbors=10, kind='borderline1')[source]¶ Oversampling using Borderline SMOTE.
This algorithm is a variant of the original SMOTE algorithm proposed in [R63962efaf1972]. Borderline samples will be detected and used to generate new synthetic samples.
Read more in the User Guide.
 Parameters
 sampling_strategyfloat, str, dict or callable, default=’auto’
Sampling information to resample the data set.
When
float
, it corresponds to the desired ratio of the number of samples in the minority class over the number of samples in the majority class after resampling. Therefore, the ratio is expressed as where is the number of samples in the minority class after resampling and is the number of samples in the majority class.Warning
float
is only available for binary classification. An error is raised for multiclass classification.When
str
, specify the class targeted by the resampling. The number of samples in the different classes will be equalized. Possible choices are:'minority'
: resample only the minority class;'not minority'
: resample all classes but the minority class;'not majority'
: resample all classes but the majority class;'all'
: resample all classes;'auto'
: equivalent to'not majority'
.When
dict
, the keys correspond to the targeted classes. The values correspond to the desired number of samples for each targeted class.When callable, function taking
y
and returns adict
. The keys correspond to the targeted classes. The values correspond to the desired number of samples for each class.
 random_stateint, RandomState instance, default=None
Control the randomization of the algorithm.
If int,
random_state
is the seed used by the random number generator;If
RandomState
instance, random_state is the random number generator;If
None
, the random number generator is theRandomState
instance used bynp.random
.
 k_neighborsint or object, default=5
If
int
, number of nearest neighbours to used to construct synthetic samples. If object, an estimator that inherits fromsklearn.neighbors.base.KNeighborsMixin
that will be used to find the k_neighbors. n_jobsint, default=None
Number of CPU cores used during the crossvalidation loop.
None
means 1 unless in ajoblib.parallel_backend
context.1
means using all processors. See Glossary for more details. m_neighborsint or object, default=10
If int, number of nearest neighbours to use to determine if a minority sample is in danger. If object, an estimator that inherits from
sklearn.neighbors.base.KNeighborsMixin
that will be used to find the m_neighbors. kind{“borderline1”, “borderline2”}, default=’borderline1’
The type of SMOTE algorithm to use one of the following options:
'borderline1'
,'borderline2'
.
See also
SMOTE
Oversample using SMOTE.
SMOTENC
Oversample using SMOTE for continuous and categorical features.
SVMSMOTE
Oversample using SVMSMOTE variant.
ADASYN
Oversample using ADASYN.
KMeansSMOTE
Oversample applying a clustering before to oversample using SMOTE.
Notes
See the original papers: [R63962efaf1972] for more details.
Supports multiclass resampling. A onevs.rest scheme is used as originally proposed in [R63962efaf1971].
References
 R63962efaf1971
N. V. Chawla, K. W. Bowyer, L. O.Hall, W. P. Kegelmeyer, “SMOTE: synthetic minority oversampling technique,” Journal of artificial intelligence research, 321357, 2002.
 R63962efaf1972(1,2)
H. Han, W. WenYuan, M. BingHuan, “BorderlineSMOTE: a new oversampling method in imbalanced data sets learning,” Advances in intelligent computing, 878887, 2005.
Examples
>>> from collections import Counter >>> from sklearn.datasets import make_classification >>> from imblearn.over_sampling import BorderlineSMOTE >>> X, y = make_classification(n_classes=2, class_sep=2, ... weights=[0.1, 0.9], n_informative=3, n_redundant=1, flip_y=0, ... n_features=20, n_clusters_per_class=1, n_samples=1000, random_state=10) >>> print('Original dataset shape %s' % Counter(y)) Original dataset shape Counter({1: 900, 0: 100}) >>> sm = BorderlineSMOTE(random_state=42) >>> X_res, y_res = sm.fit_resample(X, y) >>> print('Resampled dataset shape %s' % Counter(y_res)) Resampled dataset shape Counter({0: 900, 1: 900})

__init__
(self, sampling_strategy='auto', random_state=None, k_neighbors=5, n_jobs=None, m_neighbors=10, kind='borderline1')[source]¶ Initialize self. See help(type(self)) for accurate signature.

fit
(self, X, y)[source]¶ Check inputs and statistics of the sampler.
You should use
fit_resample
in all cases. Parameters
 X{arraylike, dataframe, sparse matrix} of shape (n_samples, n_features)
Data array.
 yarraylike of shape (n_samples,)
Target array.
 Returns
 selfobject
Return the instance itself.

fit_resample
(self, X, y)[source]¶ Resample the dataset.
 Parameters
 X{arraylike, dataframe, sparse matrix} of shape (n_samples, n_features)
Matrix containing the data which have to be sampled.
 yarraylike of shape (n_samples,)
Corresponding label for each sample in X.
 Returns
 X_resampled{arraylike, dataframe, sparse matrix} of shape (n_samples_new, n_features)
The array containing the resampled data.
 y_resampledarraylike of shape (n_samples_new,)
The corresponding label of X_resampled.

fit_sample
(self, X, y)[source]¶ Resample the dataset.
 Parameters
 X{arraylike, dataframe, sparse matrix} of shape (n_samples, n_features)
Matrix containing the data which have to be sampled.
 yarraylike of shape (n_samples,)
Corresponding label for each sample in X.
 Returns
 X_resampled{arraylike, dataframe, sparse matrix} of shape (n_samples_new, n_features)
The array containing the resampled data.
 y_resampledarraylike of shape (n_samples_new,)
The corresponding label of X_resampled.

get_params
(self, 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
 paramsmapping of string to any
Parameter names mapped to their values.

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. Parameters
 **paramsdict
Estimator parameters.
 Returns
 selfobject
Estimator instance.