Skip to content

Commit

Permalink
Fix README code example (#768)
Browse files Browse the repository at this point in the history
Co-authored-by: Uri Granta <uri.granta@secondmind.ai>
  • Loading branch information
uri-granta and Uri Granta authored Jul 18, 2023
1 parent d92fa07 commit 9e25370
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Trieste (pronounced tree-est) is a Bayesian optimization toolbox built on [Tenso

## Getting started

Here's a quick overview of the main components of a Bayesian optimization loop. For more details, see our [Documentation](https://secondmind-labs.github.io/trieste) where we have multiple [Tutorials](https://secondmind-labs.github.io/trieste/tutorials.html) covering both the basic functionalities of the toolbox, as well as more advanced usage.
Here's a quick overview of the main components of a Bayesian optimization loop. For more details, see our <span style="font-variant:small-caps;">[Documentation](https://secondmind-labs.github.io/trieste)</span> where we have multiple <span style="font-variant:small-caps;">[Tutorials](https://secondmind-labs.github.io/trieste/tutorials.html)</span> covering both the basic functionalities of the toolbox, as well as more advanced usage.

Let's set up a synthetic black-box objective function we wish to minimize, for example, a popular Branin optimization function, and generate some initial data
```python
Expand All @@ -42,7 +42,7 @@ initial_data = observer(initial_query_points)

First step is to create a probabilistic model of the objective function, for example a Gaussian Process model
```python
from trieste.models import build_gpr, GaussianProcessRegression
from trieste.models.gpflow import build_gpr, GaussianProcessRegression

gpflow_model = build_gpr(initial_data, Branin.search_space)
model = GaussianProcessRegression(gpflow_model)
Expand All @@ -59,7 +59,7 @@ Finally, we optimize the acquisition function using our model for a number of st
```python
from trieste.bayesian_optimizer import BayesianOptimizer

bo = BayesianOptimizer(observer, search_space)
bo = BayesianOptimizer(observer, Branin.search_space)
num_steps = 15
result = bo.optimize(num_steps, initial_data, model)
query_point, observation, arg_min_idx = result.try_get_optimal_point()
Expand Down
11 changes: 11 additions & 0 deletions trieste/acquisition/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,17 @@
UpdatablePenalizationFunction,
VectorizedAcquisitionFunctionBuilder,
)
from .rule import (
TURBO,
AcquisitionRule,
AsynchronousGreedy,
AsynchronousOptimization,
BatchHypervolumeSharpeRatioIndicator,
DiscreteThompsonSampling,
EfficientGlobalOptimization,
RandomSampling,
TrustRegion,
)
from .sampler import (
ExactThompsonSampler,
GumbelSampler,
Expand Down
1 change: 1 addition & 0 deletions trieste/objectives/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,4 @@
SingleObjectiveTestProblem,
Trid10,
)
from .utils import mk_multi_observer, mk_observer

0 comments on commit 9e25370

Please sign in to comment.