Struct HyperParameterSpecification

#[non_exhaustive]
pub struct HyperParameterSpecification {
    pub name: Option<String>,
    pub description: Option<String>,
    pub type: Option<ParameterType>,
    pub range: Option<ParameterRange>,
    pub is_tunable: Option<bool>,
    pub is_required: Option<bool>,
    pub default_value: Option<String>,
}

Defines a hyperparameter to be used by an algorithm.

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 this hyperparameter. The name must be unique.

description: Option<String>

A brief description of the hyperparameter.

type: Option<ParameterType>

The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.

range: Option<ParameterRange>

The allowed range for this hyperparameter.

is_tunable: Option<bool>

Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.

is_required: Option<bool>

Indicates whether this hyperparameter is required.

default_value: Option<String>

The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.

Implementations

impl HyperParameterSpecification

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

The name of this hyperparameter. The name must be unique.

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

A brief description of the hyperparameter.

pub fn type(&self) -> Option<&ParameterType>

The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.

pub fn range(&self) -> Option<&ParameterRange>

The allowed range for this hyperparameter.

pub fn is_tunable(&self) -> Option<bool>

Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.

pub fn is_required(&self) -> Option<bool>

Indicates whether this hyperparameter is required.

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

The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.

impl HyperParameterSpecification

pub fn builder() -> HyperParameterSpecificationBuilder

Creates a new builder-style object to manufacture HyperParameterSpecification.

Trait Implementations

impl Clone for HyperParameterSpecification

fn clone(&self) -> HyperParameterSpecification

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HyperParameterSpecification

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

Formats the value using the given formatter.

impl PartialEq for HyperParameterSpecification

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