add _tags to optimizers

SimonBlanke · SimonBlanke · commit 1eba3bbd6227 · 2025-06-19T21:07:00.000+02:00
diff --git a/src/hyperactive/opt/gfo/_bayesian_optimization.py b/src/hyperactive/opt/gfo/_bayesian_optimization.py
@@ -76,7 +76,14 @@ class BayesianOptimizer(_BaseGFOadapter):
 
     Best parameters can also be accessed via:
     >>> best_params = optimizer.best_params_
- """
+    """
+    _tags = {
+        "info:name": "Bayesian Optimization",
+        "info:local_vs_global": "global",
+        "info:explore_vs_exploit": "exploit",
+        "info:compute": "high",
+    }
+
 
     def __init__(
         self,
@@ -146,4 +153,4 @@ def get_test_params(cls, parameter_set="default"):
             "n_iter": 100,
         }
         params.append(more_params)
-        return params
+        return params
diff --git a/src/hyperactive/opt/gfo/_differential_evolution.py b/src/hyperactive/opt/gfo/_differential_evolution.py
@@ -70,7 +70,14 @@ class DifferentialEvolution(_BaseGFOadapter):
 
     Best parameters can also be accessed via:
     >>> best_params = optimizer.best_params_
- """
+    """
+    _tags = {
+        "info:name": "Differential Evolution",
+        "info:local_vs_global": "global",
+        "info:explore_vs_exploit": "explore",
+        "info:compute": "middle",
+    }
+
 
     def __init__(
         self,
@@ -137,4 +144,4 @@ def get_test_params(cls, parameter_set="default"):
             "n_iter": 100,
         }
         params.append(more_params)
-        return params
+        return params
diff --git a/src/hyperactive/opt/gfo/_direct_algorithm.py b/src/hyperactive/opt/gfo/_direct_algorithm.py
@@ -72,7 +72,14 @@ class DirectAlgorithm(_BaseGFOadapter):
 
     Best parameters can also be accessed via:
     >>> best_params = optimizer.best_params_
- """
+    """
+    _tags = {
+        "info:name": "DIRECT Algorithm",
+        "info:local_vs_global": "global",
+        "info:explore_vs_exploit": "mixed",
+        "info:compute": "high",
+    }
+
 
     def __init__(
         self,
@@ -140,4 +147,4 @@ def get_test_params(cls, parameter_set="default"):
             "n_iter": 100,
         }
         params.append(more_params)
-        return params
+        return params
diff --git a/src/hyperactive/opt/gfo/_downhill_simplex.py b/src/hyperactive/opt/gfo/_downhill_simplex.py
@@ -72,7 +72,14 @@ class DownhillSimplexOptimizer(_BaseGFOadapter):
 
     Best parameters can also be accessed via:
     >>> best_params = optimizer.best_params_
- """
+    """
+    _tags = {
+        "info:name": "Downhill Simplex",
+        "info:local_vs_global": "local",
+        "info:explore_vs_exploit": "exploit",
+        "info:compute": "low",
+    }
+
 
     def __init__(
         self,
@@ -142,4 +149,4 @@ def get_test_params(cls, parameter_set="default"):
             "n_iter": 100,
         }
         params.append(more_params)
-        return params
+        return params
diff --git a/src/hyperactive/opt/gfo/_evolution_strategy.py b/src/hyperactive/opt/gfo/_evolution_strategy.py
@@ -76,7 +76,14 @@ class EvolutionStrategy(_BaseGFOadapter):
 
     Best parameters can also be accessed via:
     >>> best_params = optimizer.best_params_
- """
+    """
+    _tags = {
+        "info:name": "Evolution Strategy",
+        "info:local_vs_global": "global",
+        "info:explore_vs_exploit": "explore",
+        "info:compute": "middle",
+    }
+
 
     def __init__(
         self,
@@ -149,4 +156,4 @@ def get_test_params(cls, parameter_set="default"):
             "n_iter": 100,
         }
         params.append(more_params)
-        return params
+        return params
diff --git a/src/hyperactive/opt/gfo/_forest_optimizer.py b/src/hyperactive/opt/gfo/_forest_optimizer.py
@@ -78,7 +78,14 @@ class ForestOptimizer(_BaseGFOadapter):
 
     Best parameters can also be accessed via:
     >>> best_params = optimizer.best_params_
- """
+    """
+    _tags = {
+        "info:name": "Forest Optimizer",
+        "info:local_vs_global": "global",
+        "info:explore_vs_exploit": "explore",
+        "info:compute": "middle",
+    }
+
 
     def __init__(
         self,
@@ -153,4 +160,4 @@ def get_test_params(cls, parameter_set="default"):
             "n_iter": 100,
         }
         params.append(more_params)
-        return params
+        return params
diff --git a/src/hyperactive/opt/gfo/_genetic_algorithm.py b/src/hyperactive/opt/gfo/_genetic_algorithm.py
@@ -76,7 +76,14 @@ class GeneticAlgorithm(_BaseGFOadapter):
 
     Best parameters can also be accessed via:
     >>> best_params = optimizer.best_params_
- """
+    """
+    _tags = {
+        "info:name": "Genetic Algorithm",
+        "info:local_vs_global": "global",
+        "info:explore_vs_exploit": "explore",
+        "info:compute": "high",
+    }
+
 
     def __init__(
         self,
@@ -152,4 +159,4 @@ def get_test_params(cls, parameter_set="default"):
             "n_iter": 100,
         }
         params.append(more_params)
-        return params
+        return params
diff --git a/src/hyperactive/opt/gfo/_grid_search.py b/src/hyperactive/opt/gfo/_grid_search.py
@@ -68,7 +68,14 @@ class GridSearch(_BaseGFOadapter):
 
     Best parameters can also be accessed via:
     >>> best_params = optimizer.best_params_
- """
+    """
+    _tags = {
+        "info:name": "Grid Search",
+        "info:local_vs_global": "global",
+        "info:explore_vs_exploit": "explore",
+        "info:compute": "high",
+    }
+
 
     def __init__(
         self,
@@ -132,4 +139,4 @@ def get_test_params(cls, parameter_set="default"):
             "n_iter": 100,
         }
         params.append(more_params)
-        return params
+        return params
diff --git a/src/hyperactive/opt/gfo/_hillclimbing.py b/src/hyperactive/opt/gfo/_hillclimbing.py
@@ -1,4 +1,5 @@
 """Hill climbing optimizer from gfo."""
+
 # copyright: hyperactive developers, MIT License (see LICENSE file)
 
 from hyperactive.opt._adapters._gfo import _BaseGFOadapter
@@ -60,7 +61,7 @@ class HillClimbing(_BaseGFOadapter):
     2. setting up the hill climbing optimizer:
     >>> from hyperactive.opt import HillClimbing
     >>> import numpy as np
-    >>> 
+    >>>
     >>> hillclimbing_config = {
     ...     "search_space": {
     ...         "C": np.array([0.01, 0.1, 1, 10]),
diff --git a/src/hyperactive/opt/gfo/_lipschitz_optimization.py b/src/hyperactive/opt/gfo/_lipschitz_optimization.py
@@ -72,7 +72,14 @@ class LipschitzOptimizer(_BaseGFOadapter):
 
     Best parameters can also be accessed via:
     >>> best_params = optimizer.best_params_
- """
+    """
+    _tags = {
+        "info:name": "Lipschitz Optimization",
+        "info:local_vs_global": "global",
+        "info:explore_vs_exploit": "mixed",
+        "info:compute": "high",
+    }
+
 
     def __init__(
         self,
@@ -140,4 +147,4 @@ def get_test_params(cls, parameter_set="default"):
             "n_iter": 100,
         }
         params.append(more_params)
-        return params
+        return params
diff --git a/src/hyperactive/opt/gfo/_parallel_tempering.py b/src/hyperactive/opt/gfo/_parallel_tempering.py
@@ -71,7 +71,14 @@ class ParallelTempering(_BaseGFOadapter):
 
     Best parameters can also be accessed via:
     >>> best_params = optimizer.best_params_
- """
+    """
+    _tags = {
+        "info:name": "Parallel Tempering",
+        "info:local_vs_global": "global",
+        "info:explore_vs_exploit": "explore",
+        "info:compute": "high",
+    }
+
 
     def __init__(
         self,
@@ -135,4 +142,4 @@ def get_test_params(cls, parameter_set="default"):
             "n_iter": 100,
         }
         params.append(more_params)
-        return params
+        return params
diff --git a/src/hyperactive/opt/gfo/_particle_swarm_optimization.py b/src/hyperactive/opt/gfo/_particle_swarm_optimization.py
@@ -74,7 +74,14 @@ class ParticleSwarmOptimizer(_BaseGFOadapter):
 
     Best parameters can also be accessed via:
     >>> best_params = optimizer.best_params_
- """
+    """
+    _tags = {
+        "info:name": "Particle Swarm Optimization",
+        "info:local_vs_global": "global",
+        "info:explore_vs_exploit": "explore",
+        "info:compute": "middle",
+    }
+
 
     def __init__(
         self,
@@ -147,4 +154,4 @@ def get_test_params(cls, parameter_set="default"):
             "n_iter": 100,
         }
         params.append(more_params)
-        return params
+        return params
diff --git a/src/hyperactive/opt/gfo/_pattern_search.py b/src/hyperactive/opt/gfo/_pattern_search.py
@@ -70,7 +70,14 @@ class PatternSearch(_BaseGFOadapter):
 
     Best parameters can also be accessed via:
     >>> best_params = optimizer.best_params_
- """
+    """
+    _tags = {
+        "info:name": "Pattern Search",
+        "info:local_vs_global": "local",
+        "info:explore_vs_exploit": "explore",
+        "info:compute": "middle",
+    }
+
 
     def __init__(
         self,
@@ -137,4 +144,4 @@ def get_test_params(cls, parameter_set="default"):
             "n_iter": 100,
         }
         params.append(more_params)
-        return params
+        return params
diff --git a/src/hyperactive/opt/gfo/_powells_method.py b/src/hyperactive/opt/gfo/_powells_method.py
@@ -71,7 +71,14 @@ class PowellsMethod(_BaseGFOadapter):
 
     Best parameters can also be accessed via:
     >>> best_params = optimizer.best_params_
- """
+    """
+    _tags = {
+        "info:name": "Powell’s Method",
+        "info:local_vs_global": "local",
+        "info:explore_vs_exploit": "exploit",
+        "info:compute": "low",
+    }
+
 
     def __init__(
         self,
@@ -132,4 +139,4 @@ def get_test_params(cls, parameter_set="default"):
             "n_iter": 100,
         }
         params.append(more_params)
-        return params
+        return params
diff --git a/src/hyperactive/opt/gfo/_random_restart_hill_climbing.py b/src/hyperactive/opt/gfo/_random_restart_hill_climbing.py
@@ -66,7 +66,14 @@ class RandomRestartHillClimbing(_BaseGFOadapter):
 
     Best parameters can also be accessed via:
     >>> best_params = optimizer.best_params_
- """
+    """
+    _tags = {
+        "info:name": "Random Restart Hill Climbing",
+        "info:local_vs_global": "local",
+        "info:explore_vs_exploit": "mixed",
+        "info:compute": "middle",
+    }
+
 
     def __init__(
         self,
@@ -133,4 +140,4 @@ def get_test_params(cls, parameter_set="default"):
             "n_iter": 100,
         }
         params.append(more_params)
-        return params
+        return params
diff --git a/src/hyperactive/opt/gfo/_random_search.py b/src/hyperactive/opt/gfo/_random_search.py
@@ -63,7 +63,14 @@ class RandomSearch(_BaseGFOadapter):
 
     Best parameters can also be accessed via:
     >>> best_params = optimizer.best_params_
- """
+    """
+    _tags = {
+        "info:name": "Random Search",
+        "info:local_vs_global": "global",
+        "info:explore_vs_exploit": "explore",
+        "info:compute": "low",
+    }
+
 
     def __init__(
         self,
@@ -119,4 +126,4 @@ def get_test_params(cls, parameter_set="default"):
             "n_iter": 100,
         }
         params.append(more_params)
-        return params
+        return params
diff --git a/src/hyperactive/opt/gfo/_simulated_annealing.py b/src/hyperactive/opt/gfo/_simulated_annealing.py
@@ -75,7 +75,14 @@ class SimulatedAnnealing(_BaseGFOadapter):
 
     Best parameters can also be accessed via:
     >>> best_params = optimizer.best_params_
- """
+    """
+    _tags = {
+        "info:name": "Simulated Annealing",
+        "info:local_vs_global": "global",
+        "info:explore_vs_exploit": "explore",
+        "info:compute": "middle",
+    }
+
 
     def __init__(
         self,
@@ -145,4 +152,4 @@ def get_test_params(cls, parameter_set="default"):
             "n_iter": 100,
         }
         params.append(more_params)
-        return params
+        return params
diff --git a/src/hyperactive/opt/gfo/_spiral_optimization.py b/src/hyperactive/opt/gfo/_spiral_optimization.py
diff --git a/src/hyperactive/opt/gfo/_tree_structured_parzen_estimators.py b/src/hyperactive/opt/gfo/_tree_structured_parzen_estimators.py
