Skip to content

Commit 9b8bafb

Browse files
committed
Fix typos in readme and hyperling to exploration vs exploitation
1 parent 51d3b3b commit 9b8bafb

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ suited for optimization of high cost functions, situations where the balance
1616
between exploration and exploitation is important.
1717

1818
## Important notice
19-
With the release of version 1.0.0 a number of breaking API changes were introduced. I understand this can be a headache for some, but these were necessary changes that needed to be done and ultimately made the package better. If you have used this package in the past I suggest you take the basic and advanced tours (found in the examples folder) in order to familiarize yourself with the new API.
19+
With the release of version 1.0.0 a number of API breaking changes were introduced. I understand this can be a headache for some, but these were necessary changes that needed to be done and ultimately made the package better. If you have used this package in the past I suggest you take the basic and advanced tours (found in the examples folder) in order to familiarize yourself with the new API.
2020

2121
## Quick Start
2222
See below for a quick tour over the basics of the Bayesian Optimization package. More detailed information, other advanced features, and tips on usage/implementation can be found in the [examples](https://github.com/fmfn/BayesianOptimization/tree/master/examples) folder. I suggest that you:
@@ -29,7 +29,7 @@ to learn how to make the package more flexible, how to deal with categorical par
2929
- Check out this
3030
[notebook](https://github.com/fmfn/BayesianOptimization/blob/master/examples/visualization.ipynb)
3131
with a step by step visualization of how this method works.
32-
- Explore this [notebook](https://github.com/fmfn/BayesianOptimization/blob/master/examples/exploitation%20vs%20exploration.ipynb)
32+
- Explore this [notebook](https://github.com/fmfn/BayesianOptimization/blob/master/examples/exploitation_vs_exploration.ipynb)
3333
exemplifying the balance between exploration and exploitation and how to
3434
control it.
3535
- Go over this [script](https://github.com/fmfn/BayesianOptimization/blob/master/examples/sklearn_example.py)
@@ -93,7 +93,7 @@ optimizer = BayesianOptimization(
9393
)
9494
```
9595

96-
The BayesianOptimization object will work all of the box without much tuning needed. The main method you should be aware of is `maximize`, which does exactly what you think it does.
96+
The BayesianOptimization object will work out of the box without much tuning needed. The main method you should be aware of is `maximize`, which does exactly what you think it does.
9797

9898
There are many parameters you can pass to maximize, nonetheless, the most important ones are:
9999
- `n_iter`: How many steps of bayesian optimization you want to perform. The more steps the more likely to find a good maximum you are.
@@ -172,7 +172,7 @@ optimizer.maximize(
172172

173173
## 3. Guiding the optimization
174174

175-
It is often the case that we have an idea of regions of the parameter space where the maximum of our function might lie. For these situations the `BayesianOptimization` object allows the user to specify specific points to be probed. By default these will be explored lazily (`lazy=True`), meaning these points will be evaluated only the next time you call `maximize`. This probing process happens before the gaussian process takes over.
175+
It is often the case that we have an idea of regions of the parameter space where the maximum of our function might lie. For these situations the `BayesianOptimization` object allows the user to specify points to be probed. By default these will be explored lazily (`lazy=True`), meaning these points will be evaluated only the next time you call `maximize`. This probing process happens before the gaussian process takes over.
176176

177177
Parameters can be passed as dictionaries or as an iterable.
178178

examples/basic-tour.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
"cell_type": "markdown",
8989
"metadata": {},
9090
"source": [
91-
"The BayesianOptimization object will work all of the box without much tuning needed. The main method you should be aware of is `maximize`, which does exactly what you think it does.\n",
91+
"The BayesianOptimization object will work out of the box without much tuning needed. The main method you should be aware of is `maximize`, which does exactly what you think it does.\n",
9292
"\n",
9393
"There are many parameters you can pass to maximize, nonetheless, the most important ones are:\n",
9494
"- `n_iter`: How many steps of bayesian optimization you want to perform. The more steps the more likely to find a good maximum you are.\n",

0 commit comments

Comments
 (0)