Class: Aws::LookoutforVision::Types::ModelDescription

Inherits:

Struct

• Object
• Struct
• Aws::LookoutforVision::Types::ModelDescription

Defined in:

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

Overview

Describes an Amazon Lookout for Vision model.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #creation_timestamp ⇒ Time

  The unix timestamp for the date and time that the model was created.

• #description ⇒ String

  The description for the model.

• #evaluation_end_timestamp ⇒ Time

  The unix timestamp for the date and time that the evaluation ended.

• #evaluation_manifest ⇒ Types::OutputS3Object

  The S3 location where Amazon Lookout for Vision saves the manifest file that was used to test the trained model and generate the performance scores.

• #evaluation_result ⇒ Types::OutputS3Object

  The S3 location where Amazon Lookout for Vision saves the performance metrics.

• #kms_key_id ⇒ String

  The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during training.

• #max_inference_units ⇒ Integer

  The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model.

• #min_inference_units ⇒ Integer

  The minimum number of inference units used by the model.

• #model_arn ⇒ String

  The Amazon Resource Name (ARN) of the model.

• #model_version ⇒ String

  The version of the model.

• #output_config ⇒ Types::OutputConfig

  The S3 location where Amazon Lookout for Vision saves model training files.

• #performance ⇒ Types::ModelPerformance

  Performance metrics for the model.

• #status ⇒ String

  The status of the model.

• #status_message ⇒ String

  The status message for the model.

Instance Attribute Details

#creation_timestamp ⇒ Time

The unix timestamp for the date and time that the model was created.

Returns:

• (Time)

# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 1233

class ModelDescription < Struct.new(
  :model_version,
  :model_arn,
  :creation_timestamp,
  :description,
  :status,
  :status_message,
  :performance,
  :output_config,
  :evaluation_manifest,
  :evaluation_result,
  :evaluation_end_timestamp,
  :kms_key_id,
  :min_inference_units,
  :max_inference_units)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description for the model.

Returns:

• (String)

# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 1233

class ModelDescription < Struct.new(
  :model_version,
  :model_arn,
  :creation_timestamp,
  :description,
  :status,
  :status_message,
  :performance,
  :output_config,
  :evaluation_manifest,
  :evaluation_result,
  :evaluation_end_timestamp,
  :kms_key_id,
  :min_inference_units,
  :max_inference_units)
  SENSITIVE = []
  include Aws::Structure
end

#evaluation_end_timestamp ⇒ Time

The unix timestamp for the date and time that the evaluation ended.

Returns:

• (Time)

# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 1233

class ModelDescription < Struct.new(
  :model_version,
  :model_arn,
  :creation_timestamp,
  :description,
  :status,
  :status_message,
  :performance,
  :output_config,
  :evaluation_manifest,
  :evaluation_result,
  :evaluation_end_timestamp,
  :kms_key_id,
  :min_inference_units,
  :max_inference_units)
  SENSITIVE = []
  include Aws::Structure
end

#evaluation_manifest ⇒ Types::OutputS3Object

The S3 location where Amazon Lookout for Vision saves the manifest file that was used to test the trained model and generate the performance scores.

Returns:

• (Types::OutputS3Object)

# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 1233

class ModelDescription < Struct.new(
  :model_version,
  :model_arn,
  :creation_timestamp,
  :description,
  :status,
  :status_message,
  :performance,
  :output_config,
  :evaluation_manifest,
  :evaluation_result,
  :evaluation_end_timestamp,
  :kms_key_id,
  :min_inference_units,
  :max_inference_units)
  SENSITIVE = []
  include Aws::Structure
end

#evaluation_result ⇒ Types::OutputS3Object

The S3 location where Amazon Lookout for Vision saves the performance metrics.

Returns:

• (Types::OutputS3Object)

# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 1233

class ModelDescription < Struct.new(
  :model_version,
  :model_arn,
  :creation_timestamp,
  :description,
  :status,
  :status_message,
  :performance,
  :output_config,
  :evaluation_manifest,
  :evaluation_result,
  :evaluation_end_timestamp,
  :kms_key_id,
  :min_inference_units,
  :max_inference_units)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during training.

Returns:

• (String)

# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 1233

class ModelDescription < Struct.new(
  :model_version,
  :model_arn,
  :creation_timestamp,
  :description,
  :status,
  :status_message,
  :performance,
  :output_config,
  :evaluation_manifest,
  :evaluation_result,
  :evaluation_end_timestamp,
  :kms_key_id,
  :min_inference_units,
  :max_inference_units)
  SENSITIVE = []
  include Aws::Structure
end

#max_inference_units ⇒ Integer

The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model. For more information, see StartModel.

Returns:

• (Integer)

# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 1233

class ModelDescription < Struct.new(
  :model_version,
  :model_arn,
  :creation_timestamp,
  :description,
  :status,
  :status_message,
  :performance,
  :output_config,
  :evaluation_manifest,
  :evaluation_result,
  :evaluation_end_timestamp,
  :kms_key_id,
  :min_inference_units,
  :max_inference_units)
  SENSITIVE = []
  include Aws::Structure
end

#min_inference_units ⇒ Integer

The minimum number of inference units used by the model. For more information, see StartModel

Returns:

• (Integer)

# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 1233

class ModelDescription < Struct.new(
  :model_version,
  :model_arn,
  :creation_timestamp,
  :description,
  :status,
  :status_message,
  :performance,
  :output_config,
  :evaluation_manifest,
  :evaluation_result,
  :evaluation_end_timestamp,
  :kms_key_id,
  :min_inference_units,
  :max_inference_units)
  SENSITIVE = []
  include Aws::Structure
end

#model_arn ⇒ String

The Amazon Resource Name (ARN) of the model.

Returns:

• (String)

# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 1233

class ModelDescription < Struct.new(
  :model_version,
  :model_arn,
  :creation_timestamp,
  :description,
  :status,
  :status_message,
  :performance,
  :output_config,
  :evaluation_manifest,
  :evaluation_result,
  :evaluation_end_timestamp,
  :kms_key_id,
  :min_inference_units,
  :max_inference_units)
  SENSITIVE = []
  include Aws::Structure
end

#model_version ⇒ String

The version of the model

Returns:

• (String)

# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 1233

class ModelDescription < Struct.new(
  :model_version,
  :model_arn,
  :creation_timestamp,
  :description,
  :status,
  :status_message,
  :performance,
  :output_config,
  :evaluation_manifest,
  :evaluation_result,
  :evaluation_end_timestamp,
  :kms_key_id,
  :min_inference_units,
  :max_inference_units)
  SENSITIVE = []
  include Aws::Structure
end

#output_config ⇒ Types::OutputConfig

The S3 location where Amazon Lookout for Vision saves model training files.

Returns:

• (Types::OutputConfig)

# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 1233

class ModelDescription < Struct.new(
  :model_version,
  :model_arn,
  :creation_timestamp,
  :description,
  :status,
  :status_message,
  :performance,
  :output_config,
  :evaluation_manifest,
  :evaluation_result,
  :evaluation_end_timestamp,
  :kms_key_id,
  :min_inference_units,
  :max_inference_units)
  SENSITIVE = []
  include Aws::Structure
end

#performance ⇒ Types::ModelPerformance

Performance metrics for the model. Created during training.

Returns:

• (Types::ModelPerformance)

# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 1233

class ModelDescription < Struct.new(
  :model_version,
  :model_arn,
  :creation_timestamp,
  :description,
  :status,
  :status_message,
  :performance,
  :output_config,
  :evaluation_manifest,
  :evaluation_result,
  :evaluation_end_timestamp,
  :kms_key_id,
  :min_inference_units,
  :max_inference_units)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the model.

Returns:

• (String)

# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 1233

class ModelDescription < Struct.new(
  :model_version,
  :model_arn,
  :creation_timestamp,
  :description,
  :status,
  :status_message,
  :performance,
  :output_config,
  :evaluation_manifest,
  :evaluation_result,
  :evaluation_end_timestamp,
  :kms_key_id,
  :min_inference_units,
  :max_inference_units)
  SENSITIVE = []
  include Aws::Structure
end

#status_message ⇒ String

The status message for the model.

Returns:

• (String)

# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 1233

class ModelDescription < Struct.new(
  :model_version,
  :model_arn,
  :creation_timestamp,
  :description,
  :status,
  :status_message,
  :performance,
  :output_config,
  :evaluation_manifest,
  :evaluation_result,
  :evaluation_end_timestamp,
  :kms_key_id,
  :min_inference_units,
  :max_inference_units)
  SENSITIVE = []
  include Aws::Structure
end