#[non_exhaustive]pub struct HyperParameterTuningJobConfigBuilder { /* private fields */ }
Expand description
A builder for HyperParameterTuningJobConfig
.
Implementations§
Source§impl HyperParameterTuningJobConfigBuilder
impl HyperParameterTuningJobConfigBuilder
Sourcepub fn strategy(self, input: HyperParameterTuningJobStrategyType) -> Self
pub fn strategy(self, input: HyperParameterTuningJobStrategyType) -> Self
Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training job it launches. For information about search strategies, see How Hyperparameter Tuning Works.
This field is required.Sourcepub fn set_strategy(
self,
input: Option<HyperParameterTuningJobStrategyType>,
) -> Self
pub fn set_strategy( self, input: Option<HyperParameterTuningJobStrategyType>, ) -> Self
Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training job it launches. For information about search strategies, see How Hyperparameter Tuning Works.
Sourcepub fn get_strategy(&self) -> &Option<HyperParameterTuningJobStrategyType>
pub fn get_strategy(&self) -> &Option<HyperParameterTuningJobStrategyType>
Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training job it launches. For information about search strategies, see How Hyperparameter Tuning Works.
Sourcepub fn strategy_config(
self,
input: HyperParameterTuningJobStrategyConfig,
) -> Self
pub fn strategy_config( self, input: HyperParameterTuningJobStrategyConfig, ) -> Self
The configuration for the Hyperband
optimization strategy. This parameter should be provided only if Hyperband
is selected as the strategy for HyperParameterTuningJobConfig
.
Sourcepub fn set_strategy_config(
self,
input: Option<HyperParameterTuningJobStrategyConfig>,
) -> Self
pub fn set_strategy_config( self, input: Option<HyperParameterTuningJobStrategyConfig>, ) -> Self
The configuration for the Hyperband
optimization strategy. This parameter should be provided only if Hyperband
is selected as the strategy for HyperParameterTuningJobConfig
.
Sourcepub fn get_strategy_config(
&self,
) -> &Option<HyperParameterTuningJobStrategyConfig>
pub fn get_strategy_config( &self, ) -> &Option<HyperParameterTuningJobStrategyConfig>
The configuration for the Hyperband
optimization strategy. This parameter should be provided only if Hyperband
is selected as the strategy for HyperParameterTuningJobConfig
.
Sourcepub fn hyper_parameter_tuning_job_objective(
self,
input: HyperParameterTuningJobObjective,
) -> Self
pub fn hyper_parameter_tuning_job_objective( self, input: HyperParameterTuningJobObjective, ) -> Self
The HyperParameterTuningJobObjective specifies the objective metric used to evaluate the performance of training jobs launched by this tuning job.
Sourcepub fn set_hyper_parameter_tuning_job_objective(
self,
input: Option<HyperParameterTuningJobObjective>,
) -> Self
pub fn set_hyper_parameter_tuning_job_objective( self, input: Option<HyperParameterTuningJobObjective>, ) -> Self
The HyperParameterTuningJobObjective specifies the objective metric used to evaluate the performance of training jobs launched by this tuning job.
Sourcepub fn get_hyper_parameter_tuning_job_objective(
&self,
) -> &Option<HyperParameterTuningJobObjective>
pub fn get_hyper_parameter_tuning_job_objective( &self, ) -> &Option<HyperParameterTuningJobObjective>
The HyperParameterTuningJobObjective specifies the objective metric used to evaluate the performance of training jobs launched by this tuning job.
Sourcepub fn resource_limits(self, input: ResourceLimits) -> Self
pub fn resource_limits(self, input: ResourceLimits) -> Self
The ResourceLimits object that specifies the maximum number of training and parallel training jobs that can be used for this hyperparameter tuning job.
This field is required.Sourcepub fn set_resource_limits(self, input: Option<ResourceLimits>) -> Self
pub fn set_resource_limits(self, input: Option<ResourceLimits>) -> Self
The ResourceLimits object that specifies the maximum number of training and parallel training jobs that can be used for this hyperparameter tuning job.
Sourcepub fn get_resource_limits(&self) -> &Option<ResourceLimits>
pub fn get_resource_limits(&self) -> &Option<ResourceLimits>
The ResourceLimits object that specifies the maximum number of training and parallel training jobs that can be used for this hyperparameter tuning job.
Sourcepub fn parameter_ranges(self, input: ParameterRanges) -> Self
pub fn parameter_ranges(self, input: ParameterRanges) -> Self
The ParameterRanges object that specifies the ranges of hyperparameters that this tuning job searches over to find the optimal configuration for the highest model performance against your chosen objective metric.
Sourcepub fn set_parameter_ranges(self, input: Option<ParameterRanges>) -> Self
pub fn set_parameter_ranges(self, input: Option<ParameterRanges>) -> Self
The ParameterRanges object that specifies the ranges of hyperparameters that this tuning job searches over to find the optimal configuration for the highest model performance against your chosen objective metric.
Sourcepub fn get_parameter_ranges(&self) -> &Option<ParameterRanges>
pub fn get_parameter_ranges(&self) -> &Option<ParameterRanges>
The ParameterRanges object that specifies the ranges of hyperparameters that this tuning job searches over to find the optimal configuration for the highest model performance against your chosen objective metric.
Sourcepub fn training_job_early_stopping_type(
self,
input: TrainingJobEarlyStoppingType,
) -> Self
pub fn training_job_early_stopping_type( self, input: TrainingJobEarlyStoppingType, ) -> Self
Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job. Because the Hyperband
strategy has its own advanced internal early stopping mechanism, TrainingJobEarlyStoppingType
must be OFF
to use Hyperband
. This parameter can take on one of the following values (the default value is OFF
):
- OFF
-
Training jobs launched by the hyperparameter tuning job do not use early stopping.
- AUTO
-
SageMaker stops training jobs launched by the hyperparameter tuning job when they are unlikely to perform better than previously completed training jobs. For more information, see Stop Training Jobs Early.
Sourcepub fn set_training_job_early_stopping_type(
self,
input: Option<TrainingJobEarlyStoppingType>,
) -> Self
pub fn set_training_job_early_stopping_type( self, input: Option<TrainingJobEarlyStoppingType>, ) -> Self
Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job. Because the Hyperband
strategy has its own advanced internal early stopping mechanism, TrainingJobEarlyStoppingType
must be OFF
to use Hyperband
. This parameter can take on one of the following values (the default value is OFF
):
- OFF
-
Training jobs launched by the hyperparameter tuning job do not use early stopping.
- AUTO
-
SageMaker stops training jobs launched by the hyperparameter tuning job when they are unlikely to perform better than previously completed training jobs. For more information, see Stop Training Jobs Early.
Sourcepub fn get_training_job_early_stopping_type(
&self,
) -> &Option<TrainingJobEarlyStoppingType>
pub fn get_training_job_early_stopping_type( &self, ) -> &Option<TrainingJobEarlyStoppingType>
Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job. Because the Hyperband
strategy has its own advanced internal early stopping mechanism, TrainingJobEarlyStoppingType
must be OFF
to use Hyperband
. This parameter can take on one of the following values (the default value is OFF
):
- OFF
-
Training jobs launched by the hyperparameter tuning job do not use early stopping.
- AUTO
-
SageMaker stops training jobs launched by the hyperparameter tuning job when they are unlikely to perform better than previously completed training jobs. For more information, see Stop Training Jobs Early.
Sourcepub fn tuning_job_completion_criteria(
self,
input: TuningJobCompletionCriteria,
) -> Self
pub fn tuning_job_completion_criteria( self, input: TuningJobCompletionCriteria, ) -> Self
The tuning job's completion criteria.
Sourcepub fn set_tuning_job_completion_criteria(
self,
input: Option<TuningJobCompletionCriteria>,
) -> Self
pub fn set_tuning_job_completion_criteria( self, input: Option<TuningJobCompletionCriteria>, ) -> Self
The tuning job's completion criteria.
Sourcepub fn get_tuning_job_completion_criteria(
&self,
) -> &Option<TuningJobCompletionCriteria>
pub fn get_tuning_job_completion_criteria( &self, ) -> &Option<TuningJobCompletionCriteria>
The tuning job's completion criteria.
Sourcepub fn random_seed(self, input: i32) -> Self
pub fn random_seed(self, input: i32) -> Self
A value used to initialize a pseudo-random number generator. Setting a random seed and using the same seed later for the same tuning job will allow hyperparameter optimization to find more a consistent hyperparameter configuration between the two runs.
Sourcepub fn set_random_seed(self, input: Option<i32>) -> Self
pub fn set_random_seed(self, input: Option<i32>) -> Self
A value used to initialize a pseudo-random number generator. Setting a random seed and using the same seed later for the same tuning job will allow hyperparameter optimization to find more a consistent hyperparameter configuration between the two runs.
Sourcepub fn get_random_seed(&self) -> &Option<i32>
pub fn get_random_seed(&self) -> &Option<i32>
A value used to initialize a pseudo-random number generator. Setting a random seed and using the same seed later for the same tuning job will allow hyperparameter optimization to find more a consistent hyperparameter configuration between the two runs.
Sourcepub fn build(self) -> HyperParameterTuningJobConfig
pub fn build(self) -> HyperParameterTuningJobConfig
Consumes the builder and constructs a HyperParameterTuningJobConfig
.
Trait Implementations§
Source§impl Clone for HyperParameterTuningJobConfigBuilder
impl Clone for HyperParameterTuningJobConfigBuilder
Source§fn clone(&self) -> HyperParameterTuningJobConfigBuilder
fn clone(&self) -> HyperParameterTuningJobConfigBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for HyperParameterTuningJobConfigBuilder
impl Default for HyperParameterTuningJobConfigBuilder
Source§fn default() -> HyperParameterTuningJobConfigBuilder
fn default() -> HyperParameterTuningJobConfigBuilder
Source§impl PartialEq for HyperParameterTuningJobConfigBuilder
impl PartialEq for HyperParameterTuningJobConfigBuilder
Source§fn eq(&self, other: &HyperParameterTuningJobConfigBuilder) -> bool
fn eq(&self, other: &HyperParameterTuningJobConfigBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for HyperParameterTuningJobConfigBuilder
Auto Trait Implementations§
impl Freeze for HyperParameterTuningJobConfigBuilder
impl RefUnwindSafe for HyperParameterTuningJobConfigBuilder
impl Send for HyperParameterTuningJobConfigBuilder
impl Sync for HyperParameterTuningJobConfigBuilder
impl Unpin for HyperParameterTuningJobConfigBuilder
impl UnwindSafe for HyperParameterTuningJobConfigBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);