gradient_free_optimizers.optimizer_search.grid_search

Complexity

Total Complexity

1

Size/Duplication

Total Lines	63
Duplicated Lines	0 %

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	GridSearchOptimizer.__init__()	0	23	1

# Author: Simon Blanke
# Email: simon.blanke@yahoo.com
# License: MIT License

from typing import List, Dict, Literal, Union

from ..search import Search
from ..optimizers import GridSearchOptimizer as _GridSearchOptimizer


class GridSearchOptimizer(_GridSearchOptimizer, Search):
    """
    A class implementing **grid search** for the public API.
    Inheriting from the `Search`-class to get the `search`-method and from
    the `GridSearchOptimizer`-backend to get the underlying algorithm.

    Parameters
    ----------
    search_space : dict[str, list]
        The search space to explore. A dictionary with parameter
        names as keys and a numpy array as values.
    initialize : dict[str, int]
        The method to generate initial positions. A dictionary with
        the following key literals and the corresponding value type:
        {"grid": int, "vertices": int, "random": int, "warm_start": list[dict]}
    constraints : list[callable]
        A list of constraints, where each constraint is a callable.
        The callable returns `True` or `False` dependend on the input parameters.
    random_state : None, int
        If None, create a new random state. If int, create a new random state
        seeded with the value.
    rand_rest_p : float
        The probability of a random iteration during the the search process.
    step_size : int
        The step-size for the grid search.
    direction : "diagonal" or "orthogonal"
        The direction of the grid search.
    """

    def __init__(
        self,
        search_space: Dict[str, list],
        initialize: Dict[
            Literal["grid", "vertices", "random", "warm_start"],
            Union[int, list[dict]],
        ] = {"grid": 4, "random": 2, "vertices": 4},
        constraints: List[callable] = [],
        random_state: int = None,
        rand_rest_p: float = 0,
        nth_process: int = None,
        step_size: int = 1,
        direction: Literal["diagonal", "orthogonal"] = "diagonal",
    ):
        super().__init__(
            search_space=search_space,
            initialize=initialize,
            constraints=constraints,
            random_state=random_state,
            rand_rest_p=rand_rest_p,
            nth_process=nth_process,
            step_size=step_size,
            direction=direction,
        )