Listing supported searchers

syne-tune · Jan 22, 2023 · f26a2c0 · f26a2c0
1 parent 5d20d51
commit f26a2c0
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 7 deletions.
diff --git a/syne_tune/optimizer/schedulers/fifo.py b/syne_tune/optimizer/schedulers/fifo.py
@@ -70,8 +70,11 @@ class FIFOScheduler(TrialSchedulerWithSearcher):
     :param config_space: Configuration space for evaluation function
     :type config_space: dict
     :param searcher: Searcher for ``get_config`` decisions. String values
-        are passed to ``searcher_factory`` along with ``search_options`` and
-        extra information. Defaults to "random" (i.e., random search)
+        are passed to
+        :func:`~syne_tune.optimizer.schedulers.searchers.searcher_factory` along
+        with ``search_options`` and extra information. Supported values:
+        :const:`~syne_tune.optimizer.schedulers.searchers.searcher_factory.SUPPORTED_SEARCHERS_FIFO`.
+        Defaults to "random" (i.e., random search)
     :type searcher: str or
         :class:`~syne_tune.optimizer.schedulers.searchers.BaseSearcher`
     :param search_options: If searcher is ``str``, these arguments are

diff --git a/syne_tune/optimizer/schedulers/hyperband.py b/syne_tune/optimizer/schedulers/hyperband.py
@@ -226,6 +226,14 @@ class HyperbandScheduler(FIFOScheduler, MultiFidelitySchedulerMixin):
     Additional arguments on top of parent class
     :class:`~syne_tune.optimizer.schedulers.FIFOScheduler`:
 
+    :param searcher: Searcher for ``get_config`` decisions. String values
+        are passed to
+        :func:`~syne_tune.optimizer.schedulers.searchers.searcher_factory` along
+        with ``search_options`` and extra information. Supported values:
+        :const:`~syne_tune.optimizer.schedulers.searchers.searcher_factory.SUPPORTED_SEARCHERS_HYPERBAND`.
+        Defaults to "random" (i.e., random search)
+    :type searcher: str or
+        :class:`~syne_tune.optimizer.schedulers.searchers.BaseSearcher`
     :param resource_attr: Name of resource attribute in results obtained
         via ``on_trial_result``, defaults to "epoch"
     :type resource_attr: str, optional

diff --git a/syne_tune/optimizer/schedulers/searchers/searcher_factory.py b/syne_tune/optimizer/schedulers/searchers/searcher_factory.py
@@ -29,6 +29,29 @@
 logger = logging.getLogger(__name__)
 
 
+SUPPORTED_SEARCHERS_FIFO = {
+    "random",
+    "grid",
+    "kde",
+    "bore",
+    "botorch",
+    "bayesopt",
+    "bayesopt_constrained",
+    "bayesopt_cost",
+}
+
+
+SUPPORTED_SEARCHERS_HYPERBAND = {
+    "random",
+    "grid",
+    "kde",
+    "bore",
+    "bayesopt",
+    "bayesopt_cost",
+    "hypertune",
+}
+
+
 _OUR_MULTIFIDELITY_SCHEDULERS = {
     "hyperband_stopping",
     "hyperband_promotion",

diff --git a/syne_tune/optimizer/schedulers/synchronous/dehb.py b/syne_tune/optimizer/schedulers/synchronous/dehb.py
@@ -157,8 +157,10 @@ class DifferentialEvolutionHyperbandScheduler(SynchronousHyperbandCommon):
     :param metric: Name of metric to optimize, key in result's obtained via
         :meth:`on_trial_result`
     :type metric: str
-    :param searcher: Selects searcher. Passed to
-        :func:`~syne_tune.optimizer.schedulers.searchers.searcher_factory`..
+    :param searcher: Searcher for ``get_config`` decisions. Passed to
+        :func:`~syne_tune.optimizer.schedulers.searchers.searcher_factory` along
+        with ``search_options`` and extra information. Supported values:
+        :const:`~syne_tune.optimizer.schedulers.searchers.searcher_factory.SUPPORTED_SEARCHERS_HYPERBAND`.
         If ``searcher == "random_encoded"`` (default), the encoded configs are
         sampled directly, each entry independently from U([0, 1]).
         This distribution has higher entropy than for "random" if

diff --git a/syne_tune/optimizer/schedulers/synchronous/hyperband.py b/syne_tune/optimizer/schedulers/synchronous/hyperband.py
@@ -168,9 +168,11 @@ class SynchronousHyperbandScheduler(SynchronousHyperbandCommon):
     :param metric: Name of metric to optimize, key in result's obtained via
         :meth:`on_trial_result`
     :type metric: str
-    :param searcher: Selects searcher. Passed to
-        :func:`~syne_tune.optimizer.schedulers.searchers.searcher_factory`.
-        Defaults to "random"
+    :param searcher: Searcher for ``get_config`` decisions. Passed to
+        :func:`~syne_tune.optimizer.schedulers.searchers.searcher_factory` along
+        with ``search_options`` and extra information. Supported values:
+        :const:`~syne_tune.optimizer.schedulers.searchers.searcher_factory.SUPPORTED_SEARCHERS_HYPERBAND`.
+        Defaults to "random" (i.e., random search)
     :type searcher: str, optional
     :param search_options: Passed to
         :func:`~syne_tune.optimizer.schedulers.searchers.searcher_factory`.