Skip to content

Commit

Permalink
Improve py documentaiton
Browse files Browse the repository at this point in the history
  • Loading branch information
relf committed Sep 30, 2024
1 parent 1587cc7 commit d9d8ef5
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions src/egor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -138,10 +138,14 @@ pub(crate) fn to_specs(py: Python, xlimits: Vec<Vec<f64>>) -> PyResult<PyObject>
/// warm_start (bool)
/// Start by loading initial doe from <outdir> directory
///
/// hot_start (u64 or None)
/// Start from last checkpoint if any for a given number of iterations beyond initial max_iters
/// and save optimizer state at each iteration allowing further hot start
/// Checkpoint information is stored in .checkpoint directory.
/// hot_start (int or None)
/// When hot_start>=0 saves optimizer state at each iteration and starts from a previous checkpoint
/// if any for the given hot_start number of iterations beyond the max_iters nb of iterations.
/// In an unstable environment were there can be crashes it allows to restart the optimization
/// from the last iteration till stopping criterion is reached. Just use hot_start=0 in this case.
/// When specifying an extended nb of iterations (hot_start > 0) it can allow to continue till max_iters +
/// hot_start nb of iters is reached (provided the stopping criterion is max_iters)
/// Checkpoint information is stored in .checkpoint/egor.arg binary file.
///
/// seed (int >= 0)
/// Random generator seed to allow computation reproducibility.
Expand Down

0 comments on commit d9d8ef5

Please sign in to comment.