diff --git a/docs/algorithm-settings.md b/docs/algorithm-settings.md index 942acc9249f..4448cb55516 100644 --- a/docs/algorithm-settings.md +++ b/docs/algorithm-settings.md @@ -35,7 +35,12 @@ Random sampling is an alternative to grid search when the number of discrete par ### [Hyperopt][] -Algorithm name in katib is `random`. +Algorithm name in katib is `random`, and there are some algortihm settings that we support: + +| Setting Name | Description | Example | +|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| +| random_state | [int]: Set random state to something other than None for reproducible results. | 10 | + ## TPE @@ -75,7 +80,7 @@ Algorithm name in katib is `skopt-bayesian-optimization`, and there are some alg | n_initial_points | [int, default=10]: Number of evaluations of `func` with initialization points before approximating it with `base_estimator`. Points provided as `x0` count as initialization points. If len(x0) < n_initial_points additional points are sampled at random. More in [skopt document](https://scikit-optimize.github.io/#skopt.Optimizer) | 10 | | acq_func | [string, default=`"gp_hedge"`]: Function to minimize over the posterior distribution. More in [skopt document](https://scikit-optimize.github.io/#skopt.Optimizer) | gp_hedge | | acq_optimizer | [string, "sampling" or "lbfgs", default="auto"]: Method to minimize the acquistion function. The fit model is updated with the optimal value obtained by optimizing acq_func with acq_optimizer. More in [skopt document](https://scikit-optimize.github.io/#skopt.Optimizer) | auto | -| random_state | [int, RandomState instance, or None (default)]: Set random state to something other than None for reproducible results. | 10 | +| random_state | [int]: Set random state to something other than None for reproducible results. | 10 | ## References