Skip to content

Commit 28d2dbc

Browse files
committed
better docstrings
1 parent f565519 commit 28d2dbc

2 files changed

Lines changed: 4 additions & 14 deletions

File tree

src/hyperactive/opt/gridsearch/_sk.py

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,20 +24,15 @@ class GridSearchSk(BaseOptimizer):
2424
error_score : float, default=np.nan
2525
The score to assign if an error occurs during the evaluation of a parameter set.
2626
27-
backend : {"dask", "loky", "multiprocessing", "threading","ray"}, by default "None".
28-
Runs parallel evaluate if specified and ``strategy`` is set as "refit".
27+
backend : {"dask", "loky", "multiprocessing", "threading", "ray"}, default = "None".
28+
Parallelization backend to use in the search process.
2929
3030
- "None": executes loop sequentally, simple list comprehension
3131
- "loky", "multiprocessing" and "threading": uses ``joblib.Parallel`` loops
3232
- "joblib": custom and 3rd party ``joblib`` backends, e.g., ``spark``
3333
- "dask": uses ``dask``, requires ``dask`` package in environment
3434
- "ray": uses ``ray``, requires ``ray`` package in environment
3535
36-
Recommendation: Use "dask" or "loky" for parallel evaluate.
37-
"threading" is unlikely to see speed ups due to the GIL and the serialization
38-
backend (``cloudpickle``) for "dask" and "loky" is generally more robust
39-
than the standard ``pickle`` library used in "multiprocessing".
40-
4136
backend_params : dict, optional
4237
additional parameters passed to the backend as config.
4338
Directly passed to ``utils.parallel.parallelize``.

src/hyperactive/opt/random_search.py

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,20 +31,15 @@ class RandomSearchSk(BaseOptimizer):
3131
error_score : float, default=np.nan
3232
Score assigned when the experiment raises an exception.
3333
34-
backend : {"dask", "loky", "multiprocessing", "threading","ray"}, by default "None".
35-
Runs parallel evaluate if specified and ``strategy`` is set as "refit".
34+
backend : {"dask", "loky", "multiprocessing", "threading", "ray"}, default = "None".
35+
Parallelization backend to use in the search process.
3636
3737
- "None": executes loop sequentally, simple list comprehension
3838
- "loky", "multiprocessing" and "threading": uses ``joblib.Parallel`` loops
3939
- "joblib": custom and 3rd party ``joblib`` backends, e.g., ``spark``
4040
- "dask": uses ``dask``, requires ``dask`` package in environment
4141
- "ray": uses ``ray``, requires ``ray`` package in environment
4242
43-
Recommendation: Use "dask" or "loky" for parallel evaluate.
44-
"threading" is unlikely to see speed ups due to the GIL and the serialization
45-
backend (``cloudpickle``) for "dask" and "loky" is generally more robust
46-
than the standard ``pickle`` library used in "multiprocessing".
47-
4843
backend_params : dict, optional
4944
additional parameters passed to the backend as config.
5045
Directly passed to ``utils.parallel.parallelize``.

0 commit comments

Comments
 (0)