Class: Aws::SageMaker::Types::HyperParameterTuningJobSearchEntity

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::HyperParameterTuningJobSearchEntity

Defined in:

gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

An entity returned by the SearchRecord API containing the properties of a hyperparameter tuning job.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #best_training_job ⇒ Types::HyperParameterTrainingJobSummary

  The container for the summary information about a training job.

• #consumed_resources ⇒ Types::HyperParameterTuningJobConsumedResources

  The total amount of resources consumed by a hyperparameter tuning job.

• #creation_time ⇒ Time

  The time that a hyperparameter tuning job was created.

• #failure_reason ⇒ String

  The error that was created when a hyperparameter tuning job failed.

• #hyper_parameter_tuning_end_time ⇒ Time

  The time that a hyperparameter tuning job ended.

• #hyper_parameter_tuning_job_arn ⇒ String

  The Amazon Resource Name (ARN) of a hyperparameter tuning job.

• #hyper_parameter_tuning_job_config ⇒ Types::HyperParameterTuningJobConfig

  Configures a hyperparameter tuning job.

• #hyper_parameter_tuning_job_name ⇒ String

  The name of a hyperparameter tuning job.

• #hyper_parameter_tuning_job_status ⇒ String

  The status of a hyperparameter tuning job.

• #last_modified_time ⇒ Time

  The time that a hyperparameter tuning job was last modified.

• #objective_status_counters ⇒ Types::ObjectiveStatusCounters

  Specifies the number of training jobs that this hyperparameter tuning job launched, categorized by the status of their objective metric.

• #overall_best_training_job ⇒ Types::HyperParameterTrainingJobSummary

  The container for the summary information about a training job.

• #tags ⇒ Array<Types::Tag>

  The tags associated with a hyperparameter tuning job.

• #training_job_definition ⇒ Types::HyperParameterTrainingJobDefinition

  Defines the training jobs launched by a hyperparameter tuning job.

• #training_job_definitions ⇒ Array<Types::HyperParameterTrainingJobDefinition>

  The job definitions included in a hyperparameter tuning job.

• #training_job_status_counters ⇒ Types::TrainingJobStatusCounters

  The numbers of training jobs launched by a hyperparameter tuning job, categorized by status.

• #tuning_job_completion_details ⇒ Types::HyperParameterTuningJobCompletionDetails

  Information about either a current or completed hyperparameter tuning job.

• #warm_start_config ⇒ Types::HyperParameterTuningJobWarmStartConfig

  Specifies the configuration for a hyperparameter tuning job that uses one or more previous hyperparameter tuning jobs as a starting point.

Instance Attribute Details

#best_training_job ⇒ Types::HyperParameterTrainingJobSummary

The container for the summary information about a training job.

Returns:

• (Types::HyperParameterTrainingJobSummary)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27825

class HyperParameterTuningJobSearchEntity < Struct.new(
  :hyper_parameter_tuning_job_name,
  :hyper_parameter_tuning_job_arn,
  :hyper_parameter_tuning_job_config,
  :training_job_definition,
  :training_job_definitions,
  :hyper_parameter_tuning_job_status,
  :creation_time,
  :hyper_parameter_tuning_end_time,
  :last_modified_time,
  :training_job_status_counters,
  :objective_status_counters,
  :best_training_job,
  :overall_best_training_job,
  :warm_start_config,
  :failure_reason,
  :tuning_job_completion_details,
  :consumed_resources,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#consumed_resources ⇒ Types::HyperParameterTuningJobConsumedResources

The total amount of resources consumed by a hyperparameter tuning job.

Returns:

• (Types::HyperParameterTuningJobConsumedResources)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27825

class HyperParameterTuningJobSearchEntity < Struct.new(
  :hyper_parameter_tuning_job_name,
  :hyper_parameter_tuning_job_arn,
  :hyper_parameter_tuning_job_config,
  :training_job_definition,
  :training_job_definitions,
  :hyper_parameter_tuning_job_status,
  :creation_time,
  :hyper_parameter_tuning_end_time,
  :last_modified_time,
  :training_job_status_counters,
  :objective_status_counters,
  :best_training_job,
  :overall_best_training_job,
  :warm_start_config,
  :failure_reason,
  :tuning_job_completion_details,
  :consumed_resources,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

The time that a hyperparameter tuning job was created.

Returns:

• (Time)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27825

class HyperParameterTuningJobSearchEntity < Struct.new(
  :hyper_parameter_tuning_job_name,
  :hyper_parameter_tuning_job_arn,
  :hyper_parameter_tuning_job_config,
  :training_job_definition,
  :training_job_definitions,
  :hyper_parameter_tuning_job_status,
  :creation_time,
  :hyper_parameter_tuning_end_time,
  :last_modified_time,
  :training_job_status_counters,
  :objective_status_counters,
  :best_training_job,
  :overall_best_training_job,
  :warm_start_config,
  :failure_reason,
  :tuning_job_completion_details,
  :consumed_resources,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reason ⇒ String

The error that was created when a hyperparameter tuning job failed.

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27825

class HyperParameterTuningJobSearchEntity < Struct.new(
  :hyper_parameter_tuning_job_name,
  :hyper_parameter_tuning_job_arn,
  :hyper_parameter_tuning_job_config,
  :training_job_definition,
  :training_job_definitions,
  :hyper_parameter_tuning_job_status,
  :creation_time,
  :hyper_parameter_tuning_end_time,
  :last_modified_time,
  :training_job_status_counters,
  :objective_status_counters,
  :best_training_job,
  :overall_best_training_job,
  :warm_start_config,
  :failure_reason,
  :tuning_job_completion_details,
  :consumed_resources,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#hyper_parameter_tuning_end_time ⇒ Time

The time that a hyperparameter tuning job ended.

Returns:

• (Time)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27825

class HyperParameterTuningJobSearchEntity < Struct.new(
  :hyper_parameter_tuning_job_name,
  :hyper_parameter_tuning_job_arn,
  :hyper_parameter_tuning_job_config,
  :training_job_definition,
  :training_job_definitions,
  :hyper_parameter_tuning_job_status,
  :creation_time,
  :hyper_parameter_tuning_end_time,
  :last_modified_time,
  :training_job_status_counters,
  :objective_status_counters,
  :best_training_job,
  :overall_best_training_job,
  :warm_start_config,
  :failure_reason,
  :tuning_job_completion_details,
  :consumed_resources,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#hyper_parameter_tuning_job_arn ⇒ String

The Amazon Resource Name (ARN) of a hyperparameter tuning job.

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27825

class HyperParameterTuningJobSearchEntity < Struct.new(
  :hyper_parameter_tuning_job_name,
  :hyper_parameter_tuning_job_arn,
  :hyper_parameter_tuning_job_config,
  :training_job_definition,
  :training_job_definitions,
  :hyper_parameter_tuning_job_status,
  :creation_time,
  :hyper_parameter_tuning_end_time,
  :last_modified_time,
  :training_job_status_counters,
  :objective_status_counters,
  :best_training_job,
  :overall_best_training_job,
  :warm_start_config,
  :failure_reason,
  :tuning_job_completion_details,
  :consumed_resources,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#hyper_parameter_tuning_job_config ⇒ Types::HyperParameterTuningJobConfig

Configures a hyperparameter tuning job.

Returns:

• (Types::HyperParameterTuningJobConfig)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27825

class HyperParameterTuningJobSearchEntity < Struct.new(
  :hyper_parameter_tuning_job_name,
  :hyper_parameter_tuning_job_arn,
  :hyper_parameter_tuning_job_config,
  :training_job_definition,
  :training_job_definitions,
  :hyper_parameter_tuning_job_status,
  :creation_time,
  :hyper_parameter_tuning_end_time,
  :last_modified_time,
  :training_job_status_counters,
  :objective_status_counters,
  :best_training_job,
  :overall_best_training_job,
  :warm_start_config,
  :failure_reason,
  :tuning_job_completion_details,
  :consumed_resources,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#hyper_parameter_tuning_job_name ⇒ String

The name of a hyperparameter tuning job.

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27825

class HyperParameterTuningJobSearchEntity < Struct.new(
  :hyper_parameter_tuning_job_name,
  :hyper_parameter_tuning_job_arn,
  :hyper_parameter_tuning_job_config,
  :training_job_definition,
  :training_job_definitions,
  :hyper_parameter_tuning_job_status,
  :creation_time,
  :hyper_parameter_tuning_end_time,
  :last_modified_time,
  :training_job_status_counters,
  :objective_status_counters,
  :best_training_job,
  :overall_best_training_job,
  :warm_start_config,
  :failure_reason,
  :tuning_job_completion_details,
  :consumed_resources,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#hyper_parameter_tuning_job_status ⇒ String

The status of a hyperparameter tuning job.

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27825

class HyperParameterTuningJobSearchEntity < Struct.new(
  :hyper_parameter_tuning_job_name,
  :hyper_parameter_tuning_job_arn,
  :hyper_parameter_tuning_job_config,
  :training_job_definition,
  :training_job_definitions,
  :hyper_parameter_tuning_job_status,
  :creation_time,
  :hyper_parameter_tuning_end_time,
  :last_modified_time,
  :training_job_status_counters,
  :objective_status_counters,
  :best_training_job,
  :overall_best_training_job,
  :warm_start_config,
  :failure_reason,
  :tuning_job_completion_details,
  :consumed_resources,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_time ⇒ Time

The time that a hyperparameter tuning job was last modified.

Returns:

• (Time)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27825

class HyperParameterTuningJobSearchEntity < Struct.new(
  :hyper_parameter_tuning_job_name,
  :hyper_parameter_tuning_job_arn,
  :hyper_parameter_tuning_job_config,
  :training_job_definition,
  :training_job_definitions,
  :hyper_parameter_tuning_job_status,
  :creation_time,
  :hyper_parameter_tuning_end_time,
  :last_modified_time,
  :training_job_status_counters,
  :objective_status_counters,
  :best_training_job,
  :overall_best_training_job,
  :warm_start_config,
  :failure_reason,
  :tuning_job_completion_details,
  :consumed_resources,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#objective_status_counters ⇒ Types::ObjectiveStatusCounters

Specifies the number of training jobs that this hyperparameter tuning job launched, categorized by the status of their objective metric. The objective metric status shows whether the final objective metric for the training job has been evaluated by the tuning job and used in the hyperparameter tuning process.

Returns:

• (Types::ObjectiveStatusCounters)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27825

class HyperParameterTuningJobSearchEntity < Struct.new(
  :hyper_parameter_tuning_job_name,
  :hyper_parameter_tuning_job_arn,
  :hyper_parameter_tuning_job_config,
  :training_job_definition,
  :training_job_definitions,
  :hyper_parameter_tuning_job_status,
  :creation_time,
  :hyper_parameter_tuning_end_time,
  :last_modified_time,
  :training_job_status_counters,
  :objective_status_counters,
  :best_training_job,
  :overall_best_training_job,
  :warm_start_config,
  :failure_reason,
  :tuning_job_completion_details,
  :consumed_resources,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#overall_best_training_job ⇒ Types::HyperParameterTrainingJobSummary

The container for the summary information about a training job.

Returns:

• (Types::HyperParameterTrainingJobSummary)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27825

class HyperParameterTuningJobSearchEntity < Struct.new(
  :hyper_parameter_tuning_job_name,
  :hyper_parameter_tuning_job_arn,
  :hyper_parameter_tuning_job_config,
  :training_job_definition,
  :training_job_definitions,
  :hyper_parameter_tuning_job_status,
  :creation_time,
  :hyper_parameter_tuning_end_time,
  :last_modified_time,
  :training_job_status_counters,
  :objective_status_counters,
  :best_training_job,
  :overall_best_training_job,
  :warm_start_config,
  :failure_reason,
  :tuning_job_completion_details,
  :consumed_resources,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27825

class HyperParameterTuningJobSearchEntity < Struct.new(
  :hyper_parameter_tuning_job_name,
  :hyper_parameter_tuning_job_arn,
  :hyper_parameter_tuning_job_config,
  :training_job_definition,
  :training_job_definitions,
  :hyper_parameter_tuning_job_status,
  :creation_time,
  :hyper_parameter_tuning_end_time,
  :last_modified_time,
  :training_job_status_counters,
  :objective_status_counters,
  :best_training_job,
  :overall_best_training_job,
  :warm_start_config,
  :failure_reason,
  :tuning_job_completion_details,
  :consumed_resources,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#training_job_definition ⇒ Types::HyperParameterTrainingJobDefinition

Defines the training jobs launched by a hyperparameter tuning job.

Returns:

• (Types::HyperParameterTrainingJobDefinition)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27825

class HyperParameterTuningJobSearchEntity < Struct.new(
  :hyper_parameter_tuning_job_name,
  :hyper_parameter_tuning_job_arn,
  :hyper_parameter_tuning_job_config,
  :training_job_definition,
  :training_job_definitions,
  :hyper_parameter_tuning_job_status,
  :creation_time,
  :hyper_parameter_tuning_end_time,
  :last_modified_time,
  :training_job_status_counters,
  :objective_status_counters,
  :best_training_job,
  :overall_best_training_job,
  :warm_start_config,
  :failure_reason,
  :tuning_job_completion_details,
  :consumed_resources,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#training_job_definitions ⇒ Array<Types::HyperParameterTrainingJobDefinition>

The job definitions included in a hyperparameter tuning job.

Returns:

• (Array<Types::HyperParameterTrainingJobDefinition>)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27825

class HyperParameterTuningJobSearchEntity < Struct.new(
  :hyper_parameter_tuning_job_name,
  :hyper_parameter_tuning_job_arn,
  :hyper_parameter_tuning_job_config,
  :training_job_definition,
  :training_job_definitions,
  :hyper_parameter_tuning_job_status,
  :creation_time,
  :hyper_parameter_tuning_end_time,
  :last_modified_time,
  :training_job_status_counters,
  :objective_status_counters,
  :best_training_job,
  :overall_best_training_job,
  :warm_start_config,
  :failure_reason,
  :tuning_job_completion_details,
  :consumed_resources,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#training_job_status_counters ⇒ Types::TrainingJobStatusCounters

The numbers of training jobs launched by a hyperparameter tuning job, categorized by status.

Returns:

• (Types::TrainingJobStatusCounters)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27825

class HyperParameterTuningJobSearchEntity < Struct.new(
  :hyper_parameter_tuning_job_name,
  :hyper_parameter_tuning_job_arn,
  :hyper_parameter_tuning_job_config,
  :training_job_definition,
  :training_job_definitions,
  :hyper_parameter_tuning_job_status,
  :creation_time,
  :hyper_parameter_tuning_end_time,
  :last_modified_time,
  :training_job_status_counters,
  :objective_status_counters,
  :best_training_job,
  :overall_best_training_job,
  :warm_start_config,
  :failure_reason,
  :tuning_job_completion_details,
  :consumed_resources,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tuning_job_completion_details ⇒ Types::HyperParameterTuningJobCompletionDetails

Information about either a current or completed hyperparameter tuning job.

Returns:

• (Types::HyperParameterTuningJobCompletionDetails)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27825

class HyperParameterTuningJobSearchEntity < Struct.new(
  :hyper_parameter_tuning_job_name,
  :hyper_parameter_tuning_job_arn,
  :hyper_parameter_tuning_job_config,
  :training_job_definition,
  :training_job_definitions,
  :hyper_parameter_tuning_job_status,
  :creation_time,
  :hyper_parameter_tuning_end_time,
  :last_modified_time,
  :training_job_status_counters,
  :objective_status_counters,
  :best_training_job,
  :overall_best_training_job,
  :warm_start_config,
  :failure_reason,
  :tuning_job_completion_details,
  :consumed_resources,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#warm_start_config ⇒ Types::HyperParameterTuningJobWarmStartConfig

Specifies the configuration for a hyperparameter tuning job that uses one or more previous hyperparameter 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.

All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric, and the training job that performs the best 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.

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.

Returns:

• (Types::HyperParameterTuningJobWarmStartConfig)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27825

class HyperParameterTuningJobSearchEntity < Struct.new(
  :hyper_parameter_tuning_job_name,
  :hyper_parameter_tuning_job_arn,
  :hyper_parameter_tuning_job_config,
  :training_job_definition,
  :training_job_definitions,
  :hyper_parameter_tuning_job_status,
  :creation_time,
  :hyper_parameter_tuning_end_time,
  :last_modified_time,
  :training_job_status_counters,
  :objective_status_counters,
  :best_training_job,
  :overall_best_training_job,
  :warm_start_config,
  :failure_reason,
  :tuning_job_completion_details,
  :consumed_resources,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end