Enum Value 

pub enum Value {
    Float(f64),
    Int(i64),
    Categorical(String),
}

A concrete hyperparameter value suggested for a trial.

For v1 the categorical variant is restricted to string/enum-like values (Categorical(String)); arbitrary user types are intentionally out of scope to keep the sampler/storage plumbing simple. Callers that need richer categoricals should map their type to/from a stable string label.

Variants

Float(f64)

A continuous value (from a Uniform/LogUniform distribution).

Int(i64)

A discrete integer value (from an IntUniform distribution).

Categorical(String)

A categorical choice, identified by its label.

Implementations

impl Value

pub fn as_float(&self) -> Option<f64>

Returns the inner f64 if this is a Value::Float.

pub fn as_int(&self) -> Option<i64>

Returns the inner i64 if this is a Value::Int.

pub fn as_categorical(&self) -> Option<&str>

Returns the inner label if this is a Value::Categorical.

pub fn to_f64(&self) -> Option<f64>

Best-effort numeric projection, used by adaptive samplers and the param-importance proxy. Categoricals have no meaningful scalar and return None.

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Value

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Value

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

Formats the value using the given formatter.

impl PartialEq for Value

fn eq(&self, other: &Value) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Value

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Value