Skip to content

Commit a810a4b

Browse files
committed
Update documentation
1 parent bfb94f4 commit a810a4b

File tree

6 files changed

+12
-0
lines changed

6 files changed

+12
-0
lines changed

Diff for: category_encoders/cat_boost.py

+2
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212
class CatBoostEncoder(BaseEstimator, util.TransformerWithTargetMixin):
1313
"""CatBoost coding for categorical features.
1414
15+
Supported targets: binomial and continuous. For polynomial target support, see PolynomialWrapper.
16+
1517
This is very similar to leave-one-out encoding, but calculates the
1618
values "on-the-fly". Consequently, the values naturally vary
1719
during the training phase and it is not necessary to add random noise.

Diff for: category_encoders/glmm.py

+2
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616
class GLMMEncoder(BaseEstimator, util.TransformerWithTargetMixin):
1717
"""Generalized linear mixed model.
1818
19+
Supported targets: binomial and continuous. For polynomial target support, see PolynomialWrapper.
20+
1921
This is a supervised encoder similar to TargetEncoder or MEstimateEncoder, but there are some advantages:
2022
1) Solid statistical theory behind the technique. Mixed effects models are a mature branch of statistics.
2123
2) No hyper-parameters to tune. The amount of shrinkage is automatically determined through the estimation process.

Diff for: category_encoders/james_stein.py

+2
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414
class JamesSteinEncoder(BaseEstimator, util.TransformerWithTargetMixin):
1515
"""James-Stein estimator.
1616
17+
Supported targets: binomial and continuous. For polynomial target support, see PolynomialWrapper.
18+
1719
For feature value `i`, James-Stein estimator returns a weighted average of:
1820
1921
1. The mean target value for the observed feature value `i`.

Diff for: category_encoders/m_estimate.py

+2
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212
class MEstimateEncoder(BaseEstimator, util.TransformerWithTargetMixin):
1313
"""M-probability estimate of likelihood.
1414
15+
Supported targets: binomial and continuous. For polynomial target support, see PolynomialWrapper.
16+
1517
This is a simplified version of target encoder, which goes under names like m-probability estimate or
1618
additive smoothing with known incidence rates. In comparison to target encoder, m-probability estimate
1719
has only one tunable parameter (`m`), while target encoder has two tunable parameters (`min_samples_leaf`

Diff for: category_encoders/target_encoder.py

+2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
class TargetEncoder(BaseEstimator, util.TransformerWithTargetMixin):
1212
"""Target encoding for categorical features.
1313
14+
Supported targets: binomial and continuous. For polynomial target support, see PolynomialWrapper.
15+
1416
For the case of categorical target: features are replaced with a blend of posterior probability of the target
1517
given particular categorical value and the prior probability of the target over all the training data.
1618

Diff for: category_encoders/woe.py

+2
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212
class WOEEncoder(BaseEstimator, util.TransformerWithTargetMixin):
1313
"""Weight of Evidence coding for categorical features.
1414
15+
Supported targets: binomial. For polynomial target support, see PolynomialWrapper.
16+
1517
Parameters
1618
----------
1719

0 commit comments

Comments
 (0)