Skip to content

Commit 61a8d88

Browse files
committed
Update docstrings
1 parent e3153e2 commit 61a8d88

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

sambo/__init__.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@
1010
1111
The main tools in this Python optimization toolbox are:
1212
13-
* **function `sambo.minimize()`**, a drop-in replacement for [`scipy.optimize.minimize()`][sp_opt_min],
13+
* **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], [extra trees],
17-
and [kernel ridge regression] built in,
16+
with Bayesian optimization estimators like [gaussian process] and [extra trees],
17+
built in,
1818
* **`SamboSearchCV`**, a much faster drop-in replacement for
1919
scikit-learn's [`GridSearchCV`][skl_gridsearchcv] and similar exhaustive
2020
machine-learning hyper-parameter tuning methods,
21-
but compared to stochastic methods, precise.
21+
but compared to unpredictable stochastic methods, _informed_.
2222
2323
The algorithms and methods implemented by or used in this package are:
2424
@@ -35,8 +35,8 @@
3535
3636
The project is one of the better optimizers around according to [benchmark].
3737
38-
\N{DAGGER} The contained algorithms seek _minimums_ of your objective `f(x)`.
39-
If you instead want to find the _maximum_, simply minimize `-f(x)`. 💡
38+
\N{DAGGER} The contained algorithms seek to _minimize_ your objective `f(x)`.
39+
If you instead need the _maximum_, simply minimize `-f(x)`. 💡
4040
4141
[gaussian process]: https://www.gaussianprocess.org/gpml/chapters/RW.pdf
4242
[extra trees]: https://doi.org/10.1007/s10994-006-6226-1

sambo/plot.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
2-
The module contains functions for plotting convergence, regret,
3-
partial dependence, sequence of evaluations ...
2+
The module contains **functions for plotting**
3+
convergence, regret, partial dependence, sequence of evaluations ...
44
55
Example
66
-------

0 commit comments

Comments
 (0)