You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SageMaker::Types::HyperParameterTuningJobConfig

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

Note:

When making an API call, you may pass HyperParameterTuningJobConfig data as a hash:

{
  strategy: "Bayesian", # required, accepts Bayesian, Random
  hyper_parameter_tuning_job_objective: {
    type: "Maximize", # required, accepts Maximize, Minimize
    metric_name: "MetricName", # required
  },
  resource_limits: { # required
    max_number_of_training_jobs: 1, # required
    max_parallel_training_jobs: 1, # required
  },
  parameter_ranges: {
    integer_parameter_ranges: [
      {
        name: "ParameterKey", # required
        min_value: "ParameterValue", # required
        max_value: "ParameterValue", # required
        scaling_type: "Auto", # accepts Auto, Linear, Logarithmic, ReverseLogarithmic
      },
    ],
    continuous_parameter_ranges: [
      {
        name: "ParameterKey", # required
        min_value: "ParameterValue", # required
        max_value: "ParameterValue", # required
        scaling_type: "Auto", # accepts Auto, Linear, Logarithmic, ReverseLogarithmic
      },
    ],
    categorical_parameter_ranges: [
      {
        name: "ParameterKey", # required
        values: ["ParameterValue"], # required
      },
    ],
  },
  training_job_early_stopping_type: "Off", # accepts Off, Auto
}

Configures a hyperparameter tuning job.

Instance Attribute Summary collapse

Instance Attribute Details

#hyper_parameter_tuning_job_objectiveTypes::HyperParameterTuningJobObjective

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



6301
6302
6303
6304
6305
6306
6307
6308
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 6301

class HyperParameterTuningJobConfig < Struct.new(
  :strategy,
  :hyper_parameter_tuning_job_objective,
  :resource_limits,
  :parameter_ranges,
  :training_job_early_stopping_type)
  include Aws::Structure
end

#parameter_rangesTypes::ParameterRanges

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



6301
6302
6303
6304
6305
6306
6307
6308
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 6301

class HyperParameterTuningJobConfig < Struct.new(
  :strategy,
  :hyper_parameter_tuning_job_objective,
  :resource_limits,
  :parameter_ranges,
  :training_job_early_stopping_type)
  include Aws::Structure
end

#resource_limitsTypes::ResourceLimits

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



6301
6302
6303
6304
6305
6306
6307
6308
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 6301

class HyperParameterTuningJobConfig < Struct.new(
  :strategy,
  :hyper_parameter_tuning_job_objective,
  :resource_limits,
  :parameter_ranges,
  :training_job_early_stopping_type)
  include Aws::Structure
end

#strategyString

Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training job it launches. To use the Bayesian search stategy, set this to Bayesian. To randomly search, set it to Random. For information about search strategies, see How Hyperparameter Tuning Works.

Returns:

  • (String)


6301
6302
6303
6304
6305
6306
6307
6308
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 6301

class HyperParameterTuningJobConfig < Struct.new(
  :strategy,
  :hyper_parameter_tuning_job_objective,
  :resource_limits,
  :parameter_ranges,
  :training_job_early_stopping_type)
  include Aws::Structure
end

#training_job_early_stopping_typeString

Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job. This can be 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

Amazon 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.

Returns:

  • (String)


6301
6302
6303
6304
6305
6306
6307
6308
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 6301

class HyperParameterTuningJobConfig < Struct.new(
  :strategy,
  :hyper_parameter_tuning_job_objective,
  :resource_limits,
  :parameter_ranges,
  :training_job_early_stopping_type)
  include Aws::Structure
end