Skip to content

Commit

Permalink
Improved docstring for surrogate options
Browse files Browse the repository at this point in the history
  • Loading branch information
kstone40 committed Aug 9, 2024
1 parent 7654ff0 commit d4a53a7
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions obsidian/surrogates/botorch.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,22 @@ class SurrogateBoTorch(SurrogateModel):
BoTorch GP model, subclass of the obsidian SurrogateModel
Attributes:
model_type (str): The type of model to be used.
Defaults to ``'GP'``. Options are as follows:
- ``'GP'``: Gaussian Process with default settings (Matern Kernel, Gamma covariance priors)
- ``'MixedGP'``: GP with mixed parameter types (continuous, categorical). Will be re-selected
by default if 'GP' is selected and input space is mixed.
- ``'DKL'``: GP with a NN feature-extractor (deep kernel learning)
- ``'GPflat'``: GP without priors. May result in optimization instability, but removes bias
for special situations.
- ``'GPprior'``: GP with custom priors on the mean, likelihood, and covariance
- ``'MTGP'``: Multi-task GP for multi-output optimization. Will be re-selected by default
if 'GP' is selected and the input space contains Task parameters.
- ``'DNN'``: Dropout neural network. Uses MC sampling to mask neurons during training and
to estimate uncertainty.
device (str): The device on which the model is run.
hps (dict): Optional surrogate function hyperparameters.
mll (ExactMarginalLogLikelihood): The marginal log likelihood of the model.
Expand Down

0 comments on commit d4a53a7

Please sign in to comment.