hydra-optuna-sweeper 1.4.0.dev5__tar.gz → 1.4.0.dev7__tar.gz

{hydra_optuna_sweeper-1.4.0.dev5 → hydra_optuna_sweeper-1.4.0.dev7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hydra-optuna-sweeper
-Version: 1.4.0.dev5
+Version: 1.4.0.dev7
 Summary: Hydra Optuna Sweeper plugin
 Home-page: https://github.com/facebookresearch/hydra/
 Author: Toshihiko Yanase, Hiroyuki Vincent Yamazaki
@@ -17,8 +17,7 @@ Classifier: Development Status :: 4 - Beta
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: hydra-core>=1.1.0.dev7
-Requires-Dist: optuna<3.0.0,>=2.10.0
-Requires-Dist: sqlalchemy~=1.3.0
+Requires-Dist: optuna<5.0.0,>=4.9.0
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

{hydra_optuna_sweeper-1.4.0.dev5 → hydra_optuna_sweeper-1.4.0.dev7}/hydra_optuna_sweeper.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hydra-optuna-sweeper
-Version: 1.4.0.dev5
+Version: 1.4.0.dev7
 Summary: Hydra Optuna Sweeper plugin
 Home-page: https://github.com/facebookresearch/hydra/
 Author: Toshihiko Yanase, Hiroyuki Vincent Yamazaki
@@ -17,8 +17,7 @@ Classifier: Development Status :: 4 - Beta
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: hydra-core>=1.1.0.dev7
-Requires-Dist: optuna<3.0.0,>=2.10.0
-Requires-Dist: sqlalchemy~=1.3.0
+Requires-Dist: optuna<5.0.0,>=4.9.0
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

hydra_optuna_sweeper-1.4.0.dev7/hydra_optuna_sweeper.egg-info/requires.txt

@@ -0,0 +1,2 @@
+hydra-core>=1.1.0.dev7
+optuna<5.0.0,>=4.9.0

{hydra_optuna_sweeper-1.4.0.dev5 → hydra_optuna_sweeper-1.4.0.dev7}/hydra_plugins/hydra_optuna_sweeper/__init__.py

@@ -1,3 +1,3 @@
 # Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved
 
-__version__ = "1.4.0.dev5"
+__version__ = "1.4.0.dev7"

{hydra_optuna_sweeper-1.4.0.dev5 → hydra_optuna_sweeper-1.4.0.dev7}/hydra_plugins/hydra_optuna_sweeper/_impl.py

@@ -35,11 +35,8 @@ from optuna.distributions import (
     BaseDistribution,
     CategoricalChoiceType,
     CategoricalDistribution,
-    DiscreteUniformDistribution,
-    IntLogUniformDistribution,
-    IntUniformDistribution,
-    LogUniformDistribution,
-    UniformDistribution,
+    FloatDistribution,
+    IntDistribution,
 )
 from optuna.trial import Trial
 
@@ -62,17 +59,17 @@ def create_optuna_distribution_from_config(
         assert param.low is not None
         assert param.high is not None
         if param.log:
-            return IntLogUniformDistribution(int(param.low), int(param.high))
+            return IntDistribution(int(param.low), int(param.high), log=True)
         step = int(param.step) if param.step is not None else 1
-        return IntUniformDistribution(int(param.low), int(param.high), step=step)
+        return IntDistribution(int(param.low), int(param.high), step=step)
     if param.type == DistributionType.float:
         assert param.low is not None
         assert param.high is not None
         if param.log:
-            return LogUniformDistribution(param.low, param.high)
+            return FloatDistribution(param.low, param.high, log=True)
         if param.step is not None:
-            return DiscreteUniformDistribution(param.low, param.high, param.step)
-        return UniformDistribution(param.low, param.high)
+            return FloatDistribution(param.low, param.high, step=param.step)
+        return FloatDistribution(param.low, param.high)
     raise NotImplementedError(f"{param.type} is not supported by Optuna sweeper.")
 
 
@@ -85,9 +82,9 @@ def create_optuna_distribution_from_override(override: Override) -> Any:
     if override.is_choice_sweep():
         assert isinstance(value, ChoiceSweep)
         for x in override.sweep_iterator(transformer=Transformer.encode):
-            assert isinstance(
-                x, (str, int, float, bool, type(None))
-            ), f"A choice sweep expects str, int, float, bool, or None type. Got {type(x)}."
+            assert isinstance(x, (str, int, float, bool, type(None))), (
+                f"A choice sweep expects str, int, float, bool, or None type. Got {type(x)}."
+            )
             choices.append(x)
         return CategoricalDistribution(choices)
 
@@ -97,9 +94,9 @@ def create_optuna_distribution_from_override(override: Override) -> Any:
         assert value.stop is not None
         if value.shuffle:
             for x in override.sweep_iterator(transformer=Transformer.encode):
-                assert isinstance(
-                    x, (str, int, float, bool, type(None))
-                ), f"A choice sweep expects str, int, float, bool, or None type. Got {type(x)}."
+                assert isinstance(x, (str, int, float, bool, type(None))), (
+                    f"A choice sweep expects str, int, float, bool, or None type. Got {type(x)}."
+                )
                 choices.append(x)
             return CategoricalDistribution(choices)
         if (
@@ -107,12 +104,12 @@ def create_optuna_distribution_from_override(override: Override) -> Any:
             or isinstance(value.stop, float)
             or isinstance(value.step, float)
         ):
-            return DiscreteUniformDistribution(
-                float(value.start), float(value.stop), float(value.step)
+            return FloatDistribution(
+                float(value.start),
+                float(value.stop),
+                step=float(value.step) if value.step else None,
             )
-        return IntUniformDistribution(
-            int(value.start), int(value.stop), step=int(value.step)
-        )
+        return IntDistribution(int(value.start), int(value.stop), step=int(value.step))
 
     if override.is_interval_sweep():
         assert isinstance(value, IntervalSweep)
@@ -120,12 +117,12 @@ def create_optuna_distribution_from_override(override: Override) -> Any:
         assert value.end is not None
         if "log" in value.tags:
             if isinstance(value.start, int) and isinstance(value.end, int):
-                return IntLogUniformDistribution(int(value.start), int(value.end))
-            return LogUniformDistribution(value.start, value.end)
+                return IntDistribution(int(value.start), int(value.end), log=True)
+            return FloatDistribution(value.start, value.end, log=True)
         else:
             if isinstance(value.start, int) and isinstance(value.end, int):
-                return IntUniformDistribution(value.start, value.end)
-            return UniformDistribution(value.start, value.end)
+                return IntDistribution(value.start, value.end)
+            return FloatDistribution(value.start, value.end)
 
     raise NotImplementedError(f"{override} is not supported by Optuna sweeper.")
 
@@ -275,15 +272,18 @@ class OptunaSweeperImpl(Sweeper):
     def _to_grid_sampler_choices(self, distribution: BaseDistribution) -> Any:
         if isinstance(distribution, CategoricalDistribution):
             return distribution.choices
-        elif isinstance(distribution, IntUniformDistribution):
-            assert (
-                distribution.step is not None
-            ), "`step` of IntUniformDistribution must be a positive integer."
+        elif isinstance(distribution, IntDistribution):
+            assert distribution.step is not None, (
+                "`step` of IntDistribution must be a positive integer."
+            )
             n_items = (distribution.high - distribution.low) // distribution.step
             return [distribution.low + i * distribution.step for i in range(n_items)]
-        elif isinstance(distribution, DiscreteUniformDistribution):
-            n_items = int((distribution.high - distribution.low) // distribution.q)
-            return [distribution.low + i * distribution.q for i in range(n_items)]
+        elif (
+            isinstance(distribution, FloatDistribution)
+            and distribution.step is not None
+        ):
+            n_items = int((distribution.high - distribution.low) // distribution.step)
+            return [distribution.low + i * distribution.step for i in range(n_items)]
         else:
             raise ValueError("GridSampler only supports discrete distributions.")
 

{hydra_optuna_sweeper-1.4.0.dev5 → hydra_optuna_sweeper-1.4.0.dev7}/hydra_plugins/hydra_optuna_sweeper/config.py

@@ -1,12 +1,20 @@
 # Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved
 from dataclasses import dataclass, field
 from enum import Enum
-from typing import Any, Dict, List, Optional
+from typing import Any, Dict, List, NoReturn, Optional
 
 from hydra.core.config_store import ConfigStore
 from omegaconf import MISSING
 
 
+def raise_motpe_removed(*args: Any, **kwargs: Any) -> NoReturn:
+    raise ValueError(
+        "The 'motpe' sampler was removed in Optuna 4.0. "
+        "Use 'hydra/sweeper/sampler=tpe' instead. "
+        "TPESampler now handles multi-objective optimization."
+    )
+
+
 class DistributionType(Enum):
     int = 1
     float = 2
@@ -43,14 +51,14 @@ class TPESamplerConfig(SamplerConfig):
     _target_: str = "optuna.samplers.TPESampler"
     seed: Optional[int] = None
 
-    consider_prior: bool = True
-    prior_weight: float = 1.0
-    consider_magic_clip: bool = True
-    consider_endpoints: bool = False
+    consider_prior: Optional[bool] = None
+    prior_weight: Optional[float] = None
+    consider_magic_clip: Optional[bool] = None
+    consider_endpoints: Optional[bool] = None
     n_startup_trials: int = 10
     n_ei_candidates: int = 24
     multivariate: bool = False
-    warn_independent_sampling: bool = True
+    warn_independent_sampling: Optional[bool] = None
 
 
 @dataclass
@@ -101,19 +109,39 @@ class NSGAIISamplerConfig(SamplerConfig):
 
 @dataclass
 class MOTPESamplerConfig(SamplerConfig):
+    _target_: str = "hydra_plugins.hydra_optuna_sweeper.config.raise_motpe_removed"
+
+
+@dataclass
+class GPSamplerConfig(SamplerConfig):
     """
-    https://optuna.readthedocs.io/en/stable/reference/generated/optuna.samplers.MOTPESampler.html
+    https://optuna.readthedocs.io/en/stable/reference/samplers/generated/optuna.samplers.GPSampler.html
     """
 
-    _target_: str = "optuna.samplers.MOTPESampler"
+    _target_: str = "optuna.samplers.GPSampler"
     seed: Optional[int] = None
 
-    consider_prior: bool = True
-    prior_weight: float = 1.0
-    consider_magic_clip: bool = True
-    consider_endpoints: bool = False
+    independent_sampler: Optional[Any] = None
     n_startup_trials: int = 10
-    n_ehvi_candidates: int = 24
+    deterministic_objective: bool = False
+    constraints_func: Optional[Any] = None
+    warn_independent_sampling: bool = True
+
+
+@dataclass
+class QMCSamplerConfig(SamplerConfig):
+    """
+    https://optuna.readthedocs.io/en/stable/reference/samplers/generated/optuna.samplers.QMCSampler.html
+    """
+
+    _target_: str = "optuna.samplers.QMCSampler"
+    seed: Optional[int] = None
+
+    qmc_type: str = "sobol"
+    scramble: bool = False
+    independent_sampler: Optional[Any] = None
+    warn_asynchronous_seeding: bool = True
+    warn_independent_sampling: bool = True
 
 
 @dataclass
@@ -234,3 +262,17 @@ ConfigStore.instance().store(
     node=GridSamplerConfig,
     provider="optuna_sweeper",
 )
+
+ConfigStore.instance().store(
+    group="hydra/sweeper/sampler",
+    name="gp",
+    node=GPSamplerConfig,
+    provider="optuna_sweeper",
+)
+
+ConfigStore.instance().store(
+    group="hydra/sweeper/sampler",
+    name="qmc",
+    node=QMCSamplerConfig,
+    provider="optuna_sweeper",
+)

{hydra_optuna_sweeper-1.4.0.dev5 → hydra_optuna_sweeper-1.4.0.dev7}/hydra_plugins/hydra_optuna_sweeper/optuna_sweeper.py

@@ -3,17 +3,16 @@ from typing import Any, List, Optional
 
 from hydra.plugins.sweeper import Sweeper
 from hydra.types import HydraContext, TaskFunction
+from hydra.utils import instantiate
 from omegaconf import DictConfig
 
-from .config import SamplerConfig
-
 
 class OptunaSweeper(Sweeper):
     """Class to interface with Optuna"""
 
     def __init__(
         self,
-        sampler: SamplerConfig,
+        sampler: Any,
         direction: Any,
         storage: Optional[Any],
         study_name: Optional[str],
@@ -26,6 +25,15 @@ class OptunaSweeper(Sweeper):
     ) -> None:
         from ._impl import OptunaSweeperImpl
 
+        sampler = instantiate(
+            sampler,
+            _skip_instantiate_full_deepcopy_=True,
+            _target_whitelist_=(
+                "hydra_plugins.hydra_optuna_sweeper.*",
+                "optuna.samplers.*",
+            ),
+        )
+
         self.sweeper = OptunaSweeperImpl(
             sampler,
             direction,

{hydra_optuna_sweeper-1.4.0.dev5 → hydra_optuna_sweeper-1.4.0.dev7}/setup.py

@@ -29,8 +29,7 @@ setup(
     python_requires=">=3.10",
     install_requires=[
         "hydra-core>=1.1.0.dev7",
-        "optuna>=2.10.0,<3.0.0",
-        "sqlalchemy~=1.3.0",  # TODO: Unpin when upgrading to optuna v3.0
+        "optuna>=4.9.0,<5.0.0",
     ],
     include_package_data=True,
 )

{hydra_optuna_sweeper-1.4.0.dev5 → hydra_optuna_sweeper-1.4.0.dev7}/tests/test_optuna_sweeper_plugin.py

@@ -8,6 +8,7 @@ from typing import Any, List, Optional
 import optuna
 from hydra.core.override_parser.overrides_parser import OverridesParser
 from hydra.core.plugins import Plugins
+from hydra.errors import InstantiationException
 from hydra.plugins.sweeper import Sweeper
 from hydra.test_utils.test_utils import (
     TSweepRunner,
@@ -15,22 +16,20 @@ from hydra.test_utils.test_utils import (
     run_process,
     run_python_script,
 )
+from hydra.utils import instantiate
 from omegaconf import DictConfig, OmegaConf
 from optuna.distributions import (
     BaseDistribution,
     CategoricalDistribution,
-    DiscreteUniformDistribution,
-    IntLogUniformDistribution,
-    IntUniformDistribution,
-    LogUniformDistribution,
-    UniformDistribution,
+    FloatDistribution,
+    IntDistribution,
 )
 from optuna.samplers import RandomSampler
-from pytest import mark, warns
+from pytest import mark, raises, warns
 
 from hydra_plugins.hydra_optuna_sweeper import _impl
 from hydra_plugins.hydra_optuna_sweeper._impl import OptunaSweeperImpl
-from hydra_plugins.hydra_optuna_sweeper.config import Direction
+from hydra_plugins.hydra_optuna_sweeper.config import Direction, MOTPESamplerConfig
 from hydra_plugins.hydra_optuna_sweeper.optuna_sweeper import OptunaSweeper
 
 chdir_plugin_root()
@@ -68,24 +67,24 @@ def check_distribution(expected: BaseDistribution, actual: BaseDistribution) ->
             {"type": "categorical", "choices": [1, 2, 3]},
             CategoricalDistribution([1, 2, 3]),
         ),
-        ({"type": "int", "low": 0, "high": 10}, IntUniformDistribution(0, 10)),
+        ({"type": "int", "low": 0, "high": 10}, IntDistribution(0, 10)),
         (
             {"type": "int", "low": 0, "high": 10, "step": 2},
-            IntUniformDistribution(0, 10, step=2),
+            IntDistribution(0, 10, step=2),
         ),
-        ({"type": "int", "low": 0, "high": 5}, IntUniformDistribution(0, 5)),
+        ({"type": "int", "low": 0, "high": 5}, IntDistribution(0, 5)),
         (
             {"type": "int", "low": 1, "high": 100, "log": True},
-            IntLogUniformDistribution(1, 100),
+            IntDistribution(1, 100, log=True),
         ),
-        ({"type": "float", "low": 0, "high": 1}, UniformDistribution(0, 1)),
+        ({"type": "float", "low": 0, "high": 1}, FloatDistribution(0, 1)),
         (
             {"type": "float", "low": 0, "high": 10, "step": 2},
-            DiscreteUniformDistribution(0, 10, 2),
+            FloatDistribution(0, 10, step=2),
         ),
         (
             {"type": "float", "low": 1, "high": 100, "log": True},
-            LogUniformDistribution(1, 100),
+            FloatDistribution(1, 100, log=True),
         ),
     ],
 )
@@ -101,12 +100,12 @@ def test_create_optuna_distribution_from_config(input: Any, expected: Any) -> No
         ("key=choice(true, false)", CategoricalDistribution([True, False])),
         ("key=choice('hello', 'world')", CategoricalDistribution(["hello", "world"])),
         ("key=shuffle(range(1,3))", CategoricalDistribution((1, 2))),
-        ("key=range(1,3)", IntUniformDistribution(1, 3)),
-        ("key=interval(1, 5)", UniformDistribution(1, 5)),
-        ("key=int(interval(1, 5))", IntUniformDistribution(1, 5)),
-        ("key=tag(log, interval(1, 5))", LogUniformDistribution(1, 5)),
-        ("key=tag(log, int(interval(1, 5)))", IntLogUniformDistribution(1, 5)),
-        ("key=range(0.5, 5.5, step=1)", DiscreteUniformDistribution(0.5, 5.5, 1)),
+        ("key=range(1,3)", IntDistribution(1, 3)),
+        ("key=interval(1, 5)", FloatDistribution(1, 5)),
+        ("key=int(interval(1, 5))", IntDistribution(1, 5)),
+        ("key=tag(log, interval(1, 5))", FloatDistribution(1, 5, log=True)),
+        ("key=tag(log, int(interval(1, 5)))", IntDistribution(1, 5, log=True)),
+        ("key=range(0.5, 5.5, step=1)", FloatDistribution(0.5, 5.5, step=1)),
     ],
 )
 def test_create_optuna_distribution_from_override(input: Any, expected: Any) -> None:
@@ -130,7 +129,7 @@ def test_create_optuna_distribution_from_override(input: Any, expected: Any) ->
             (
                 {
                     "key1": CategoricalDistribution([1, 2]),
-                    "key3": IntUniformDistribution(1, 3),
+                    "key3": IntDistribution(1, 3),
                 },
                 {"key2": "5"},
                 [],
@@ -383,23 +382,32 @@ def test_failure_rate(max_failure_rate: float, tmpdir: Path) -> None:
         assert error_string not in err
 
 
-def test_example_with_deprecated_search_space(
+def test_motpe_sampler_removed() -> None:
+    with raises(
+        InstantiationException,
+        match="The 'motpe' sampler was removed in Optuna 4.0",
+    ):
+        instantiate(
+            OmegaConf.structured(MOTPESamplerConfig),
+            _target_whitelist_="hydra_plugins.hydra_optuna_sweeper.config.raise_motpe_removed",
+        )
+
+
+def test_example_with_removed_motpe(
     tmpdir: Path,
 ) -> None:
     cmd = [
-        "-W ignore::UserWarning",
-        "example/sphere.py",
+        sys.executable,
+        "example/multi-objective.py",
         "--multirun",
         "--config-dir=tests/conf",
-        "--config-name=test_deprecated_search_space",
+        "--config-name=test_motpe",
         "hydra.sweep.dir=" + str(tmpdir),
         "hydra.job.chdir=True",
         "hydra.sweeper.n_trials=20",
         "hydra.sweeper.n_jobs=1",
     ]
 
-    run_optuna_script(cmd)
-    returns = OmegaConf.load(f"{tmpdir}/optimization_results.yaml")
-    assert isinstance(returns, DictConfig)
-    assert returns.name == "optuna"
-    assert abs(returns["best_params"]["x"]) <= 5.5
+    out, err = run_process(cmd, print_error=False, raise_exception=False)
+    assert "motpe" in err
+    assert "sampler was removed in Optuna 4.0" in err

hydra_optuna_sweeper-1.4.0.dev5/hydra_optuna_sweeper.egg-info/requires.txt

@@ -1,3 +0,0 @@
-hydra-core>=1.1.0.dev7
-optuna<3.0.0,>=2.10.0
-sqlalchemy~=1.3.0