Skip to content

Commit 17830d4

Browse files
saitcakmakfacebook-github-bot
authored andcommitted
Rename ax/models -> ax/generators (#2856)
Summary: Pull Request resolved: #2856 X-link: facebook/Ax#3807 This is a continuation of renaming of Models to Generators. In a previous diff, the classes have been renamed. This diff updates the directory / module names. Renaming of the attributes is the last remaining step. I will attempt that in a separate diff. Reviewed By: Balandat Differential Revision: D75161069 fbshipit-source-id: ede0b1481dc8bdc178a5e53050a3a38581cc7841
1 parent b252a23 commit 17830d4

File tree

1 file changed

+8
-15
lines changed

1 file changed

+8
-15
lines changed

docs/botorch_and_ax.md

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,22 @@ title: Using BoTorch with Ax
66
[Ax](https://ax.dev) is a platform for sequential experimentation. It relies on
77
BoTorch for implementing Bayesian Optimization algorithms, but provides
88
higher-level APIs that make it easy and convenient to specify problems,
9-
visualize results, and benchmark new algorithms.
10-
It also comes with powerful metadata management, storage of results, and
11-
deployment-related APIs. Ax makes it convenient to use BoTorch in most standard
12-
Bayesian Optimization settings.
9+
visualize results, and benchmark new algorithms. It also comes with powerful
10+
metadata management, storage of results, and deployment-related APIs. Ax makes
11+
it convenient to use BoTorch in most standard Bayesian Optimization settings.
1312
Simply put, BoTorch provides the building blocks for the engine, while Ax makes
1413
it easy to drive the car.
1514

16-
1715
![BoTorch and Ax](assets/botorch_and_ax.svg)
1816

19-
2017
Ax provides a
21-
[`BotorchModel`](https://https://ax.readthedocs.io/en/latest/models.html#ax.models.torch.botorch.BotorchModel)
18+
[`BotorchGenerator`](https://https://ax.readthedocs.io/en/latest/models.html#ax.generators.torch.botorch.BotorchModel)
2219
that is a sensible default for modeling and optimization which can be customized
2320
by specifying and passing in bespoke model constructors, acquisition functions,
24-
and optimization strategies.
25-
This model bridge utilizes a number of built-in transformations, such as
26-
normalizing input spaces and outputs to ensure reasonable fitting of GPs.
27-
See the [Ax Docs](https://ax.dev/docs/models.html#transforms) for more
28-
information.
29-
21+
and optimization strategies. This model bridge utilizes a number of built-in
22+
transformations, such as normalizing input spaces and outputs to ensure
23+
reasonable fitting of GPs. See the
24+
[Ax Docs](https://ax.dev/docs/models.html#transforms) for more information.
3025

3126
## When to use BoTorch through Ax
3227

@@ -46,7 +41,6 @@ management, data storage, etc. See Ax's
4641
[Modular BoTorch tutorial](https://ax.dev/docs/tutorials/modular_botorch/)
4742
tutorial for more on how to do this.
4843

49-
5044
## When not to use Ax
5145

5246
If you're working in a non-standard setting, such as structured feature or
@@ -62,7 +56,6 @@ understand and control every single aspect of your BayesOpt loop - Ax's
6256
simplicity necessarily means that certain powerful BoTorch features will not be
6357
fully exposed to the user.
6458

65-
6659
## Prototyping in BoTorch
6760

6861
The modular design of BoTorch makes it very easy to prototype and debug

0 commit comments

Comments
 (0)