#[non_exhaustive]pub struct HyperParameterSpecification { /* private fields */ }
Expand description
Defines a hyperparameter to be used by an algorithm.
Implementations
sourceimpl 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.
sourceimpl HyperParameterSpecification
impl HyperParameterSpecification
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture HyperParameterSpecification
.
Trait Implementations
sourceimpl Clone for HyperParameterSpecification
impl Clone for HyperParameterSpecification
sourcefn clone(&self) -> HyperParameterSpecification
fn clone(&self) -> HyperParameterSpecification
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for HyperParameterSpecification
impl Debug for HyperParameterSpecification
sourceimpl PartialEq<HyperParameterSpecification> for HyperParameterSpecification
impl PartialEq<HyperParameterSpecification> for HyperParameterSpecification
sourcefn 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 ==
. Read more
impl StructuralPartialEq for HyperParameterSpecification
Auto Trait Implementations
impl RefUnwindSafe for HyperParameterSpecification
impl Send for HyperParameterSpecification
impl Sync for HyperParameterSpecification
impl Unpin for HyperParameterSpecification
impl UnwindSafe for HyperParameterSpecification
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more