Skip to content

Commit 60b5352

Browse files
committed
DOC: Minor doc updates
1 parent b2cf23c commit 60b5352

File tree

3 files changed

+14
-12
lines changed

3 files changed

+14
-12
lines changed

benchmark/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,5 @@ Run in project root:
99
python -m benchmark |
1010
tee benchmark-$(date --iso-8601=minutes).txt
1111
```
12+
13+
See [published result](https://sambo-optimization.github.io/#benchmark).

sambo/__init__.py

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,33 +13,32 @@
1313
* **function `sambo.minimize()`**, a near drop-in replacement for [`scipy.optimize.minimize()`][sp_opt_min],
1414
* **class `Optimizer`** with an ask-and-tell user interface,
1515
supporting arbitrary scikit-learn-like surrogate models,
16-
with Bayesian optimization estimators like [gaussian process] and [extra trees],
16+
with **Bayesian optimization estimators like [Gaussian processes] and [Extra Trees]**
1717
built in,
18-
* **`SamboSearchCV`**, a much faster drop-in replacement for
19-
scikit-learn's [`GridSearchCV`][skl_gridsearchcv] and similar exhaustive
18+
* **`SamboSearchCV`**, a much faster **drop-in replacement** for
19+
scikit-learn's **[`GridSearchCV`][skl_gridsearchcv]** and similar exhaustive
2020
machine-learning hyper-parameter tuning methods,
2121
but compared to unpredictable stochastic methods, _informed_.
2222
2323
The algorithms and methods implemented by or used in this package are:
2424
25-
* [simplical homology global optimization] (SHGO), customizing the [implementation from SciPy],
26-
* surrogate machine learning model-based optimization,
27-
* [shuffled complex evolution] (SCE-UA with improvements).
25+
* **[simplical homology global optimization] (SHGO)**, reinitializing the [implementation from SciPy],
26+
* **surrogate** machine learning **model**-based optimization,
27+
* [shuffled complex evolution] (**SCE-UA** with improvements).
2828
2929
[simplical homology global optimization]: http://doi.org/10.1007/s10898-018-0645-y
3030
[implementation from SciPy]: https://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.shgo.html
3131
[shuffled complex evolution]: https://doi.org/10.1007/BF00939380
3232
33-
This open-source project was heavily **inspired by _scikit-optimize_** project,
34-
which now seems helplessly defunct.
35-
36-
The project is one of the better optimizers around according to [benchmark].
33+
This open-source project was **inspired by _scikit-optimize_**.
34+
The project is one of the better optimizers available according to
35+
[benchmark](https://sambo-optimization.github.io/#benchmark).
3736
3837
\N{DAGGER} The contained algorithms seek to _minimize_ your objective `f(x)`.
3938
If you instead need the _maximum_, simply minimize `-f(x)`. 💡
4039
41-
[gaussian process]: https://www.gaussianprocess.org/gpml/chapters/RW.pdf
42-
[extra trees]: https://doi.org/10.1007/s10994-006-6226-1
40+
[Gaussian processes]: https://www.gaussianprocess.org/gpml/chapters/RW.pdf
41+
[Extra Trees]: https://doi.org/10.1007/s10994-006-6226-1
4342
[kernel ridge regression]: https://scikit-learn.org/stable/modules/kernel_ridge.html
4443
[sp_opt_min]: https://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.minimize.html
4544
[skl_gridsearchcv]: https://scikit-learn.org/stable/modules/generated/sklearn.model_selection.GridSearchCV.html

sambo/plot.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
-------
77
>>> import matplotlib.pyplot as plt
88
>>> from scipy.optimize import rosen
9+
>>> from sambo import minimize
910
>>> result = minimize(rosen, bounds=[(-2, 2), (-2, 2)],
1011
... constraints=lambda x: sum(x) <= len(x))
1112
>>> plot_convergence(result)

0 commit comments

Comments
 (0)