Source code for botorch.exceptions.errors

#!/usr/bin/env python3
# Copyright (c) Meta Platforms, Inc. and affiliates.
#
# This source code is licensed under the MIT license found in the
# LICENSE file in the root directory of this source tree.

r"""
Botorch Errors.
"""

from typing import Any

import numpy.typing as npt



[docs]
class BotorchError(Exception):
    r"""Base botorch exception."""

    pass




[docs]
class CandidateGenerationError(BotorchError):
    r"""Exception raised during generating candidates."""

    pass




[docs]
class DeprecationError(BotorchError):
    r"""Exception raised due to deprecations"""

    pass




[docs]
class InputDataError(BotorchError):
    r"""Exception raised when input data does not comply with conventions."""

    pass




[docs]
class UnsupportedError(BotorchError):
    r"""Currently unsupported feature."""

    pass




[docs]
class BotorchTensorDimensionError(BotorchError):
    r"""Exception raised when a tensor violates a botorch convention."""

    pass




[docs]
class ModelFittingError(Exception):
    r"""Exception raised when attempts to fit a model terminate unsuccessfully."""

    pass




[docs]
class OptimizationTimeoutError(BotorchError):
    r"""Exception raised when optimization times out."""

    def __init__(
        self, /, *args: Any, current_x: npt.NDArray, runtime: float, **kwargs: Any
    ) -> None:
        r"""
        Args:
            *args: Standard args to `BoTorchError`.
            current_x: A numpy array representing the current iterate.
            runtime: The total runtime in seconds after which the optimization
                timed out.
            **kwargs: Standard kwargs to `BoTorchError`.
        """
        super().__init__(*args, **kwargs)
        self.current_x = current_x
        self.runtime = runtime




[docs]
class OptimizationGradientError(BotorchError, RuntimeError):
    r"""Exception raised when gradient array `gradf` containts NaNs."""

    def __init__(self, /, *args: Any, current_x: npt.NDArray, **kwargs: Any) -> None:
        r"""
        Args:
            *args: Standard args to `BoTorchError`.
            current_x: A numpy array representing the current iterate.
            **kwargs: Standard kwargs to `BoTorchError`.
        """
        super().__init__(*args, **kwargs)
        self.current_x = current_x