Class: Aws::LookoutEquipment::Types::ModelSummary

Inherits:

Struct

• Object
• Struct
• Aws::LookoutEquipment::Types::ModelSummary

Includes:

Structure

Defined in:

lib/aws-sdk-lookoutequipment/types.rb

Overview

Provides information about the specified machine learning model, including dataset and model names and ARNs, as well as status.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #active_model_version ⇒ Integer

  The model version that the inference scheduler uses to run an inference execution.

• #active_model_version_arn ⇒ String

  The Amazon Resource Name (ARN) of the model version that is set as active.

• #created_at ⇒ Time

  The time at which the specific model was created.

• #dataset_arn ⇒ String

  The Amazon Resource Name (ARN) of the dataset used to create the model.

• #dataset_name ⇒ String

  The name of the dataset being used for the machine learning model.

• #latest_scheduled_retraining_model_version ⇒ Integer

  Indicates the most recent model version that was generated by retraining.

• #latest_scheduled_retraining_start_time ⇒ Time

  Indicates the start time of the most recent scheduled retraining run.

• #latest_scheduled_retraining_status ⇒ String

  Indicates the status of the most recent scheduled retraining run.

• #model_arn ⇒ String

  The Amazon Resource Name (ARN) of the machine learning model.

• #model_diagnostics_output_configuration ⇒ Types::ModelDiagnosticsOutputConfiguration

  Output configuration information for the pointwise model diagnostics for an Amazon Lookout for Equipment model.

• #model_name ⇒ String

  The name of the machine learning model.

• #model_quality ⇒ String

  Provides a quality assessment for a model that uses labels.

• #next_scheduled_retraining_start_date ⇒ Time

  Indicates the date that the next scheduled retraining run will start on.

• #retraining_scheduler_status ⇒ String

  Indicates the status of the retraining scheduler.

• #status ⇒ String

  Indicates the status of the machine learning model.

Instance Attribute Details

#active_model_version ⇒ Integer

The model version that the inference scheduler uses to run an inference execution.

Returns:

• (Integer)

# File 'lib/aws-sdk-lookoutequipment/types.rb', line 3636

class ModelSummary < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :status,
  :created_at,
  :active_model_version,
  :active_model_version_arn,
  :latest_scheduled_retraining_status,
  :latest_scheduled_retraining_model_version,
  :latest_scheduled_retraining_start_time,
  :next_scheduled_retraining_start_date,
  :retraining_scheduler_status,
  :model_diagnostics_output_configuration,
  :model_quality)
  SENSITIVE = []
  include Aws::Structure
end

#active_model_version_arn ⇒ String

The Amazon Resource Name (ARN) of the model version that is set as active. The active model version is the model version that the inference scheduler uses to run an inference execution.

Returns:

• (String)

# File 'lib/aws-sdk-lookoutequipment/types.rb', line 3636

class ModelSummary < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :status,
  :created_at,
  :active_model_version,
  :active_model_version_arn,
  :latest_scheduled_retraining_status,
  :latest_scheduled_retraining_model_version,
  :latest_scheduled_retraining_start_time,
  :next_scheduled_retraining_start_date,
  :retraining_scheduler_status,
  :model_diagnostics_output_configuration,
  :model_quality)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The time at which the specific model was created.

Returns:

• (Time)

# File 'lib/aws-sdk-lookoutequipment/types.rb', line 3636

class ModelSummary < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :status,
  :created_at,
  :active_model_version,
  :active_model_version_arn,
  :latest_scheduled_retraining_status,
  :latest_scheduled_retraining_model_version,
  :latest_scheduled_retraining_start_time,
  :next_scheduled_retraining_start_date,
  :retraining_scheduler_status,
  :model_diagnostics_output_configuration,
  :model_quality)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_arn ⇒ String

The Amazon Resource Name (ARN) of the dataset used to create the model.

Returns:

• (String)

# File 'lib/aws-sdk-lookoutequipment/types.rb', line 3636

class ModelSummary < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :status,
  :created_at,
  :active_model_version,
  :active_model_version_arn,
  :latest_scheduled_retraining_status,
  :latest_scheduled_retraining_model_version,
  :latest_scheduled_retraining_start_time,
  :next_scheduled_retraining_start_date,
  :retraining_scheduler_status,
  :model_diagnostics_output_configuration,
  :model_quality)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_name ⇒ String

The name of the dataset being used for the machine learning model.

Returns:

• (String)

# File 'lib/aws-sdk-lookoutequipment/types.rb', line 3636

class ModelSummary < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :status,
  :created_at,
  :active_model_version,
  :active_model_version_arn,
  :latest_scheduled_retraining_status,
  :latest_scheduled_retraining_model_version,
  :latest_scheduled_retraining_start_time,
  :next_scheduled_retraining_start_date,
  :retraining_scheduler_status,
  :model_diagnostics_output_configuration,
  :model_quality)
  SENSITIVE = []
  include Aws::Structure
end

#latest_scheduled_retraining_model_version ⇒ Integer

Indicates the most recent model version that was generated by retraining.

Returns:

• (Integer)

# File 'lib/aws-sdk-lookoutequipment/types.rb', line 3636

class ModelSummary < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :status,
  :created_at,
  :active_model_version,
  :active_model_version_arn,
  :latest_scheduled_retraining_status,
  :latest_scheduled_retraining_model_version,
  :latest_scheduled_retraining_start_time,
  :next_scheduled_retraining_start_date,
  :retraining_scheduler_status,
  :model_diagnostics_output_configuration,
  :model_quality)
  SENSITIVE = []
  include Aws::Structure
end

#latest_scheduled_retraining_start_time ⇒ Time

Indicates the start time of the most recent scheduled retraining run.

Returns:

• (Time)

# File 'lib/aws-sdk-lookoutequipment/types.rb', line 3636

class ModelSummary < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :status,
  :created_at,
  :active_model_version,
  :active_model_version_arn,
  :latest_scheduled_retraining_status,
  :latest_scheduled_retraining_model_version,
  :latest_scheduled_retraining_start_time,
  :next_scheduled_retraining_start_date,
  :retraining_scheduler_status,
  :model_diagnostics_output_configuration,
  :model_quality)
  SENSITIVE = []
  include Aws::Structure
end

#latest_scheduled_retraining_status ⇒ String

Indicates the status of the most recent scheduled retraining run.

Returns:

• (String)

# File 'lib/aws-sdk-lookoutequipment/types.rb', line 3636

class ModelSummary < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :status,
  :created_at,
  :active_model_version,
  :active_model_version_arn,
  :latest_scheduled_retraining_status,
  :latest_scheduled_retraining_model_version,
  :latest_scheduled_retraining_start_time,
  :next_scheduled_retraining_start_date,
  :retraining_scheduler_status,
  :model_diagnostics_output_configuration,
  :model_quality)
  SENSITIVE = []
  include Aws::Structure
end

#model_arn ⇒ String

The Amazon Resource Name (ARN) of the machine learning model.

Returns:

• (String)

# File 'lib/aws-sdk-lookoutequipment/types.rb', line 3636

class ModelSummary < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :status,
  :created_at,
  :active_model_version,
  :active_model_version_arn,
  :latest_scheduled_retraining_status,
  :latest_scheduled_retraining_model_version,
  :latest_scheduled_retraining_start_time,
  :next_scheduled_retraining_start_date,
  :retraining_scheduler_status,
  :model_diagnostics_output_configuration,
  :model_quality)
  SENSITIVE = []
  include Aws::Structure
end

#model_diagnostics_output_configuration ⇒ Types::ModelDiagnosticsOutputConfiguration

Output configuration information for the pointwise model diagnostics for an Amazon Lookout for Equipment model.

Returns:

• (Types::ModelDiagnosticsOutputConfiguration)

# File 'lib/aws-sdk-lookoutequipment/types.rb', line 3636

class ModelSummary < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :status,
  :created_at,
  :active_model_version,
  :active_model_version_arn,
  :latest_scheduled_retraining_status,
  :latest_scheduled_retraining_model_version,
  :latest_scheduled_retraining_start_time,
  :next_scheduled_retraining_start_date,
  :retraining_scheduler_status,
  :model_diagnostics_output_configuration,
  :model_quality)
  SENSITIVE = []
  include Aws::Structure
end

#model_name ⇒ String

The name of the machine learning model.

Returns:

• (String)

# File 'lib/aws-sdk-lookoutequipment/types.rb', line 3636

class ModelSummary < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :status,
  :created_at,
  :active_model_version,
  :active_model_version_arn,
  :latest_scheduled_retraining_status,
  :latest_scheduled_retraining_model_version,
  :latest_scheduled_retraining_start_time,
  :next_scheduled_retraining_start_date,
  :retraining_scheduler_status,
  :model_diagnostics_output_configuration,
  :model_quality)
  SENSITIVE = []
  include Aws::Structure
end

#model_quality ⇒ String

Provides a quality assessment for a model that uses labels. If Lookout for Equipment determines that the model quality is poor based on training metrics, the value is ‘POOR_QUALITY_DETECTED`. Otherwise, the value is `QUALITY_THRESHOLD_MET`.

If the model is unlabeled, the model quality can’t be assessed and the value of ‘ModelQuality` is `CANNOT_DETERMINE_QUALITY`. In this situation, you can get a model quality assessment by adding labels to the input dataset and retraining the model.

For information about using labels with your models, see [Understanding labeling].

For information about improving the quality of a model, see [Best practices with Amazon Lookout for Equipment].

[1]: docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-labeling.html [2]: docs.aws.amazon.com/lookout-for-equipment/latest/ug/best-practices.html

Returns:

• (String)

# File 'lib/aws-sdk-lookoutequipment/types.rb', line 3636

class ModelSummary < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :status,
  :created_at,
  :active_model_version,
  :active_model_version_arn,
  :latest_scheduled_retraining_status,
  :latest_scheduled_retraining_model_version,
  :latest_scheduled_retraining_start_time,
  :next_scheduled_retraining_start_date,
  :retraining_scheduler_status,
  :model_diagnostics_output_configuration,
  :model_quality)
  SENSITIVE = []
  include Aws::Structure
end

#next_scheduled_retraining_start_date ⇒ Time

Indicates the date that the next scheduled retraining run will start on. Lookout for Equipment truncates the time you provide to [the nearest UTC day].

[1]: docs.aws.amazon.com/https:/docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp

Returns:

• (Time)

# File 'lib/aws-sdk-lookoutequipment/types.rb', line 3636

class ModelSummary < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :status,
  :created_at,
  :active_model_version,
  :active_model_version_arn,
  :latest_scheduled_retraining_status,
  :latest_scheduled_retraining_model_version,
  :latest_scheduled_retraining_start_time,
  :next_scheduled_retraining_start_date,
  :retraining_scheduler_status,
  :model_diagnostics_output_configuration,
  :model_quality)
  SENSITIVE = []
  include Aws::Structure
end

#retraining_scheduler_status ⇒ String

Indicates the status of the retraining scheduler.

Returns:

• (String)

# File 'lib/aws-sdk-lookoutequipment/types.rb', line 3636

class ModelSummary < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :status,
  :created_at,
  :active_model_version,
  :active_model_version_arn,
  :latest_scheduled_retraining_status,
  :latest_scheduled_retraining_model_version,
  :latest_scheduled_retraining_start_time,
  :next_scheduled_retraining_start_date,
  :retraining_scheduler_status,
  :model_diagnostics_output_configuration,
  :model_quality)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

Indicates the status of the machine learning model.

Returns:

• (String)

# File 'lib/aws-sdk-lookoutequipment/types.rb', line 3636

class ModelSummary < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :status,
  :created_at,
  :active_model_version,
  :active_model_version_arn,
  :latest_scheduled_retraining_status,
  :latest_scheduled_retraining_model_version,
  :latest_scheduled_retraining_start_time,
  :next_scheduled_retraining_start_date,
  :retraining_scheduler_status,
  :model_diagnostics_output_configuration,
  :model_quality)
  SENSITIVE = []
  include Aws::Structure
end