sklearn.preprocessing.OrdinalEncoder¶
-
class
sklearn.preprocessing.OrdinalEncoder(*, categories='auto', dtype=<class 'numpy.float64'>)[source]¶ Encode categorical features as an integer array.
The input to this transformer should be an array-like of integers or strings, denoting the values taken on by categorical (discrete) features. The features are converted to ordinal integers. This results in a single column of integers (0 to n_categories - 1) per feature.
Read more in the User Guide.
New in version 0.20.
- Parameters
- categories‘auto’ or a list of array-like, default=’auto’
Categories (unique values) per feature:
‘auto’ : Determine categories automatically from the training data.
list :
categories[i]holds the categories expected in the ith column. The passed categories should not mix strings and numeric values, and should be sorted in case of numeric values.
The used categories can be found in the
categories_attribute.- dtypenumber type, default np.float64
Desired dtype of output.
- Attributes
- categories_list of arrays
The categories of each feature determined during fitting (in order of the features in X and corresponding with the output of
transform).
See also
sklearn.preprocessing.OneHotEncoderPerforms a one-hot encoding of categorical features.
sklearn.preprocessing.LabelEncoderEncodes target labels with values between 0 and n_classes-1.
Examples
Given a dataset with two features, we let the encoder find the unique values per feature and transform the data to an ordinal encoding.
>>> from sklearn.preprocessing import OrdinalEncoder >>> enc = OrdinalEncoder() >>> X = [['Male', 1], ['Female', 3], ['Female', 2]] >>> enc.fit(X) OrdinalEncoder() >>> enc.categories_ [array(['Female', 'Male'], dtype=object), array([1, 2, 3], dtype=object)] >>> enc.transform([['Female', 3], ['Male', 1]]) array([[0., 2.], [1., 0.]])
>>> enc.inverse_transform([[1, 0], [0, 1]]) array([['Male', 1], ['Female', 2]], dtype=object)
Methods
fit(X[, y])Fit the OrdinalEncoder to X.
fit_transform(X[, y])Fit to data, then transform it.
get_params([deep])Get parameters for this estimator.
Convert the data back to the original representation.
set_params(**params)Set the parameters of this estimator.
transform(X)Transform X to ordinal codes.
-
__init__(*, categories='auto', dtype=<class 'numpy.float64'>)[source]¶ Initialize self. See help(type(self)) for accurate signature.
-
fit(X, y=None)[source]¶ Fit the OrdinalEncoder to X.
- Parameters
- Xarray-like, shape [n_samples, n_features]
The data to determine the categories of each feature.
- yNone
Ignored. This parameter exists only for compatibility with
sklearn.pipeline.Pipeline.
- Returns
- self
-
fit_transform(X, y=None, **fit_params)[source]¶ 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{array-like, sparse matrix, dataframe} of shape (n_samples, n_features)
- yndarray of shape (n_samples,), default=None
Target values.
- **fit_paramsdict
Additional fit parameters.
- Returns
- X_newndarray array of shape (n_samples, n_features_new)
Transformed array.
-
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
- paramsmapping of string to any
Parameter names mapped to their values.
-
inverse_transform(X)[source]¶ Convert the data back to the original representation.
- Parameters
- Xarray-like or sparse matrix, shape [n_samples, n_encoded_features]
The transformed data.
- Returns
- X_trarray-like, shape [n_samples, n_features]
Inverse transformed array.
-
set_params(**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.
