prepare release 2.5.1

Author: PaulWestenthanner

CHANGELOG.md

@@ -1,5 +1,8 @@
 unreleased
 ==========
+
+v2.5.1
+==========
 * Added base class for contrast coding schemes in order to make them more maintainable
 * Added hierarchical column feature in target encoder
 * Fixed maximum recursion depth bug in hashing encoder

category_encoders/__init__.py

@@ -25,9 +25,9 @@
 from category_encoders.glmm import GLMMEncoder
 from category_encoders.quantile_encoder import QuantileEncoder, SummaryEncoder
 
-__version__ = '2.5.0'
+__version__ = '2.5.1'
 
-__author__ = "willmcginnis", "cmougan"
+__author__ = "willmcginnis", "cmougan", "paulwestenthanner"
 
 __all__ = [
     "BackwardDifferenceEncoder",

category_encoders/base_contrast_encoder.py

@@ -6,6 +6,7 @@
 import numpy as np
 from category_encoders.ordinal import OrdinalEncoder
 import category_encoders.utils as util
+import warnings
 
 __author__ = 'paulwestenthanner'
 
@@ -122,6 +123,8 @@ def transform_contrast_coding(X, mapping):
 
         # See issue 370 if it is necessary to add an intercept or not.
         X['intercept'] = pd.Series([1] * X.shape[0], index=X.index)
+        warnings.warn("Intercept column might not be added anymore in future releases (c.f. issue #370)",
+                      category=FutureWarning)
 
         for switch in mapping:
             col = switch.get('col')

category_encoders/datasets/_base.py

@@ -16,7 +16,7 @@ def load_compass():
 
     Returns
     -------
-    X: A pandas series containing features
+    X: A pandas data frame containing features
     y: A pandas series containing the target variable
 
     """
@@ -51,7 +51,7 @@ def load_postcodes(target_type='binary'):
 
     Returns
     -------
-    X: A pandas series containing features
+    X: A pandas data frame containing features
     y: A pandas series containing the target variable
 
     """