Refactor ego module (#169)

* Move solver impl in solver sub-module

* Renaming solver files

* Make clippy happy

* Add solver structs visibility

* Refactor organizing egobox-ego with sub-modules

* Expose regression and correlation specs

* Use web-time instead of deprecated instant

* Fix instant in doc examples

Author: relf

ego/Cargo.toml

@@ -41,7 +41,7 @@ nlopt = { version = "0.7.0", optional = true }
 
 rand_xoshiro = { version = "0.6", features = ["serde1"] }
 argmin = { version = "0.10.0", features = ["serde1", "ctrlc"] }
-instant = "0.1"
+web-time = "1.1.0"
 libm = "0.2.6"
 finitediff = { version = "0.1", features = ["ndarray"] }
 # sort-axis

ego/src/criteria/mod.rs

@@ -1,5 +1,6 @@
-pub mod ei;
-pub mod wb2;
+//! Available infill criteria to be used by Egor solver
+mod ei;
+mod wb2;
 
 pub use ei::{ExpectedImprovement, EI};
 pub use wb2::{WB2Criterion, WB2, WB2S};

ego/src/egor.rs

@@ -90,10 +90,10 @@
 //! ```
 //!
 use crate::egor_config::*;
-use crate::egor_solver::*;
 use crate::errors::Result;
-use crate::mixint::*;
+use crate::gpmix::mixint::*;
 use crate::types::*;
+use crate::{to_xtypes, EgorSolver};
 
 use egobox_moe::GpMixtureParams;
 use log::info;
@@ -237,6 +237,8 @@ mod tests {
     use serial_test::serial;
     use std::time::Instant;
 
+    use crate::{gpmix::spec::*, DOE_FILE, DOE_INITIAL_FILE};
+
     #[cfg(not(feature = "blas"))]
     use linfa_linalg::norm::*;
     #[cfg(feature = "blas")]

ego/src/mixint.rs renamed to ego/src/gpmix/mixint.rs

@@ -1,5 +1,6 @@
-//! This library implements continuous relaxation functions,
-//! it is a port of [SMT mixed integer module](https://smt.readthedocs.io/en/latest/_src_docs/applications/mixed_integer.html)
+//! Mixed-integer mixture of Gaussian processes
+//!
+//! This module exposes a GP mixture model featuring continuous relaxation to handle mixed-interger variables
 
 #![allow(dead_code)]
 use crate::errors::{EgoError, Result};

ego/src/gpmix/mod.rs

@@ -0,0 +1,4 @@
+//! Mixture of Gaussian process models used by the Egor solver
+
+pub mod mixint;
+pub mod spec;

ego/src/gpmix/spec.rs

@@ -0,0 +1,7 @@
+//! GP mixture model specification used by the Egor solver
+
+/// Flags for regression model selection
+pub use egobox_moe::RegressionSpec;
+
+/// Flags for correlation model selection
+pub use egobox_moe::CorrelationSpec;

ego/src/lib.rs

@@ -175,27 +175,22 @@
 //! integer-valued variables in Bayesian Optimization with Gaussian processes.
 //!
 //!
-mod criteria;
+pub mod criteria;
+pub mod gpmix;
+
 mod egor;
 mod egor_config;
-mod egor_service;
-mod egor_solver;
-mod egor_state;
 mod errors;
-mod mixint;
+mod solver;
 mod types;
 
-mod lhs_optimizer;
-mod optimizer;
-mod sort_axis;
-mod utils;
-
-pub use crate::criteria::*;
 pub use crate::egor::*;
 pub use crate::egor_config::*;
-pub use crate::egor_service::*;
-pub use crate::egor_solver::*;
-pub use crate::egor_state::*;
 pub use crate::errors::*;
-pub use crate::mixint::*;
+pub use crate::gpmix::spec::{CorrelationSpec, RegressionSpec};
+pub use crate::solver::*;
 pub use crate::types::*;
+pub use crate::utils::find_best_result_index;
+
+mod optimizers;
+mod utils;

ego/src/lhs_optimizer.rs renamed to ego/src/optimizers/lhs_optimizer.rs

@@ -0,0 +1,7 @@
+//! Optimizers used internally to optimize the infill criterion
+
+mod lhs_optimizer;
+mod optimizer;
+
+pub(crate) use lhs_optimizer::*;
+pub(crate) use optimizer::*;

ego/src/optimizers/mod.rs

@@ -1,4 +1,4 @@
-use crate::lhs_optimizer::LhsOptimizer;
+use crate::optimizers::LhsOptimizer;
 use crate::ObjData;
 use ndarray::{arr1, Array1, Array2, ArrayView1};
 

ego/src/optimizer.rs renamed to ego/src/optimizers/optimizer.rs

@@ -40,9 +40,9 @@
 //! ```
 //!
 use crate::egor_config::*;
-use crate::egor_solver::*;
-use crate::mixint::*;
+use crate::gpmix::mixint::*;
 use crate::types::*;
+use crate::{to_xtypes, EgorSolver};
 
 use egobox_moe::GpMixtureParams;
 use ndarray::{Array2, ArrayBase, Data, Ix2};
@@ -140,6 +140,7 @@ impl<SB: SurrogateBuilder> EgorService<SB> {
 #[cfg(test)]
 mod tests {
     use super::*;
+    use crate::gpmix::spec::*;
     use approx::assert_abs_diff_eq;
     use ndarray::{array, concatenate, ArrayView2, Axis};