Struct DefaultCategoricalHyperParameterRange 

#[non_exhaustive]
pub struct DefaultCategoricalHyperParameterRange {
    pub name: Option<String>,
    pub values: Option<Vec<String>>,
    pub is_tunable: bool,
}

Provides the name and default range of a categorical hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

The name of the hyperparameter.

values: Option<Vec<String>>

A list of the categories for the hyperparameter.

is_tunable: bool

Whether the hyperparameter is tunable.

Implementations

impl DefaultCategoricalHyperParameterRange

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

The name of the hyperparameter.

pub fn values(&self) -> &[String]

A list of the categories for the hyperparameter.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .values.is_none().

pub fn is_tunable(&self) -> bool

Whether the hyperparameter is tunable.

impl DefaultCategoricalHyperParameterRange

pub fn builder() -> DefaultCategoricalHyperParameterRangeBuilder

Creates a new builder-style object to manufacture DefaultCategoricalHyperParameterRange.

Trait Implementations

impl Clone for DefaultCategoricalHyperParameterRange

fn clone(&self) -> DefaultCategoricalHyperParameterRange

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DefaultCategoricalHyperParameterRange

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

Formats the value using the given formatter.

impl PartialEq for DefaultCategoricalHyperParameterRange

fn eq(&self, other: &DefaultCategoricalHyperParameterRange) -> 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 StructuralPartialEq for DefaultCategoricalHyperParameterRange