diff --git a/README.md b/README.md index 677755d..7581a95 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,28 @@ -# egobox +

+ Efficient Global Optimization toolbox in Rust +

+ +# EGObox - Efficient Global Optimization toolbox [![tests](https://github.com/relf/egobox/workflows/tests/badge.svg)](https://github.com/relf/egobox/actions?query=workflow%3Atests) [![pytests](https://github.com/relf/egobox/workflows/pytests/badge.svg)](https://github.com/relf/egobox/actions?query=workflow%3Apytests) [![linting](https://github.com/relf/egobox/workflows/lint/badge.svg)](https://github.com/relf/egobox/actions?query=workflow%3Alint) [![DOI](https://joss.theoj.org/papers/10.21105/joss.04737/status.svg)](https://doi.org/10.21105/joss.04737) -Rust toolbox for Efficient Global Optimization algorithms inspired from [SMT](https://github.com/SMTorg/smt). +Rust toolbox for Efficient Global Optimization inspired by [the EGO implementation](https://smt.readthedocs.io/en/stable/_src_docs/applications/ego.html) +in the [SMT](https://github.com/SMTorg/smt) Python library. -`egobox` is twofold: +The `egobox` package is twofold: 1. for end-users: [a Python module](#the-python-module), the Python binding of the optimizer named `Egor` and the surrogate model `Gpx`, mixture of Gaussian processes, written in Rust. 2. for developers: [a set of Rust libraries](#the-rust-libraries) useful to implement bayesian optimization (EGO-like) algorithms, ## The Python module -Thanks to the [PyO3 project](https://pyo3.rs), which makes Rust well suited for building Python extensions. - ### Installation ```bash @@ -192,7 +199,7 @@ disciplinary design optimization algorithm. Structural and Multidisciplinary Opt 62(4), 1739–1765. Jones, D. R., Schonlau, M., & Welch, W. J. (1998). Efficient global optimization of expensive -black-box functions. Journal of Global Optimization, 13(4), 455–492. +black-box functions. Journal of Global Optimization, 13(4), 455–492. Diouane, Youssef, et al. "TREGO: a trust-region framework for efficient global optimization." Journal of Global Optimization 86.1 (2023): 1-23. diff --git a/doc/LOGO_EGOBOX_v4_100x100.png b/doc/LOGO_EGOBOX_v4_100x100.png new file mode 100644 index 0000000..5dd8fb3 Binary files /dev/null and b/doc/LOGO_EGOBOX_v4_100x100.png differ diff --git a/doc/README.md b/doc/README.md index 9111517..4349de6 100644 --- a/doc/README.md +++ b/doc/README.md @@ -4,7 +4,6 @@ [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/relf/egobox/blob/master/doc/Egor_Tutorial.ipynb) - ## Mixture of Gaussian process surrogates: _Gpx_ [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/relf/egobox/blob/master/doc/Gpx_Tutorial.ipynb) diff --git a/ego/src/lib.rs b/ego/src/lib.rs index 9b99772..edf8a49 100644 --- a/ego/src/lib.rs +++ b/ego/src/lib.rs @@ -155,7 +155,7 @@ //! * Mixture of experts and PLS dimension reduction is explained in \[[Bartoli2019](#Bartoli2019)\] //! * Parallel optimization is available through the selection of a qei strategy. See in \[[Ginsbourger2010](#Ginsbourger2010)\] //! * Mixed integer approach is implemented using continuous relaxation. See \[[Garrido2018](#Garrido2018)\] -//! * TREGO algorithm can is enabled by default. See \[[Diouane2023](#Diouane2023)\] +//! * TREGO algorithm is enabled by default. See \[[Diouane2023](#Diouane2023)\] //! //! # References //! @@ -185,8 +185,9 @@ //! disciplinary design optimization algorithm](https://doi.org/10.1007/s00158-020-02514-6). //! Structural and Multidisciplinary Optimization, 62(4), 1739–1765. //! -//! Jones, D. R., Schonlau, M., & Welch, W. J. (1998). Efficient global optimization of expensive -//! black-box functions. Journal of Global Optimization, 13(4), 455–492. +//! Jones, D. R., Schonlau, M., & Welch, W. J. (1998). [Efficient global optimization of expensive +//! black-box functions](https://www.researchgate.net/publication/235709802_Efficient_Global_Optimization_of_Expensive_Black-Box_Functions). +//! Journal of Global Optimization, 13(4), 455–492. //! //! \[Diouane(2023)\]: Diouane, Youssef, et al. //! [TREGO: a trust-region framework for efficient global optimization](https://arxiv.org/pdf/2101.06808)