Source code for category_encoders.basen

"""BaseX encoding"""

import pandas as pd
import numpy as np
import re
from category_encoders.ordinal import OrdinalEncoder
import category_encoders.utils as util
import warnings

__author__ = 'willmcginnis'

def _ceillogint(n, base):
    Returns ceil(log(n, base)) for integers n and base.

    Uses integer math, so the result is not subject to floating point rounding errors.

    base must be >= 2 and n must be >= 1.
    if base < 2:
        raise ValueError('base must be >= 2')
    if n < 1:
        raise ValueError('n must be >= 1')

    n -= 1
    ret = 0
    while n > 0:
        ret += 1
        n //= base
    return ret

[docs]class BaseNEncoder(util.BaseEncoder, util.UnsupervisedTransformerMixin): """Base-N encoder encodes the categories into arrays of their base-N representation. A base of 1 is equivalent to one-hot encoding (not really base-1, but useful), a base of 2 is equivalent to binary encoding. N=number of actual categories is equivalent to vanilla ordinal encoding. Parameters ---------- verbose: int integer indicating verbosity of the output. 0 for none. cols: list a list of columns to encode, if None, all string columns will be encoded. drop_invariant: bool boolean for whether or not to drop columns with 0 variance. return_df: bool boolean for whether to return a pandas DataFrame from transform (otherwise it will be a numpy array). base: int when the downstream model copes well with nonlinearities (like decision tree), use higher base. handle_unknown: str options are 'error', 'return_nan', 'value', and 'indicator'. The default is 'value'. Warning: if indicator is used, an extra column will be added in if the transform matrix has unknown categories. This can cause unexpected changes in dimension in some cases. handle_missing: str options are 'error', 'return_nan', 'value', and 'indicator'. The default is 'value'. Warning: if indicator is used, an extra column will be added in if the transform matrix has nan values. This can cause unexpected changes in dimension in some cases. Example ------- >>> from category_encoders import * >>> import pandas as pd >>> from sklearn.datasets import fetch_openml >>> bunch = fetch_openml(name="house_prices", as_frame=True) >>> display_cols = ["Id", "MSSubClass", "MSZoning", "LotFrontage", "YearBuilt", "Heating", "CentralAir"] >>> y = >>> X = pd.DataFrame(, columns=bunch.feature_names)[display_cols] >>> enc = BaseNEncoder(cols=['CentralAir', 'Heating']).fit(X, y) >>> numeric_dataset = enc.transform(X) >>> print( <class 'pandas.core.frame.DataFrame'> RangeIndex: 1460 entries, 0 to 1459 Data columns (total 10 columns): # Column Non-Null Count Dtype --- ------ -------------- ----- 0 Id 1460 non-null float64 1 MSSubClass 1460 non-null float64 2 MSZoning 1460 non-null object 3 LotFrontage 1201 non-null float64 4 YearBuilt 1460 non-null float64 5 Heating_0 1460 non-null int64 6 Heating_1 1460 non-null int64 7 Heating_2 1460 non-null int64 8 CentralAir_0 1460 non-null int64 9 CentralAir_1 1460 non-null int64 dtypes: float64(4), int64(5), object(1) memory usage: 114.2+ KB None """ prefit_ordinal = True encoding_relation = util.EncodingRelation.N_TO_M def __init__(self, verbose=0, cols=None, mapping=None, drop_invariant=False, return_df=True, base=2, handle_unknown='value', handle_missing='value'): super().__init__(verbose=verbose, cols=cols, drop_invariant=drop_invariant, return_df=return_df, handle_unknown=handle_unknown, handle_missing=handle_missing) self.mapping = mapping self.ordinal_encoder = None self.base = base def _fit(self, X, y=None, **kwargs): # train an ordinal pre-encoder self.ordinal_encoder = OrdinalEncoder( verbose=self.verbose, cols=self.cols, handle_unknown='value', handle_missing='value' ) self.ordinal_encoder = self.mapping = self.fit_base_n_encoding(X) def fit_base_n_encoding(self, X): mappings_out = [] for switch in self.ordinal_encoder.category_mapping: col = switch.get('col') values = switch.get('mapping') if self.handle_missing == 'value': values = values[values > 0] if self.handle_unknown == 'indicator': values = np.append(values, -1) digits = self.calc_required_digits(values) X_unique = pd.DataFrame(index=values, columns=[f"{col}_{x}" for x in range(digits)], data=np.array([self.col_transform(x, digits) for x in range(1, len(values) + 1)])) if self.handle_unknown == 'return_nan': X_unique.loc[-1] = np.nan elif self.handle_unknown == 'value': X_unique.loc[-1] = 0 if self.handle_missing == 'return_nan': X_unique.loc[values.loc[np.nan]] = np.nan elif self.handle_missing == 'value': X_unique.loc[-2] = 0 mappings_out.append({'col': col, 'mapping': X_unique}) return mappings_out def _transform(self, X): X_out = self.ordinal_encoder.transform(X) if self.handle_unknown == 'error': if X_out[self.cols].isin([-1]).any().any(): raise ValueError('Columns to be encoded can not contain new values') X_out = self.basen_encode(X_out, cols=self.cols) return X_out
[docs] def inverse_transform(self, X_in): """ Perform the inverse transformation to encoded data. Parameters ---------- X_in : array-like, shape = [n_samples, n_features] Returns ------- p: array, the same size of X_in """ # fail fast if self._dim is None: raise ValueError('Must train encoder before it can be used to inverse_transform data') # unite the type into pandas dataframe (it makes the input size detection code easier...) and make deep copy X = util.convert_input(X_in, columns=self.feature_names_out_, deep=True) X = self.basen_to_integer(X, self.cols, self.base) # make sure that it is the right size if X.shape[1] != self._dim: if self.drop_invariant: raise ValueError(f"Unexpected input dimension {X.shape[1]}, the attribute drop_invariant should " "be False when transforming the data") else: raise ValueError(f'Unexpected input dimension {X.shape[1]}, expected {self._dim}') if not list(self.cols): return X if self.return_df else X.values for switch in self.ordinal_encoder.mapping: column_mapping = switch.get('mapping') inverse = pd.Series(data=column_mapping.index, index=column_mapping.values) X[switch.get('col')] = X[switch.get('col')].map(inverse).astype(switch.get('data_type')) if self.handle_unknown == 'return_nan' and self.handle_missing == 'return_nan': for col in self.cols: if X[switch.get('col')].isnull().any(): warnings.warn("inverse_transform is not supported because transform impute " f"the unknown category nan when encode {col}") return X if self.return_df else X.values
def calc_required_digits(self, values): # figure out how many digits we need to represent the classes present if self.base == 1: digits = len(values) + 1 else: digits = _ceillogint(len(values) + 1, self.base) return digits
[docs] def basen_encode(self, X_in, cols=None): """ Basen encoding encodes the integers as basen code with one column per digit. Parameters ---------- X_in: DataFrame cols: list-like, default None Column names in the DataFrame to be encoded Returns ------- dummies : DataFrame """ X = X_in.copy(deep=True) cols = X.columns.values.tolist() for switch in self.mapping: col = switch.get('col') mod = switch.get('mapping') base_df = mod.reindex(X[col]) base_df.set_index(X.index, inplace=True) X = pd.concat([base_df, X], axis=1) old_column_index = cols.index(col) cols[old_column_index: old_column_index + 1] = mod.columns return X.reindex(columns=cols)
[docs] def basen_to_integer(self, X, cols, base): """ Convert basen code as integers. Parameters ---------- X : DataFrame encoded data cols : list-like Column names in the DataFrame that be encoded base : int The base of transform Returns ------- numerical: DataFrame """ out_cols = X.columns.values.tolist() for col in cols: col_list = [col0 for col0 in out_cols if re.match(re.escape(str(col))+'_\\d+', str(col0))] insert_at = out_cols.index(col_list[0]) if base == 1: value_array = np.array([int(col0.split('_')[-1]) for col0 in col_list]) else: len0 = len(col_list) value_array = np.array([base ** (len0 - 1 - i) for i in range(len0)]) X.insert(insert_at, col,[col_list].values, value_array.T)) X.drop(col_list, axis=1, inplace=True) out_cols = X.columns.values.tolist() return X
[docs] def col_transform(self, col, digits): """ The lambda body to transform the column values """ if col is None or float(col) < 0.0: return None else: col = self.number_to_base(int(col), self.base, digits) if len(col) == digits: return col else: return [0 for _ in range(digits - len(col))] + col
@staticmethod def number_to_base(n, b, limit): if b == 1: return [0 if n != _ else 1 for _ in range(limit)] if n == 0: return [0 for _ in range(limit)] digits = [] for _ in range(limit): digits.append(int(n % b)) n, _ = divmod(n, b) return digits[::-1]