Class: Aws::SageMaker::Types::DescribeHyperParameterTuningJobResponse

Inherits:

Struct

Object
Struct
Aws::SageMaker::Types::DescribeHyperParameterTuningJobResponse

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-sagemaker/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#autotune ⇒ Types::Autotune

A flag to indicate if autotune is enabled for the hyperparameter tuning job.
#best_training_job ⇒ Types::HyperParameterTrainingJobSummary

A [TrainingJobSummary] object that describes the training job that completed with the best current [HyperParameterTuningJobObjective].
#consumed_resources ⇒ Types::HyperParameterTuningJobConsumedResources

The total resources consumed by your hyperparameter tuning job.
#creation_time ⇒ Time

The date and time that the tuning job started.
#failure_reason ⇒ String

If the tuning job failed, the reason it failed.
#hyper_parameter_tuning_end_time ⇒ Time

The date and time that the tuning job ended.
#hyper_parameter_tuning_job_arn ⇒ String

The Amazon Resource Name (ARN) of the tuning job.
#hyper_parameter_tuning_job_config ⇒ Types::HyperParameterTuningJobConfig

The [HyperParameterTuningJobConfig] object that specifies the configuration of the tuning job.
#hyper_parameter_tuning_job_name ⇒ String

The name of the hyperparameter tuning job.
#hyper_parameter_tuning_job_status ⇒ String

The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.
#last_modified_time ⇒ Time

The date and time that the status of the tuning job was modified.
#objective_status_counters ⇒ Types::ObjectiveStatusCounters

The [ObjectiveStatusCounters] object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.
#overall_best_training_job ⇒ Types::HyperParameterTrainingJobSummary

If the hyperparameter tuning job is an warm start tuning job with a ‘WarmStartType` of `IDENTICAL_DATA_AND_ALGORITHM`, this is the [TrainingJobSummary] for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.
#training_job_definition ⇒ Types::HyperParameterTrainingJobDefinition

The [HyperParameterTrainingJobDefinition] object that specifies the definition of the training jobs that this tuning job launches.
#training_job_definitions ⇒ Array<Types::HyperParameterTrainingJobDefinition>

A list of the [HyperParameterTrainingJobDefinition] objects launched for this tuning job.
#training_job_status_counters ⇒ Types::TrainingJobStatusCounters

The [TrainingJobStatusCounters] object that specifies the number of training jobs, categorized by status, that this tuning job launched.
#tuning_job_completion_details ⇒ Types::HyperParameterTuningJobCompletionDetails

Tuning job completion information returned as the response from a hyperparameter tuning job.
#warm_start_config ⇒ Types::HyperParameterTuningJobWarmStartConfig

The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point.

Instance Attribute Details

#autotune ⇒ `Types::Autotune`

A flag to indicate if autotune is enabled for the hyperparameter tuning job.

Returns:

(Types::Autotune)

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

class DescribeHyperParameterTuningJobResponse < 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,
  :autotune)
  SENSITIVE = []
  include Aws::Structure
end

#best_training_job ⇒ `Types::HyperParameterTrainingJobSummary`

A [TrainingJobSummary] object that describes the training job that completed with the best current [HyperParameterTuningJobObjective].

[1]: docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html [2]: docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobObjective.html

Returns:

(Types::HyperParameterTrainingJobSummary)

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

class DescribeHyperParameterTuningJobResponse < 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,
  :autotune)
  SENSITIVE = []
  include Aws::Structure
end

#consumed_resources ⇒ `Types::HyperParameterTuningJobConsumedResources`

The total resources consumed by your hyperparameter tuning job.

Returns:

(Types::HyperParameterTuningJobConsumedResources)

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

class DescribeHyperParameterTuningJobResponse < 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,
  :autotune)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ `Time`

The date and time that the tuning job started.

Returns:

(Time)

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

class DescribeHyperParameterTuningJobResponse < 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,
  :autotune)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reason ⇒ `String`

If the tuning job failed, the reason it failed.

Returns:

(String)

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

class DescribeHyperParameterTuningJobResponse < 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,
  :autotune)
  SENSITIVE = []
  include Aws::Structure
end

#hyper_parameter_tuning_end_time ⇒ `Time`

The date and time that the tuning job ended.

Returns:

(Time)

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

class DescribeHyperParameterTuningJobResponse < 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,
  :autotune)
  SENSITIVE = []
  include Aws::Structure
end

#hyper_parameter_tuning_job_arn ⇒ `String`

The Amazon Resource Name (ARN) of the tuning job.

Returns:

(String)

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

class DescribeHyperParameterTuningJobResponse < 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,
  :autotune)
  SENSITIVE = []
  include Aws::Structure
end

#hyper_parameter_tuning_job_config ⇒ `Types::HyperParameterTuningJobConfig`

The [HyperParameterTuningJobConfig] object that specifies the configuration of the tuning job.

[1]: docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html

Returns:

(Types::HyperParameterTuningJobConfig)

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

class DescribeHyperParameterTuningJobResponse < 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,
  :autotune)
  SENSITIVE = []
  include Aws::Structure
end

#hyper_parameter_tuning_job_name ⇒ `String`

The name of the hyperparameter tuning job.

Returns:

(String)

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

class DescribeHyperParameterTuningJobResponse < 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,
  :autotune)
  SENSITIVE = []
  include Aws::Structure
end

#hyper_parameter_tuning_job_status ⇒ `String`

The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.

Returns:

(String)

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

class DescribeHyperParameterTuningJobResponse < 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,
  :autotune)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_time ⇒ `Time`

The date and time that the status of the tuning job was modified.

Returns:

(Time)

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

class DescribeHyperParameterTuningJobResponse < 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,
  :autotune)
  SENSITIVE = []
  include Aws::Structure
end

#objective_status_counters ⇒ `Types::ObjectiveStatusCounters`

The [ObjectiveStatusCounters] object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.

[1]: docs.aws.amazon.com/sagemaker/latest/APIReference/API_ObjectiveStatusCounters.html

Returns:

(Types::ObjectiveStatusCounters)

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

class DescribeHyperParameterTuningJobResponse < 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,
  :autotune)
  SENSITIVE = []
  include Aws::Structure
end

#overall_best_training_job ⇒ `Types::HyperParameterTrainingJobSummary`

If the hyperparameter tuning job is an warm start tuning job with a ‘WarmStartType` of `IDENTICAL_DATA_AND_ALGORITHM`, this is the

TrainingJobSummary][1: for the training job with the best objective

metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.

[1]: docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html

Returns:

(Types::HyperParameterTrainingJobSummary)

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

class DescribeHyperParameterTuningJobResponse < 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,
  :autotune)
  SENSITIVE = []
  include Aws::Structure
end

#training_job_definition ⇒ `Types::HyperParameterTrainingJobDefinition`

The [HyperParameterTrainingJobDefinition] object that specifies the definition of the training jobs that this tuning job launches.

[1]: docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html

Returns:

(Types::HyperParameterTrainingJobDefinition)

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

class DescribeHyperParameterTuningJobResponse < 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,
  :autotune)
  SENSITIVE = []
  include Aws::Structure
end

#training_job_definitions ⇒ `Array<Types::HyperParameterTrainingJobDefinition>`

A list of the [HyperParameterTrainingJobDefinition] objects launched for this tuning job.

[1]: docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html

Returns:

(Array<Types::HyperParameterTrainingJobDefinition>)

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

class DescribeHyperParameterTuningJobResponse < 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,
  :autotune)
  SENSITIVE = []
  include Aws::Structure
end

#training_job_status_counters ⇒ `Types::TrainingJobStatusCounters`

The [TrainingJobStatusCounters] object that specifies the number of training jobs, categorized by status, that this tuning job launched.

[1]: docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobStatusCounters.html

Returns:

(Types::TrainingJobStatusCounters)

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

class DescribeHyperParameterTuningJobResponse < 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,
  :autotune)
  SENSITIVE = []
  include Aws::Structure
end

#tuning_job_completion_details ⇒ `Types::HyperParameterTuningJobCompletionDetails`

Tuning job completion information returned as the response from a hyperparameter tuning job. This information tells if your tuning job has or has not converged. It also includes the number of training jobs that have not improved model performance as evaluated against the objective function.

Returns:

(Types::HyperParameterTuningJobCompletionDetails)

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

class DescribeHyperParameterTuningJobResponse < 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,
  :autotune)
  SENSITIVE = []
  include Aws::Structure
end

#warm_start_config ⇒ `Types::HyperParameterTuningJobWarmStartConfig`

The configuration for starting the hyperparameter parameter 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.

Returns:

(Types::HyperParameterTuningJobWarmStartConfig)

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

class DescribeHyperParameterTuningJobResponse < 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,
  :autotune)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::SageMaker::Types::DescribeHyperParameterTuningJobResponse

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#autotune ⇒ Types::Autotune

#best_training_job ⇒ Types::HyperParameterTrainingJobSummary

#consumed_resources ⇒ Types::HyperParameterTuningJobConsumedResources

#creation_time ⇒ Time

#failure_reason ⇒ String

#hyper_parameter_tuning_end_time ⇒ Time

#hyper_parameter_tuning_job_arn ⇒ String

#hyper_parameter_tuning_job_config ⇒ Types::HyperParameterTuningJobConfig

#hyper_parameter_tuning_job_name ⇒ String

#hyper_parameter_tuning_job_status ⇒ String

#last_modified_time ⇒ Time

#objective_status_counters ⇒ Types::ObjectiveStatusCounters

#overall_best_training_job ⇒ Types::HyperParameterTrainingJobSummary

#training_job_definition ⇒ Types::HyperParameterTrainingJobDefinition

#training_job_definitions ⇒ Array<Types::HyperParameterTrainingJobDefinition>

#training_job_status_counters ⇒ Types::TrainingJobStatusCounters

#tuning_job_completion_details ⇒ Types::HyperParameterTuningJobCompletionDetails

#warm_start_config ⇒ Types::HyperParameterTuningJobWarmStartConfig

#autotune ⇒ `Types::Autotune`

#best_training_job ⇒ `Types::HyperParameterTrainingJobSummary`

#consumed_resources ⇒ `Types::HyperParameterTuningJobConsumedResources`

#creation_time ⇒ `Time`

#failure_reason ⇒ `String`

#hyper_parameter_tuning_end_time ⇒ `Time`

#hyper_parameter_tuning_job_arn ⇒ `String`

#hyper_parameter_tuning_job_config ⇒ `Types::HyperParameterTuningJobConfig`

#hyper_parameter_tuning_job_name ⇒ `String`

#hyper_parameter_tuning_job_status ⇒ `String`

#last_modified_time ⇒ `Time`

#objective_status_counters ⇒ `Types::ObjectiveStatusCounters`

#overall_best_training_job ⇒ `Types::HyperParameterTrainingJobSummary`

#training_job_definition ⇒ `Types::HyperParameterTrainingJobDefinition`

#training_job_definitions ⇒ `Array<Types::HyperParameterTrainingJobDefinition>`

#training_job_status_counters ⇒ `Types::TrainingJobStatusCounters`

#tuning_job_completion_details ⇒ `Types::HyperParameterTuningJobCompletionDetails`

#warm_start_config ⇒ `Types::HyperParameterTuningJobWarmStartConfig`