Enum SearchDimension 

#[non_exhaustive]
pub enum SearchDimension {
    Float {
        name: String,
        low: f64,
        high: f64,
        scale: Scale,
        default: Option<f64>,
    },
    Int {
        name: String,
        low: i64,
        high: i64,
        scale: Scale,
    },
    Categorical {
        name: String,
        choices: Vec<Value>,
    },
    Conditional {
        name: String,
        parent: String,
        parent_values: Vec<Value>,
        dimension: Box<SearchDimension>,
    },
}

A single searchable parameter dimension.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Float

Continuous range (f64)

Fields

name: String

Parameter name (prefixed with the filter label when spaces are merged, e.g. "SVM.C").

low: f64

Inclusive lower bound. Must be strictly less than high.

high: f64

Inclusive upper bound.

scale: Scale

How samplers interpolate between the bounds.

default: Option<f64>

Value used when the dimension is not being searched; None means the filter’s own field default applies.

Int

Integer range

Fields

name: String

Parameter name (prefixed with the filter label when spaces are merged).

low: i64

Inclusive lower bound. Must be strictly less than high.

high: i64

Inclusive upper bound.

scale: Scale

How samplers interpolate between the bounds.

Categorical

Discrete set of choices

Fields

name: String

Parameter name (prefixed with the filter label when spaces are merged).

choices: Vec<Value>

The candidate values, as JSON so strings, numbers, and booleans can mix. Must not be empty.

Conditional

Active only when parent parameter has specific values

Fields

name: String

Parameter name (prefixed with the filter label when spaces are merged).

parent: String

Name of the parameter this dimension depends on. Prefixed alongside name in SearchSpace::merge_with_prefix, so the link survives merging.

parent_values: Vec<Value>

Parent values that activate this dimension; for any other parent value the dimension is skipped.

dimension: Box<SearchDimension>

The dimension to sample when active.

Implementations

impl SearchDimension

pub fn name(&self) -> &str

The parameter name, whichever variant this is. This is the key trial params are stored under and the handle SearchSpace::freeze matches on.

pub fn validate(&self) -> Result<(), String>

Validate the dimension configuration: ranges must satisfy low < high, categorical choices must not be empty, and a conditional is as valid as its inner dimension. The Err message names the offending dimension.

Trait Implementations

impl Clone for SearchDimension

fn clone(&self) -> SearchDimension

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchDimension

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SearchDimension

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SearchDimension

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

Formats the value using the given formatter.

impl PartialEq for SearchDimension

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SearchDimension

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 SearchDimension