Skip to content

Commit 661fb80

Browse files
committed
Add citation blurb to README
1 parent 0569178 commit 661fb80

File tree

1 file changed

+20
-9
lines changed

1 file changed

+20
-9
lines changed

README.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,23 +15,20 @@ processes.
1515

1616
```console
1717
$ pip install bayesian-optimization
18-
```
18+
```
1919

2020
* Conda from conda-forge channel:
2121

2222
```console
2323
$ conda install -c conda-forge bayesian-optimization
24-
```
24+
```
2525

2626
This is a constrained global optimization package built upon bayesian inference
2727
and gaussian process, that attempts to find the maximum value of an unknown
2828
function in as few iterations as possible. This technique is particularly
2929
suited for optimization of high cost functions, situations where the balance
3030
between exploration and exploitation is important.
3131

32-
## Important notice
33-
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.
34-
3532
## Quick Start
3633
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:
3734
- Follow the
@@ -220,7 +217,7 @@ By default you can follow the progress of your optimization by setting `verbose>
220217

221218

222219
```python
223-
from bayes_opt.logger import JSONLogger
220+
from bayes_opt.observer import JSONLogger
224221
from bayes_opt.event import Events
225222
```
226223

@@ -278,7 +275,7 @@ The latest release can be obtained by two ways:
278275
* With PyPI (pip):
279276

280277
pip install bayesian-optimization
281-
278+
282279
* With conda (from conda-forge channel):
283280

284281
conda install -c conda-forge bayesian-optimization
@@ -294,12 +291,26 @@ commands to get a copy from Github and install all dependencies:
294291
cd BayesianOptimization
295292
python setup.py install
296293

297-
### Dependencies
294+
Citation
295+
============
296+
297+
If you used this package in your research and is interested in citing it here's how you do it:
298+
299+
```
300+
@Misc{,
301+
author = {Fernando Nogueira},
302+
title = {{Bayesian Optimization}: Open source constrained global optimization tool for {Python}},
303+
year = {2014--},
304+
url = " https://github.com/fmfn/BayesianOptimization"
305+
}
306+
```
307+
308+
# Dependencies
298309
* Numpy
299310
* Scipy
300311
* Scikit-learn
301312

302-
### References:
313+
# References:
303314
* http://papers.nips.cc/paper/4522-practical-bayesian-optimization-of-machine-learning-algorithms.pdf
304315
* http://arxiv.org/pdf/1012.2599v1.pdf
305316
* http://www.gaussianprocess.org/gpml/

0 commit comments

Comments
 (0)