Export NumericsWarning and UserInputWarning from botorch.exceptions

[chrisyeh96]

Motivation

Using botorch.acquisition.ExpectedImprovement (instead of LogEI) now triggers a botorch.exceptions.warnings.NumericsWarning. I'd like to be able to suppress this warning in cases that I actually intend to use EI instead of LogEI, such as when I am comparing the two.

I'd like to be able to write the following:

import warnings

import botorch

with warnings.catch_warnings():
    warnings.filterwarnings('ignore', category=botorch.exceptions.NumericsWarning)
    acqf = botorch.acquisition.ExpectedImprovement(...)

However, botorch.exceptions does not export NumericsWarning as a symbol, so code editors (e.g., Visual Studio Code) complain that the symbol botorch.exceptions.NumericsWarning is not found. This pull request updates botorch/exceptions/__init__.py to export NumericsWarning and UserInputWarning, the only two warnings from botorch/exceptions/warnings.py that were previously unexported.

Have you read the Contributing Guidelines on pull requests?

Yes.

Test Plan

N/A

Related PRs

I believe it may have been a simple oversight of commit 6892be9 (from pull request #2429) to add NumericsWarning to the list of exported symbols in botorch/exceptions/__init__.py.

[chrisyeh96]

Tagging @SebastianAment

[Balandat]

However, botorch.exceptions does not export NumericsWarning as a symbol

As an alternative, could you instead just write the following?

from botorch.exceptions.warnings import NumericsWarning

with warnings.catch_warnings():
    warnings.filterwarnings('ignore', category=botorch.exceptions.NumericsWarning)

Not saying we shouldn't land this PR (seems fine), just curious if the above would work.

[chrisyeh96]

@Balandat: Yeah, what you suggested works. I just found it odd that all but two of the warnings could be used via botorch.exceptions.***Warning, whereas only NumericsWarning and UserInputWarning could only be imported as botorch.exceptions.warnings.***Warning

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.99%. Comparing base (290c0ba) to head (1619848).
Report is 3 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2761   +/-   ##
=======================================
  Coverage   99.99%   99.99%           
=======================================
  Files         203      203           
  Lines       18705    18705           
=======================================
  Hits        18704    18704           
  Misses          1        1           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[facebook-github-bot]

@SebastianAment has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

[facebook-github-bot]

@SebastianAment merged this pull request in bba835c.