aws_sdk_sagemaker/client/

create_hyper_parameter_tuning_job.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateHyperParameterTuningJob`](crate::operation::create_hyper_parameter_tuning_job::builders::CreateHyperParameterTuningJobFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`hyper_parameter_tuning_job_name(impl Into<String>)`](crate::operation::create_hyper_parameter_tuning_job::builders::CreateHyperParameterTuningJobFluentBuilder::hyper_parameter_tuning_job_name) / [`set_hyper_parameter_tuning_job_name(Option<String>)`](crate::operation::create_hyper_parameter_tuning_job::builders::CreateHyperParameterTuningJobFluentBuilder::set_hyper_parameter_tuning_job_name):<br>required: **true**<br><p>The name of the tuning job. This name is the prefix for the names of all training jobs that this tuning job launches. The name must be unique within the same Amazon Web Services account and Amazon Web Services Region. The name must have 1 to 32 characters. Valid characters are a-z, A-Z, 0-9, and : + = @ _ % - (hyphen). The name is not case sensitive.</p><br>
    ///   - [`hyper_parameter_tuning_job_config(HyperParameterTuningJobConfig)`](crate::operation::create_hyper_parameter_tuning_job::builders::CreateHyperParameterTuningJobFluentBuilder::hyper_parameter_tuning_job_config) / [`set_hyper_parameter_tuning_job_config(Option<HyperParameterTuningJobConfig>)`](crate::operation::create_hyper_parameter_tuning_job::builders::CreateHyperParameterTuningJobFluentBuilder::set_hyper_parameter_tuning_job_config):<br>required: **true**<br><p>The <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html">HyperParameterTuningJobConfig</a> object that describes the tuning job, including the search strategy, the objective metric used to evaluate training jobs, ranges of parameters to search, and resource limits for the tuning job. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-how-it-works.html">How Hyperparameter Tuning Works</a>.</p><br>
    ///   - [`training_job_definition(HyperParameterTrainingJobDefinition)`](crate::operation::create_hyper_parameter_tuning_job::builders::CreateHyperParameterTuningJobFluentBuilder::training_job_definition) / [`set_training_job_definition(Option<HyperParameterTrainingJobDefinition>)`](crate::operation::create_hyper_parameter_tuning_job::builders::CreateHyperParameterTuningJobFluentBuilder::set_training_job_definition):<br>required: **false**<br><p>The <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html">HyperParameterTrainingJobDefinition</a> object that describes the training jobs that this tuning job launches, including static hyperparameters, input data configuration, output data configuration, resource configuration, and stopping condition.</p><br>
    ///   - [`training_job_definitions(HyperParameterTrainingJobDefinition)`](crate::operation::create_hyper_parameter_tuning_job::builders::CreateHyperParameterTuningJobFluentBuilder::training_job_definitions) / [`set_training_job_definitions(Option<Vec::<HyperParameterTrainingJobDefinition>>)`](crate::operation::create_hyper_parameter_tuning_job::builders::CreateHyperParameterTuningJobFluentBuilder::set_training_job_definitions):<br>required: **false**<br><p>A list of the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html">HyperParameterTrainingJobDefinition</a> objects launched for this tuning job.</p><br>
    ///   - [`warm_start_config(HyperParameterTuningJobWarmStartConfig)`](crate::operation::create_hyper_parameter_tuning_job::builders::CreateHyperParameterTuningJobFluentBuilder::warm_start_config) / [`set_warm_start_config(Option<HyperParameterTuningJobWarmStartConfig>)`](crate::operation::create_hyper_parameter_tuning_job::builders::CreateHyperParameterTuningJobFluentBuilder::set_warm_start_config):<br>required: **false**<br><p>Specifies the configuration for starting the hyperparameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.</p> <p>All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric. If you specify <code>IDENTICAL_DATA_AND_ALGORITHM</code> as the <code>WarmStartType</code> value for the warm start configuration, the training job that performs the best in the new tuning job is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.</p><note>  <p>All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.</p> </note><br>
    ///   - [`tags(Tag)`](crate::operation::create_hyper_parameter_tuning_job::builders::CreateHyperParameterTuningJobFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_hyper_parameter_tuning_job::builders::CreateHyperParameterTuningJobFluentBuilder::set_tags):<br>required: **false**<br><p>An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.</p> <p>Tags that you specify for the tuning job are also added to all training jobs that the tuning job launches.</p><br>
    ///   - [`autotune(Autotune)`](crate::operation::create_hyper_parameter_tuning_job::builders::CreateHyperParameterTuningJobFluentBuilder::autotune) / [`set_autotune(Option<Autotune>)`](crate::operation::create_hyper_parameter_tuning_job::builders::CreateHyperParameterTuningJobFluentBuilder::set_autotune):<br>required: **false**<br><p>Configures SageMaker Automatic model tuning (AMT) to automatically find optimal parameters for the following fields:</p> <ul>  <li>   <p><a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html#sagemaker-Type-HyperParameterTuningJobConfig-ParameterRanges">ParameterRanges</a>: The names and ranges of parameters that a hyperparameter tuning job can optimize.</p></li>  <li>   <p><a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ResourceLimits.html">ResourceLimits</a>: The maximum resources that can be used for a training job. These resources include the maximum number of training jobs, the maximum runtime of a tuning job, and the maximum number of training jobs to run at the same time.</p></li>  <li>   <p><a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html#sagemaker-Type-HyperParameterTuningJobConfig-TrainingJobEarlyStoppingType">TrainingJobEarlyStoppingType</a>: A flag that specifies whether or not to use early stopping for training jobs launched by a hyperparameter tuning job.</p></li>  <li>   <p><a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html#sagemaker-Type-HyperParameterTrainingJobDefinition-RetryStrategy">RetryStrategy</a>: The number of times to retry a training job.</p></li>  <li>   <p><a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html">Strategy</a>: Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training jobs that it launches.</p></li>  <li>   <p><a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ConvergenceDetected.html">ConvergenceDetected</a>: A flag to indicate that Automatic model tuning (AMT) has detected model convergence.</p></li> </ul><br>
    /// - On success, responds with [`CreateHyperParameterTuningJobOutput`](crate::operation::create_hyper_parameter_tuning_job::CreateHyperParameterTuningJobOutput) with field(s):
    ///   - [`hyper_parameter_tuning_job_arn(Option<String>)`](crate::operation::create_hyper_parameter_tuning_job::CreateHyperParameterTuningJobOutput::hyper_parameter_tuning_job_arn): <p>The Amazon Resource Name (ARN) of the tuning job. SageMaker assigns an ARN to a hyperparameter tuning job when you create it.</p>
    /// - On failure, responds with [`SdkError<CreateHyperParameterTuningJobError>`](crate::operation::create_hyper_parameter_tuning_job::CreateHyperParameterTuningJobError)
    pub fn create_hyper_parameter_tuning_job(
        &self,
    ) -> crate::operation::create_hyper_parameter_tuning_job::builders::CreateHyperParameterTuningJobFluentBuilder {
        crate::operation::create_hyper_parameter_tuning_job::builders::CreateHyperParameterTuningJobFluentBuilder::new(self.handle.clone())
    }
}