sklearn.preprocessing.KBinsDiscretizer

class sklearn.preprocessing.KBinsDiscretizer(n_bins=5, encode='onehot', strategy='quantile')

Bin continuous data into intervals.

Read more in the User Guide.

Parameters:

n_bins : int or array-like, shape (n_features,) (default=5)

The number of bins to produce. The intervals for the bins are determined by the minimum and maximum of the input data. Raises ValueError if n_bins < 2.

If n_bins is an array, and there is an ignored feature at index i, n_bins[i] will be ignored.

encode : {‘onehot’, ‘onehot-dense’, ‘ordinal’}, (default=’onehot’)

Method used to encode the transformed result.

onehot

Encode the transformed result with one-hot encoding and return a sparse matrix. Ignored features are always stacked to the right.

onehot-dense

Encode the transformed result with one-hot encoding and return a dense array. Ignored features are always stacked to the right.

ordinal

Return the bin identifier encoded as an integer value.

strategy : {‘uniform’, ‘quantile’, ‘kmeans’}, (default=’quantile’)

Strategy used to define the widths of the bins.

uniform

All bins in each feature have identical widths.

quantile

All bins in each feature have the same number of points.

kmeans

Values in each bin have the same nearest center of a 1D k-means cluster.

Attributes

n_bins_ (int array, shape (n_features,)) Number of bins per feature. An ignored feature at index i will have n_bins_[i] == 0.
bin_edges_ (array of arrays, shape (n_features, )) The edges of each bin. Contain arrays of varying shapes (n_bins_, ) Ignored features will have empty arrays.

See also

sklearn.preprocessing.Binarizer
class used to bin values as 0 or 1 based on a parameter threshold.

Notes

In bin edges for feature i, the first and last values are used only for inverse_transform. During transform, bin edges are extended to:

np.concatenate([-np.inf, bin_edges_[i][1:-1], np.inf])

You can combine KBinsDiscretizer with sklearn.compose.ColumnTransformer if you only want to preprocess part of the features.

Examples

>>> X = [[-2, 1, -4,   -1],
...      [-1, 2, -3, -0.5],
...      [ 0, 3, -2,  0.5],
...      [ 1, 4, -1,    2]]
>>> est = KBinsDiscretizer(n_bins=3, encode='ordinal', strategy='uniform')
>>> est.fit(X)  # doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE
KBinsDiscretizer(...)
>>> Xt = est.transform(X)
>>> Xt  # doctest: +SKIP
array([[ 0., 0., 0., 0.],
       [ 1., 1., 1., 0.],
       [ 2., 2., 2., 1.],
       [ 2., 2., 2., 2.]])

Sometimes it may be useful to convert the data back into the original feature space. The inverse_transform function converts the binned data into the original feature space. Each value will be equal to the mean of the two bin edges.

>>> est.bin_edges_[0]
array([-2., -1.,  0.,  1.])
>>> est.inverse_transform(Xt)
array([[-1.5,  1.5, -3.5, -0.5],
       [-0.5,  2.5, -2.5, -0.5],
       [ 0.5,  3.5, -1.5,  0.5],
       [ 0.5,  3.5, -1.5,  1.5]])

Methods

fit(X[, y]) Fits the estimator.
fit_transform(X[, y]) Fit to data, then transform it.
get_params([deep]) Get parameters for this estimator.
inverse_transform(Xt) Transforms discretized data back to original feature space.
set_params(**params) Set the parameters of this estimator.
transform(X) Discretizes the data.
__init__(n_bins=5, encode='onehot', strategy='quantile')

Initialize self. See help(type(self)) for accurate signature.

fit(X, y=None)

Fits the estimator.

Parameters:

X : numeric array-like, shape (n_samples, n_features)

Data to be discretized.

y : ignored

Returns:

self

fit_transform(X, y=None, **fit_params)

Fit to data, then transform it.

Fits transformer to X and y with optional parameters fit_params and returns a transformed version of X.

Parameters:

X : numpy array of shape [n_samples, n_features]

Training set.

y : numpy array of shape [n_samples]

Target values.

Returns:

X_new : numpy array of shape [n_samples, n_features_new]

Transformed array.

get_params(deep=True)

Get parameters for this estimator.

Parameters:

deep : boolean, optional

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

Returns:

params : mapping of string to any

Parameter names mapped to their values.

inverse_transform(Xt)

Transforms discretized data back to original feature space.

Note that this function does not regenerate the original data due to discretization rounding.

Parameters:

Xt : numeric array-like, shape (n_sample, n_features)

Transformed data in the binned space.

Returns:

Xinv : numeric array-like

Data in the original feature space.

set_params(**params)

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
transform(X)

Discretizes the data.

Parameters:

X : numeric array-like, shape (n_samples, n_features)

Data to be discretized.

Returns:

Xt : numeric array-like or sparse matrix

Data in the binned space.