#[non_exhaustive]pub struct HyperParameterSpecification { /* private fields */ }
Expand description
Defines a hyperparameter to be used by an algorithm.
Implementations§
source§impl HyperParameterSpecification
impl HyperParameterSpecification
sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
A brief description of the hyperparameter.
sourcepub fn type(&self) -> Option<&ParameterType>
pub fn type(&self) -> Option<&ParameterType>
The type of this hyperparameter. The valid types are Integer
, Continuous
, Categorical
, and FreeText
.
sourcepub fn range(&self) -> Option<&ParameterRange>
pub fn range(&self) -> Option<&ParameterRange>
The allowed range for this hyperparameter.
sourcepub fn is_tunable(&self) -> bool
pub fn is_tunable(&self) -> bool
Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.
sourcepub fn is_required(&self) -> bool
pub fn is_required(&self) -> bool
Indicates whether this hyperparameter is required.
sourcepub fn default_value(&self) -> Option<&str>
pub fn default_value(&self) -> Option<&str>
The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.
source§impl HyperParameterSpecification
impl HyperParameterSpecification
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture HyperParameterSpecification
.
Trait Implementations§
source§impl Clone for HyperParameterSpecification
impl Clone for HyperParameterSpecification
source§fn clone(&self) -> HyperParameterSpecification
fn clone(&self) -> HyperParameterSpecification
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for HyperParameterSpecification
impl Debug for HyperParameterSpecification
source§impl PartialEq<HyperParameterSpecification> for HyperParameterSpecification
impl PartialEq<HyperParameterSpecification> for HyperParameterSpecification
source§fn eq(&self, other: &HyperParameterSpecification) -> bool
fn eq(&self, other: &HyperParameterSpecification) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.