GridSearchOptimizer.__init__()   A
last analyzed

Complexity

Conditions 1

Size

Total Lines 23
Code Lines 22

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
eloc 22
dl 0
loc 23
rs 9.352
c 0
b 0
f 0
cc 1
nop 9

How to fix   Many Parameters   

Many Parameters

Methods with many parameters are not only hard to understand, but their parameters also often become inconsistent when you need more, or different data.

There are several approaches to avoid long parameter lists:

1
# Author: Simon Blanke
2
# Email: [email protected]
3
# License: MIT License
4
5
from typing import List, Dict, Literal, Union
6
7
from ..search import Search
8
from ..optimizers import GridSearchOptimizer as _GridSearchOptimizer
9
10
11
class GridSearchOptimizer(_GridSearchOptimizer, Search):
12
    """
13
    A class implementing **grid search** for the public API.
14
    Inheriting from the `Search`-class to get the `search`-method and from
15
    the `GridSearchOptimizer`-backend to get the underlying algorithm.
16
17
    Parameters
18
    ----------
19
    search_space : dict[str, list]
20
        The search space to explore. A dictionary with parameter
21
        names as keys and a numpy array as values.
22
    initialize : dict[str, int]
23
        The method to generate initial positions. A dictionary with
24
        the following key literals and the corresponding value type:
25
        {"grid": int, "vertices": int, "random": int, "warm_start": list[dict]}
26
    constraints : list[callable]
27
        A list of constraints, where each constraint is a callable.
28
        The callable returns `True` or `False` dependend on the input parameters.
29
    random_state : None, int
30
        If None, create a new random state. If int, create a new random state
31
        seeded with the value.
32
    rand_rest_p : float
33
        The probability of a random iteration during the the search process.
34
    step_size : int
35
        The step-size for the grid search.
36
    direction : "diagonal" or "orthogonal"
37
        The direction of the grid search.
38
    """
39
40
    def __init__(
41
        self,
42
        search_space: Dict[str, list],
43
        initialize: Dict[
44
            Literal["grid", "vertices", "random", "warm_start"],
45
            Union[int, list[dict]],
46
        ] = {"grid": 4, "random": 2, "vertices": 4},
47
        constraints: List[callable] = [],
48
        random_state: int = None,
49
        rand_rest_p: float = 0,
50
        nth_process: int = None,
51
        step_size: int = 1,
52
        direction: Literal["diagonal", "orthogonal"] = "diagonal",
53
    ):
54
        super().__init__(
55
            search_space=search_space,
56
            initialize=initialize,
57
            constraints=constraints,
58
            random_state=random_state,
59
            rand_rest_p=rand_rest_p,
60
            nth_process=nth_process,
61
            step_size=step_size,
62
            direction=direction,
63
        )
64