add module exception (#506)

* feat: exceptions

* fix: rename exceptions -> exception

* fix tests

* docs: add reference/exception.rst

Author: phi-friday

bayes_opt/acquisition.py

@@ -33,8 +33,12 @@
 from scipy.stats import norm
 from sklearn.gaussian_process import GaussianProcessRegressor
 
+from bayes_opt.exception import (
+    ConstraintNotSupportedError,
+    NoValidPointRegisteredError,
+    TargetSpaceEmptyError,
+)
 from bayes_opt.target_space import TargetSpace
-from bayes_opt.util import ConstraintNotSupportedError, NoValidPointRegisteredError, TargetSpaceEmptyError
 
 if TYPE_CHECKING:
     from bayes_opt.constraint import ConstraintModel

bayes_opt/exception.py

@@ -0,0 +1,31 @@
+"""This module contains custom exceptions for Bayesian Optimization."""
+
+from __future__ import annotations
+
+__all__ = [
+    "BayesianOptimizationError",
+    "NotUniqueError",
+    "ConstraintNotSupportedError",
+    "NoValidPointRegisteredError",
+    "TargetSpaceEmptyError",
+]
+
+
+class BayesianOptimizationError(Exception):
+    """Base class for exceptions in the Bayesian Optimization."""
+
+
+class NotUniqueError(BayesianOptimizationError):
+    """A point is non-unique."""
+
+
+class ConstraintNotSupportedError(BayesianOptimizationError):
+    """Raised when constrained optimization is not supported."""
+
+
+class NoValidPointRegisteredError(BayesianOptimizationError):
+    """Raised when an acquisition function depends on previous points but none are registered."""
+
+
+class TargetSpaceEmptyError(BayesianOptimizationError):
+    """Raised when the target space is empty."""

bayes_opt/target_space.py

@@ -7,7 +7,8 @@
 import numpy as np
 from colorama import Fore
 
-from bayes_opt.util import NotUniqueError, ensure_rng
+from bayes_opt.exception import NotUniqueError
+from bayes_opt.util import ensure_rng
 
 
 def _hashable(x):

bayes_opt/util.py

@@ -7,21 +7,7 @@
 
 import numpy as np
 
-
-class NotUniqueError(Exception):
-    """A point is non-unique."""
-
-
-class ConstraintNotSupportedError(Exception):
-    """Raised when constrained optimization is not supported."""
-
-
-class NoValidPointRegisteredError(Exception):
-    """Raised when an acquisition function depends on previous points but none are registered."""
-
-
-class TargetSpaceEmptyError(Exception):
-    """Raised when the target space is empty."""
+from bayes_opt.exception import NotUniqueError
 
 
 def load_logs(optimizer, logs):

docsrc/index.rst

@@ -26,6 +26,7 @@
    reference/constraint
    reference/domain_reduction
    reference/target_space
+   reference/exception
    reference/other
 
 .. raw:: html

docsrc/reference/exception.rst

@@ -0,0 +1,5 @@
+:py:mod:`bayes_opt.exception`
+-------------------------------
+
+.. automodule:: bayes_opt.exception
+   :members: 

tests/test_bayesian_optimization.py

@@ -9,9 +9,9 @@
 from bayes_opt import BayesianOptimization, acquisition
 from bayes_opt.acquisition import AcquisitionFunction
 from bayes_opt.event import DEFAULT_EVENTS, Events
+from bayes_opt.exception import NotUniqueError
 from bayes_opt.logger import ScreenLogger
 from bayes_opt.target_space import TargetSpace
-from bayes_opt.util import NotUniqueError
 
 
 def target_func(**kwargs):

tests/test_target_space.py

@@ -4,8 +4,8 @@
 import pytest
 
 from bayes_opt.constraint import ConstraintModel
+from bayes_opt.exception import NotUniqueError
 from bayes_opt.target_space import TargetSpace
-from bayes_opt.util import NotUniqueError
 
 
 def target_func(**kwargs):