Skip to content

Commit 77252ba

Browse files
authored
Add SMBO docs (#1223)
* Add SMBO docs * Fix
1 parent 37cd90c commit 77252ba

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

docs/3_getting_started.md

+15-4
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# Getting Started
33

44
SMAC needs four core components (configuration space, target function, scenario and a facade) to run an
5-
optimization process, all of which are explained on this page.
5+
optimization process called Sequential Model Based Optimization (SMBO), all of which are explained on this page.
66

77
They interact in the following way:
88

@@ -93,8 +93,8 @@ scenario = Scenario(
9393
!!! warn
9494
By default Facades will try to warmstart on preexisting logs. This behavior can be specified using the `overwrite` parameter.
9595

96-
A [facade][smac.facade.abstract_facade] is the entry point to SMAC, which constructs a default optimization
97-
pipeline for you. SMAC offers various facades, which satisfy many common use cases and are crucial to
96+
A [facade][smac.facade.abstract_facade] is the entry point to SMAC, which constructs a Sequential Model Based Optimization (`SMBO`) object for you.
97+
SMAC offers various facades, which satisfy many common use cases and are crucial to
9898
achieving peak performance. The idea behind the facades is to provide a simple interface to all of SMAC's components,
9999
which is easy to use and understand and without the need of deep diving into the material. However, experts are
100100
invited to change the components to their specific hyperparameter optimization needs. The following
@@ -139,4 +139,15 @@ smac = MFFacade(scenario=scenario, target_function=train)
139139
smac = ACFacade(scenario=scenario, target_function=train)
140140
smac = RFacade(scenario=scenario, target_function=train)
141141
smac = HBFacade(scenario=scenario, target_function=train)
142-
```
142+
```
143+
144+
## SMBO
145+
Each `Facade` creates a [Sequential Model Based Optimization (SMBO)][smac.main.smbo] object for you. In addition to starting the optimization with
146+
```python
147+
incumbent = smbo.optimize()
148+
```
149+
it supports access to e.g. the runhistory with
150+
````
151+
runhistory = smbo.runhistory()
152+
````
153+
For more information check out the [API][smac.main.smbo].

0 commit comments

Comments
 (0)