Struct kurobako_solvers::optuna::OptunaSolverRecipe

pub struct OptunaSolverRecipe {
    pub loglevel: String,
    pub sampler: Option<String>,
    pub sampler_kwargs: Option<String>,
    pub pruner: Option<String>,
    pub pruner_kwargs: Option<String>,
    pub maximize: bool,
    pub use_discrete_uniform: bool,
}

Recipe of OptunaSolver.

Fields

loglevel: String

Log level.

sampler: Option<String>

Sampler class name (e.g., “TPESampler”).

sampler_kwargs: Option<String>

Sampler arguments (e.g., “{"seed": 10}”).

pruner: Option<String>

Pruner class name (e.g., “MedianPruner”).

pruner_kwargs: Option<String>

Pruner arguments (e.g., “{"n_warmup_steps": 10}”).

maximize: bool

Sets optimization direction to “maximize”.

The sign of all evaluated values ​​is reversed before being passed to Optuna.

use_discrete_uniform: bool

If this is true, Trial.suggest_discrete_uniform() is used for sampling discrete parameters instead of Trial.suggest_int().

Trait Implementations

impl Clone for OptunaSolverRecipe

fn clone(&self) -> OptunaSolverRecipe

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OptunaSolverRecipe

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OptunaSolverRecipe

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for OptunaSolverRecipe

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl SolverRecipe for OptunaSolverRecipe

type Factory = OptunaSolverFactory

The type of he factory creating solver instances from this recipe.

fn create_factory(&self, registry: &FactoryRegistry) -> Result<Self::Factory>

Creates a solver factory.

impl StructOpt for OptunaSolverRecipe

fn clap<'a, 'b>() -> App<'a, 'b>

Returns clap::App corresponding to the struct.

fn from_clap(matches: &ArgMatches<'_>) -> Self

Builds the struct from clap::ArgMatches. It’s guaranteed to succeed if matches originates from an App generated by StructOpt::clap called on the same type, otherwise it must panic.

fn from_args() -> Self

Builds the struct from the command line arguments (std::env::args_os). Calls clap::Error::exit on failure, printing the error message and aborting the program.

fn from_args_safe() -> Result<Self, Error>

Builds the struct from the command line arguments (std::env::args_os). Unlike StructOpt::from_args, returns clap::Error on failure instead of aborting the program, so calling .exit is up to you.

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

fn from_iter_safe<I>(iter: I) -> Result<Self, Error> where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making.