Source code for botorch.exceptions.warnings

#!/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.

Botorch Warnings.

[docs]class BotorchWarning(Warning): r"""Base botorch warning.""" pass
[docs]class BadInitialCandidatesWarning(BotorchWarning): r"""Warning issued if set of initial candidates for optimziation is bad.""" pass
[docs]class InputDataWarning(BotorchWarning): r"""Warning raised when input data does not comply with conventions.""" pass
[docs]class CostAwareWarning(BotorchWarning): r"""Warning raised in the context of cost-aware acquisition strategies.""" pass
[docs]class OptimizationWarning(BotorchWarning): r"""Optimization-releated warnings.""" pass
[docs]class SamplingWarning(BotorchWarning): r"""Sampling related warnings.""" pass
[docs]class BotorchTensorDimensionWarning(BotorchWarning): r"""Warning raised when a tensor possibly violates a botorch convention.""" pass
[docs]class UserInputWarning(BotorchWarning): r"""Warning raised when a potential issue is detected with user provided inputs.""" pass
def _get_single_precision_warning(dtype_str: str) -> str: msg = ( f"The model inputs are of type {dtype_str}. It is strongly recommended " "to use double precision in BoTorch, as this improves both " "precision and stability and can help avoid numerical errors. " "See" ) return msg