Struct CategoricalParam 

pub struct CategoricalParam<T: Clone> { /* private fields */ }

A categorical parameter that selects from a list of choices.

The generic type T is the element type of the choices vector. The sampler picks an index and the corresponding element is returned.

Examples

use optimizer::Trial;
use optimizer::parameter::{CategoricalParam, Parameter};

let mut trial = Trial::new(0);
let opt = CategoricalParam::new(vec!["sgd", "adam", "rmsprop"])
    .name("optimizer")
    .suggest(&mut trial)
    .unwrap();

Implementations

impl<T: Clone> CategoricalParam<T>

pub fn new(choices: Vec<T>) -> Self

Create a new categorical parameter with the given choices.

pub fn name(self, name: impl Into<String>) -> Self

Set a human-readable name for this parameter.

When set, this name is used as the parameter’s label instead of the default Debug output.

Trait Implementations

impl<T: Clone + Clone> Clone for CategoricalParam<T>

fn clone(&self) -> CategoricalParam<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Clone> Debug for CategoricalParam<T>

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

Formats the value using the given formatter.

impl<T: Clone + Debug> Parameter for CategoricalParam<T>

type Value = T

The typed value returned after sampling.

fn id(&self) -> ParamId

Return the unique identifier for this parameter.

fn distribution(&self) -> Distribution

Return the distribution that this parameter samples from.

fn cast_param_value(&self, param_value: &ParamValue) -> Result<T>

Convert a raw ParamValue into the typed value.

fn validate(&self) -> Result<()>

Validate the parameter configuration.

fn label(&self) -> String

Return a human-readable label for this parameter.

fn suggest(&self, trial: &mut Trial) -> Result<Self::Value>

where Self: Sized,

Suggest a value for this parameter from the given trial.