Skip to content

Commit aff7514

Browse files
committed
fix user guide
1 parent ede1daf commit aff7514

File tree

8 files changed

+12
-210
lines changed

8 files changed

+12
-210
lines changed

docs/source/user_guide.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,11 @@ algorithm selection, and advanced features for efficient black-box optimization.
99

1010
.. tip::
1111

12-
New to GFO? Start with :ref:`search_spaces` to understand how to define
13-
parameter spaces, then explore :ref:`optimizers` to choose your algorithm.
12+
New to GFO? Follow this path through the guide:
13+
14+
1. :doc:`user_guide/search_spaces` -- learn how to define parameter ranges
15+
2. :doc:`user_guide/objective_functions` -- write functions to optimize
16+
3. :doc:`user_guide/optimizer_selection` -- choose the right algorithm for your problem
1417

1518
----
1619

@@ -191,10 +194,9 @@ GFO provides 22 optimization algorithms organized into four categories:
191194
:link-type: doc
192195
:class-card: sd-border-start sd-border-warning
193196

194-
**4 algorithms** that learn from evaluations
197+
**3 algorithms** that learn from evaluations
195198

196-
Bayesian Optimization, TPE, Forest Optimizer,
197-
and Ensemble methods.
199+
Bayesian Optimization, TPE, and Forest Optimizer.
198200

199201
----
200202

docs/source/user_guide/optimizer_selection.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ where to search next.
4040
.. grid-item-card:: Sequential Model-Based
4141
:class-card: gfo-compact gfo-smbo
4242

43-
Bayesian, TPE, Forest, Ensemble.
43+
Bayesian, TPE, Forest.
4444
Best for expensive objective functions.
4545

4646

docs/source/user_guide/optimizers/index.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,6 @@ Algorithm Overview
8383
* - :doc:`Forest Optimizer <smbo/forest>`
8484
- SMBO
8585
- Large search spaces with discrete parameters
86-
* - :doc:`Ensemble Optimizer <smbo/ensemble>`
87-
- SMBO
88-
- Robust surrogate modeling
8986

9087

9188
Categories
@@ -135,7 +132,7 @@ Categories
135132
Build a surrogate model of the objective function to predict promising
136133
regions. Ideal for expensive evaluations.
137134

138-
**Algorithms:** Bayesian Optimization, TPE, Forest Optimizer, Ensemble
135+
**Algorithms:** Bayesian Optimization, TPE, Forest Optimizer
139136

140137

141138
How to Choose

docs/source/user_guide/optimizers/smbo/bayesian.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -247,4 +247,3 @@ Related Algorithms
247247

248248
- :doc:`tpe` - Density-based, handles categoricals well
249249
- :doc:`forest` - Tree-based, scales better
250-
- :doc:`ensemble` - Combines multiple models

docs/source/user_guide/optimizers/smbo/ensemble.rst

Lines changed: 0 additions & 187 deletions
This file was deleted.

docs/source/user_guide/optimizers/smbo/forest.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,4 +234,3 @@ Related Algorithms
234234

235235
- :doc:`bayesian` - GP-based, better uncertainty
236236
- :doc:`tpe` - Density-based, similar use cases
237-
- :doc:`ensemble` - Combines multiple models

docs/source/user_guide/optimizers/smbo/index.rst

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,6 @@ Overview
2222
- Tree-structured Parzen Estimators using density estimation.
2323
* - :doc:`forest`
2424
- Random Forest or Extra Trees as surrogate model.
25-
* - :doc:`ensemble`
26-
- Combines multiple surrogate models for robustness.
2725

2826

2927
How SMBO Works
@@ -129,10 +127,6 @@ Algorithm Comparison
129127
- Random Forest
130128
- Variance across trees
131129
- Large discrete spaces
132-
* - Ensemble
133-
- Multiple models
134-
- Combined
135-
- Robust predictions
136130

137131

138132
Surrogate Model Comparison
@@ -142,9 +136,9 @@ Surrogate Model Comparison
142136
:alt: SMBO surrogate model comparison
143137
:align: center
144138

145-
The four SMBO approaches use different surrogate models: GP with
146-
uncertainty bands, TPE with good/bad density separation, Forest with
147-
tree ensemble variance, and Ensemble combining multiple model types.
139+
The three SMBO approaches use different surrogate models: GP with
140+
uncertainty bands, TPE with good/bad density separation, and Forest with
141+
tree ensemble variance.
148142

149143

150144
Visualization
@@ -226,4 +220,3 @@ Algorithms
226220
bayesian
227221
tpe
228222
forest
229-
ensemble

docs/source/user_guide/optimizers/smbo/tpe.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,4 +222,3 @@ Related Algorithms
222222

223223
- :doc:`bayesian` - GP-based, better for continuous
224224
- :doc:`forest` - Tree-based surrogate
225-
- :doc:`ensemble` - Combines multiple models

0 commit comments

Comments
 (0)