Skip to content

TST Allow callables as valid parameter regarding cloning estimator #25498

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jan 27, 2023
Merged

TST Allow callables as valid parameter regarding cloning estimator #25498

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9cf9b1d
TST Add NumPy ArrayFunctionDispatcher as an allowed type for cloning
jjerphan Jan 27, 2023
9c0652e
MAINT Add conditionnal check on NumPy's version
jjerphan Jan 27, 2023
f75c832
fixup! MAINT Add conditionnal check on NumPy's version
jjerphan Jan 27, 2023
00a56d0
[scipy-dev] TST Simply accept callable
jjerphan Jan 27, 2023
45071c4
[scipy-dev] DOC Document hypotheses regarding the support of callables
jjerphan Jan 27, 2023
950b5f9
[scipy-dev] Trigger CI due to failing job
jjerphan Jan 27, 2023
cf8b6e9
[scipy-dev] TST Improve assertion error message and comment
jjerphan Jan 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 14 additions & 8 deletions sklearn/utils/estimator_checks.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import types
import warnings
import pickle
import re
Expand Down Expand Up @@ -3297,18 +3296,25 @@ def param_filter(p):
tuple,
type(None),
type,
types.FunctionType,
joblib.Memory,
}
# Any numpy numeric such as np.int32.
allowed_types.update(np.core.numerictypes.allTypes.values())
assert type(init_param.default) in allowed_types, (

allowed_value = (
type(init_param.default) in allowed_types
or
# Although callables are mutable, we accept them as argument
# default value and trust that neither the implementation of
# the callable nor of the estimator changes the state of the
# callable.
callable(init_param.default)
)

assert allowed_value, (
f"Parameter '{init_param.name}' of estimator "
f"'{Estimator.__name__}' is of type "
f"{type(init_param.default).__name__} which is not "
"allowed. All init parameters have to be immutable to "
"make cloning possible. Therefore we restrict the set of "
"legal types to "
f"{type(init_param.default).__name__} which is not allowed. "
f"'{init_param.name}' must be a callable or must be of type "
f"{set(type.__name__ for type in allowed_types)}."
)
if init_param.name not in params.keys():
Expand Down