Struct aws_sdk_sagemaker::model::HyperParameterTuningJobConfig

#[non_exhaustive]
pub struct HyperParameterTuningJobConfig { /* private fields */ }

Configures a hyperparameter tuning job.

Implementations

impl HyperParameterTuningJobConfig

pub fn 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.

pub fn 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.

pub fn hyper_parameter_tuning_job_objective(
    &self
) -> Option<&HyperParameterTuningJobObjective>

The HyperParameterTuningJobObjective object that specifies the objective metric for this tuning job.

pub fn resource_limits(&self) -> Option<&ResourceLimits>

The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs for this tuning job.

pub fn parameter_ranges(&self) -> Option<&ParameterRanges>

The ParameterRanges object that specifies the ranges of hyperparameters that this tuning job searches.

pub fn 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.

pub fn tuning_job_completion_criteria(
    &self
) -> Option<&TuningJobCompletionCriteria>

The tuning job's completion criteria.

impl HyperParameterTuningJobConfig

pub fn builder() -> Builder

Creates a new builder-style object to manufacture HyperParameterTuningJobConfig.

Trait Implementations

impl Clone for HyperParameterTuningJobConfig

fn clone(&self) -> HyperParameterTuningJobConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HyperParameterTuningJobConfig

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

Formats the value using the given formatter.

impl PartialEq<HyperParameterTuningJobConfig> for HyperParameterTuningJobConfig

fn eq(&self, other: &HyperParameterTuningJobConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for HyperParameterTuningJobConfig