Class: Aws::SageMaker::Types::AutoMLCandidate

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::AutoMLCandidate

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-sagemaker/types.rb

Overview

Information about a candidate produced by an AutoML training job, including its status, steps, and other properties.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #candidate_name ⇒ String

  The name of the candidate.

• #candidate_properties ⇒ Types::CandidateProperties

  The properties of an AutoML candidate job.

• #candidate_status ⇒ String

  The candidate’s status.

• #candidate_steps ⇒ Array<Types::AutoMLCandidateStep>

  Information about the candidate’s steps.

• #creation_time ⇒ Time

  The creation time.

• #end_time ⇒ Time

  The end time.

• #failure_reason ⇒ String

  The failure reason.

• #final_auto_ml_job_objective_metric ⇒ Types::FinalAutoMLJobObjectiveMetric

  The best candidate result from an AutoML training job.

• #inference_container_definitions ⇒ Hash<String,Array<Types::AutoMLContainerDefinition>>

  The mapping of all supported processing unit (CPU, GPU, etc…) to inference container definitions for the candidate.

• #inference_containers ⇒ Array<Types::AutoMLContainerDefinition>

  Information about the recommended inference container definitions.

• #last_modified_time ⇒ Time

  The last modified time.

• #objective_status ⇒ String

  The objective’s status.

Instance Attribute Details

#candidate_name ⇒ String

The name of the candidate.

Returns:

• (String)

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

class AutoMLCandidate < Struct.new(
  :candidate_name,
  :final_auto_ml_job_objective_metric,
  :objective_status,
  :candidate_steps,
  :candidate_status,
  :inference_containers,
  :creation_time,
  :end_time,
  :last_modified_time,
  :failure_reason,
  :candidate_properties,
  :inference_container_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#candidate_properties ⇒ Types::CandidateProperties

The properties of an AutoML candidate job.

Returns:

• (Types::CandidateProperties)

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

class AutoMLCandidate < Struct.new(
  :candidate_name,
  :final_auto_ml_job_objective_metric,
  :objective_status,
  :candidate_steps,
  :candidate_status,
  :inference_containers,
  :creation_time,
  :end_time,
  :last_modified_time,
  :failure_reason,
  :candidate_properties,
  :inference_container_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#candidate_status ⇒ String

The candidate’s status.

Returns:

• (String)

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

class AutoMLCandidate < Struct.new(
  :candidate_name,
  :final_auto_ml_job_objective_metric,
  :objective_status,
  :candidate_steps,
  :candidate_status,
  :inference_containers,
  :creation_time,
  :end_time,
  :last_modified_time,
  :failure_reason,
  :candidate_properties,
  :inference_container_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#candidate_steps ⇒ Array<Types::AutoMLCandidateStep>

Information about the candidate’s steps.

Returns:

• (Array<Types::AutoMLCandidateStep>)

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

class AutoMLCandidate < Struct.new(
  :candidate_name,
  :final_auto_ml_job_objective_metric,
  :objective_status,
  :candidate_steps,
  :candidate_status,
  :inference_containers,
  :creation_time,
  :end_time,
  :last_modified_time,
  :failure_reason,
  :candidate_properties,
  :inference_container_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

The creation time.

Returns:

• (Time)

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

class AutoMLCandidate < Struct.new(
  :candidate_name,
  :final_auto_ml_job_objective_metric,
  :objective_status,
  :candidate_steps,
  :candidate_status,
  :inference_containers,
  :creation_time,
  :end_time,
  :last_modified_time,
  :failure_reason,
  :candidate_properties,
  :inference_container_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

The end time.

Returns:

• (Time)

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

class AutoMLCandidate < Struct.new(
  :candidate_name,
  :final_auto_ml_job_objective_metric,
  :objective_status,
  :candidate_steps,
  :candidate_status,
  :inference_containers,
  :creation_time,
  :end_time,
  :last_modified_time,
  :failure_reason,
  :candidate_properties,
  :inference_container_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reason ⇒ String

The failure reason.

Returns:

• (String)

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

class AutoMLCandidate < Struct.new(
  :candidate_name,
  :final_auto_ml_job_objective_metric,
  :objective_status,
  :candidate_steps,
  :candidate_status,
  :inference_containers,
  :creation_time,
  :end_time,
  :last_modified_time,
  :failure_reason,
  :candidate_properties,
  :inference_container_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#final_auto_ml_job_objective_metric ⇒ Types::FinalAutoMLJobObjectiveMetric

The best candidate result from an AutoML training job.

Returns:

• (Types::FinalAutoMLJobObjectiveMetric)

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

class AutoMLCandidate < Struct.new(
  :candidate_name,
  :final_auto_ml_job_objective_metric,
  :objective_status,
  :candidate_steps,
  :candidate_status,
  :inference_containers,
  :creation_time,
  :end_time,
  :last_modified_time,
  :failure_reason,
  :candidate_properties,
  :inference_container_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#inference_container_definitions ⇒ Hash<String,Array<Types::AutoMLContainerDefinition>>

The mapping of all supported processing unit (CPU, GPU, etc…) to inference container definitions for the candidate. This field is populated for the AutoML jobs V2 (for example, for jobs created by calling ‘CreateAutoMLJobV2`) related to image or text classification problem types only.

Returns:

• (Hash<String,Array<Types::AutoMLContainerDefinition>>)

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

class AutoMLCandidate < Struct.new(
  :candidate_name,
  :final_auto_ml_job_objective_metric,
  :objective_status,
  :candidate_steps,
  :candidate_status,
  :inference_containers,
  :creation_time,
  :end_time,
  :last_modified_time,
  :failure_reason,
  :candidate_properties,
  :inference_container_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#inference_containers ⇒ Array<Types::AutoMLContainerDefinition>

Information about the recommended inference container definitions.

Returns:

• (Array<Types::AutoMLContainerDefinition>)

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

class AutoMLCandidate < Struct.new(
  :candidate_name,
  :final_auto_ml_job_objective_metric,
  :objective_status,
  :candidate_steps,
  :candidate_status,
  :inference_containers,
  :creation_time,
  :end_time,
  :last_modified_time,
  :failure_reason,
  :candidate_properties,
  :inference_container_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_time ⇒ Time

The last modified time.

Returns:

• (Time)

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

class AutoMLCandidate < Struct.new(
  :candidate_name,
  :final_auto_ml_job_objective_metric,
  :objective_status,
  :candidate_steps,
  :candidate_status,
  :inference_containers,
  :creation_time,
  :end_time,
  :last_modified_time,
  :failure_reason,
  :candidate_properties,
  :inference_container_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#objective_status ⇒ String

The objective’s status.

Returns:

• (String)

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

class AutoMLCandidate < Struct.new(
  :candidate_name,
  :final_auto_ml_job_objective_metric,
  :objective_status,
  :candidate_steps,
  :candidate_status,
  :inference_containers,
  :creation_time,
  :end_time,
  :last_modified_time,
  :failure_reason,
  :candidate_properties,
  :inference_container_definitions)
  SENSITIVE = []
  include Aws::Structure
end