category_encoders

Open source

A library of sklearn compatible categorical variable encoders

2.5K stars0 likes2 views

About

A library of sklearn compatible categorical variable encoders

Categorical Encoding Methods

A set of scikit-learn-style transformers for encoding categorical variables into numeric by means of different techniques.

Important Links

Documentation: http://contrib.scikit-learn.org/category_encoders/

Encoding Methods

Unsupervised:

Backward Difference Contrast [2][3]
BaseN [6]
Binary [5]
Gray [14]
Count [10]
Hashing [1]
Helmert Contrast [2][3]
Ordinal [2][3]
One-Hot [2][3]
Multi-Hot [17]
Rank Hot [15]
Polynomial Contrast [2][3]
Sum Contrast [2][3]

Supervised:

CatBoost [11]
Count Target Encoding [17]
Generalized Linear Mixed Model [12]
James-Stein Estimator [9]
LeaveOneOut [4]
M-estimator [7]
Target Encoding [7]
Weight of Evidence [8]
Quantile Encoder [13]
Summary Encoder [13]

Installation

The package requires: numpy, statsmodels, and scipy.

To install the package, execute:

bash

$ python setup.py install

bash

pip install category_encoders

bash

conda install -c conda-forge category_encoders

To install the development version, you may use:

bash

pip install --upgrade git+https://github.com/scikit-learn-contrib/category_encoders

Usage

All of the encoders are fully compatible sklearn transformers, so they can be used in pipelines or in your existing scripts. Supported input formats include numpy arrays and pandas dataframes. If the cols parameter isn't passed, all columns with object or pandas categorical data type will be encoded. Please see the docs for transformer-specific configuration options.

Examples

There are two types of encoders: unsupervised and supervised. An unsupervised example:

python

from category_encoders import *
import pandas as pd

# prepare some data with categorical features
X = pd.DataFrame({
    'gender': ['male', 'female', 'female', 'male', 'female'],
    'country': ['US', 'UK', 'US', 'CA', 'UK'],
    'age': [25, 32, 47, 51, 38],
})

# use binary encoding to encode two categorical features
enc = BinaryEncoder(cols=['gender', 'country']).fit(X)

# transform the dataset
numeric_dataset = enc.transform(X)

And a supervised example:

…

For the transformation of the training data with the supervised methods, you should use fit_transform() method instead of fit().transform(), because these two methods do not have to generate the same result. The difference can be observed with LeaveOneOut encoder, which performs a nested cross-validation for the training data in fit_transform() method (to decrease over-fitting of the downstream model) but uses all the training data for scoring with transform() method (to get as accurate estimates as possible).

Furthermore, you may benefit from following wrappers:

PolynomialWrapper, which extends supervised encoders to support polynomial targets
NestedCVWrapper, which helps to prevent overfitting

Additional examples and benchmarks can be found in the examples directory.

Contributing

Category encoders is under active development, if you'd like to be involved, we'd love to have you. Check out the CONTRIBUTING.md file or open an issue on the github project to get started.