Passed
Push — master ( 7ebd63...8bd9a3 )
by Simon
06:11
created

SimulatedAnnealingOptimizer.__init__()   A

Complexity

Conditions 1

Size

Total Lines 30
Code Lines 29

Duplication

Lines 30
Ratio 100 %

Importance

Changes 0
Metric Value
eloc 29
dl 30
loc 30
rs 9.184
c 0
b 0
f 0
cc 1
nop 12

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, Literal
6
7
from ..search import Search
8
from ..optimizers import (
9
    SimulatedAnnealingOptimizer as _SimulatedAnnealingOptimizer,
10
)
11
12
13 View Code Duplication
class SimulatedAnnealingOptimizer(_SimulatedAnnealingOptimizer, Search):
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated in your project.
Loading history...
14
    """
15
    A class implementing **simulated annealing** for the public API.
16
    Inheriting from the `Search`-class to get the `search`-method and from
17
    the `SimulatedAnnealingOptimizer`-backend to get the underlying algorithm.
18
19
    Parameters
20
    ----------
21
    search_space : dict[str, list]
22
        The search space to explore. A dictionary with parameter
23
        names as keys and a numpy array as values.
24
    initialize : dict[str, int]
25
        The method to generate initial positions. A dictionary with
26
        the following key literals and the corresponding value type:
27
        {"grid": int, "vertices": int, "random": int, "warm_start": list[dict]}
28
    constraints : list[callable]
29
        A list of constraints, where each constraint is a callable.
30
        The callable returns `True` or `False` dependend on the input parameters.
31
    random_state : None, int
32
        If None, create a new random state. If int, create a new random state
33
        seeded with the value.
34
    rand_rest_p : float
35
        The probability of a random iteration during the the search process.
36
    epsilon : float
37
        The step-size for the climbing.
38
    distribution : str
39
        The type of distribution to sample from.
40
    n_neighbours : int
41
        The number of neighbours to sample and evaluate before moving to the best
42
        of those neighbours.
43
    annealing_rate : float
44
        The rate at which the temperature is annealed.
45
    start_temp : float
46
        The initial temperature.
47
    """
48
49
    def __init__(
50
        self,
51
        search_space: Dict[str, list],
52
        initialize: Dict[
53
            Literal["grid", "vertices", "random", "warm_start"], int | List
54
        ] = {"grid": 4, "random": 2, "vertices": 4},
55
        constraints: List[callable] = [],
56
        random_state: int = None,
57
        rand_rest_p: float = 0,
58
        nth_process: int = None,
59
        epsilon: float = 0.03,
60
        distribution: Literal[
61
            "normal", "laplace", "gumbel", "logistic"
62
        ] = "normal",
63
        n_neighbours: int = 3,
64
        annealing_rate: float = 0.97,
65
        start_temp: float = 1,
66
    ):
67
        super().__init__(
68
            search_space=search_space,
69
            initialize=initialize,
70
            constraints=constraints,
71
            random_state=random_state,
72
            rand_rest_p=rand_rest_p,
73
            nth_process=nth_process,
74
            epsilon=epsilon,
75
            distribution=distribution,
76
            n_neighbours=n_neighbours,
77
            annealing_rate=annealing_rate,
78
            start_temp=start_temp,
79
        )
80