Skip to content

Commit

Permalink
Update HOGP docstring (#2709)
Browse files Browse the repository at this point in the history
Summary:
Came across this error in the context of #2695, added a bit more explanation as well.

Pull Request resolved: #2709

Reviewed By: saitcakmak

Differential Revision: D68807233

Pulled By: Balandat

fbshipit-source-id: f3c3bd6373592465171d2f938faa8dcc30e32a3f
  • Loading branch information
Balandat authored and facebook-github-bot committed Jan 29, 2025
1 parent aeda83a commit a65eb07
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions botorch/models/higher_order_gp.py
Original file line number Diff line number Diff line change
Expand Up @@ -163,11 +163,14 @@ class HigherOrderGP(BatchedMultiOutputGPyTorchModel, ExactGP, FantasizeMixin):
NOTE: This model requires the use of specialized Kronecker solves in
linear operator, which are disabled by default in BoTorch. These are enabled
by default in the `HigherOrderGP.posterior` call. However, they need to be
manually enabled by the user during model fitting.
manually enabled by the user during model fitting. Note also that we're using
`fit_gpytorch_mll_torch()` here instead of `fit_gpytorch_mll()` since the
approximate computations result in a non-smooth MLL that the default
L-BFGS-B optimizer invoked by `fit_gpytorch_mll()` does not handle well.
Example:
>>> from linear_operator.settings import _fast_solves
>>> model = SingleTaskGP(train_X, train_Y)
>>> model = HigherOrderGP(train_X, train_Y)
>>> mll = ExactMarginalLogLikelihood(model.likelihood, model)
>>> with _fast_solves(True):
>>> fit_gpytorch_mll_torch(mll)
Expand Down

0 comments on commit a65eb07

Please sign in to comment.