sklego/grouped-shrinkage-arguments
| Rule | grouped-shrinkage-arguments |
|---|---|
| Pack | scikit-lego |
| Severity | error |
| Fix | unsafe, with xpd check --fix --unsafe-fixes |
| Library versions | every version |
GroupedClassifier drops a shrinkage keyword without an error, so the setting has no effect. Use HierarchicalClassifier, which takes shrinkage=, or remove the keyword.
classifier = GroupedClassifier(LogisticRegression(), groups=["shop"], shrinkage="relative")regressor = GroupedRegressor(LinearRegression(), groups=["region", "shop"], shrinkage="constant", alpha=0.1)classifier = HierarchicalClassifier(LogisticRegression(), groups=["shop"], shrinkage="relative")regressor = GroupedRegressor(LinearRegression(), groups=["region", "shop"], shrinkage="constant", shrinkage_kwargs={"alpha": 0.1})What the rule reports
Section titled “What the rule reports”The rule reports spellings of shrinkage that fail on the grouped and hierarchical meta estimators:
- any extra keyword on
GroupedClassifier, which drops it shrinkage="constant"or"min_n_obs"withoutshrinkage_kwargs- a bare
alpha=ormin_n_obs=keyword
How to fix it
Section titled “How to fix it”xpd check --fix --unsafe-fixes applies the fixes of this rule. Check the result, because an unsafe fix can change what the code does.
The unsafe fix writes shrinkage_kwargs={"alpha": 0.1} for alpha=0.1, and the same for min_n_obs=. The other forms have no fix.
GroupedClassifier ends its signature with **shrinkage_kwargs and never reads it. With
shrinkage="relative" its probabilities were bit equal to the probabilities without the keyword. They
differed by up to 0.29 from HierarchicalClassifier(shrinkage="relative"), which does shrink.
| Form | Error |
|---|---|
shrinkage="constant" without a setting |
TypeError "constant_shrinkage() missing 1 required positional argument: 'alpha'" in fit |
a bare alpha= keyword |
TypeError "got an unexpected keyword argument 'alpha'" |
GroupedPredictor took the bare keyword until scikit-lego 0.9.2, so the document about its bare
keyword carries since: "0.9.2".
Message
Section titled “Message”xpd prints this message with the issue. A name that starts with $ stands for code from your file.
GroupedClassifier drops $K= without an error, because its signature ends in **shrinkage_kwargs and never reads it. With shrinkage="relative" the probabilities were bit equal to those without it. Use HierarchicalClassifier, which takes shrinkage=, or remove the keyword.Browse the other rules of the scikit-lego pack.