Description
PR #22722 introduced a decorator to validate the parameters of functions. We now need to use it for all functions where it is applicable.
Please open one PR per function. The title of the PR must mention which function it's dealing with. We recommend using the following pattern for titles:
MAINT Parameters validation for <function>
where <function>
is a placeholder to be replaced with the function you chose.
The description of the PR must begin with Towards #24862
so that this issue and the PR are mutually crossed-linked.
Steps
-
Chose a public function that is documented in https://scikit-learn.org/dev/modules/classes.html. Check in the source code if the function contains some manual parameter validation (i.e. you should see some
if
condition and error raising). In case there is no validation in the function, you can report it in the issue where we will decide whether or not to skip the function. -
To validate the function, you need to decorate it with the decorator
sklearn.utils._param_validation.validate_params
. Do not rely only on the docstring of the estimator to define it: although it can help, it's important to primarily rely on the implementation to find the valid values because the docstring might not be completely accurate. The decorator take a Python dictionary as input where each key corresponds to a parameter name and the value corresponds to the associate constraints. You can find an example forkmeans_plusplus
belowscikit-learn/sklearn/cluster/_kmeans.py
Lines 63 to 74 in 2e481f1
_parameter_constraints
attribute). -
All existing simple param validation can now be removed. (simple means that does not depend on the input data or that does not depend on the value of another parameter for instance).
-
Tests that check error messages from simple param validation can also be removed (carefully: we need to keep the tests checking for more complex param validation !).
-
Finally, add the function to the list of the common param validation test
scikit-learn/sklearn/tests/test_public_functions.py
Lines 11 to 13 in 2e481f1
and make sure the test passes:pytest -vl sklearn/tests/test_public_functions.py
Functions already updated:
See "details" in section 1
Be aware that you can see an up-to-date list at the following link: https://github.com/scikit-learn/scikit-learn/blob/main/sklearn/tests/test_public_functions.py#L132