hyperactive.base._optimizer.BaseOptimizer.get_search_config() - Code Metrics - Inspection of "V5 API rework - unified API for optimizers and exp..." - SimonBlanke/Hyperactive - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#110)

unknown

created 2025-05-17 13:44 UTC

BaseOptimizer.get_search_config() A

↳ Parent: hyperactive.base._optimizer

Complexity

Conditions

Size

Total Lines	11
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	4
dl	0
loc	11
rs	10
c	0
b	0
f	0
cc	1
nop	1

"""Base class for optimizer."""
# copyright: hyperactive developers, MIT License (see LICENSE file)

from skbase.base import BaseObject


class BaseOptimizer(BaseObject):
    """Base class for optimizer."""

    _tags = {
        "object_type": "optimizer",
        "python_dependencies": None,
    }

    def __init__(self):
        super().__init__()
        assert hasattr(self, "experiment"), "Optimizer must have an experiment."
        search_config = self.get_params()
        self._experiment = search_config.pop("experiment", None)

    def get_search_config(self):
        """Get the search configuration.

        Returns
        -------
        dict with str keys
            The search configuration dictionary.
        """
        search_config = self.get_params(deep=False)
        search_config.pop("experiment", None)
        return search_config

    def get_experiment(self):
        """Get the experiment.

        Returns
        -------
        BaseExperiment
            The experiment to optimize parameters for.
        """
        return self._experiment

    def run(self):
        """Run the optimization search process.

        Returns
        -------
        best_params : dict
            The best parameters found during the optimization process.
        """
        experiment = self.get_experiment()
        search_config = self.get_search_config()

        best_params = self._run(experiment, **search_config)
        self.best_params_ = best_params
        return best_params


1			"""Base class for optimizer."""
2			# copyright: hyperactive developers, MIT License (see LICENSE file)
3
4			from skbase.base import BaseObject
5
6
7			class BaseOptimizer(BaseObject):
8			"""Base class for optimizer."""
9
10			_tags = {
11			"object_type": "optimizer",
12			"python_dependencies": None,
13			}
14
15			def __init__(self):
16			super().__init__()
17			assert hasattr(self, "experiment"), "Optimizer must have an experiment."
18			search_config = self.get_params()
19			self._experiment = search_config.pop("experiment", None)
20
21			def get_search_config(self):
22			"""Get the search configuration.
23
24			Returns
25			-------
26			dict with str keys
27			The search configuration dictionary.
28			"""
29			search_config = self.get_params(deep=False)
30			search_config.pop("experiment", None)
31			return search_config
32
33			def get_experiment(self):
34			"""Get the experiment.
35
36			Returns
37			-------
38			BaseExperiment
39			The experiment to optimize parameters for.
40			"""
41			return self._experiment
42
43			def run(self):
44			"""Run the optimization search process.
45
46			Returns
47			-------
48			best_params : dict
49			The best parameters found during the optimization process.
50			"""
51			experiment = self.get_experiment()
52			search_config = self.get_search_config()
53
54			best_params = self._run(experiment, **search_config)
55			self.best_params_ = best_params
56			return best_params
57

SimonBlanke / Hyperactive

Pull Request — master (#110)

BaseOptimizer.get_search_config() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like