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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lookoutequipment/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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#active_model_versionInteger

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

Returns:

  • (Integer)


3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
# File 'gems/aws-sdk-lookoutequipment/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_arnString

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)


3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
# File 'gems/aws-sdk-lookoutequipment/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_atTime

The time at which the specific model was created.

Returns:

  • (Time)


3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
# File 'gems/aws-sdk-lookoutequipment/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_arnString

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

Returns:

  • (String)


3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
# File 'gems/aws-sdk-lookoutequipment/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_nameString

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

Returns:

  • (String)


3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
# File 'gems/aws-sdk-lookoutequipment/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_versionInteger

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

Returns:

  • (Integer)


3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
# File 'gems/aws-sdk-lookoutequipment/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_timeTime

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

Returns:

  • (Time)


3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
# File 'gems/aws-sdk-lookoutequipment/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_statusString

Indicates the status of the most recent scheduled retraining run.

Returns:

  • (String)


3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
# File 'gems/aws-sdk-lookoutequipment/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_arnString

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

Returns:

  • (String)


3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
# File 'gems/aws-sdk-lookoutequipment/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_configurationTypes::ModelDiagnosticsOutputConfiguration

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



3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
# File 'gems/aws-sdk-lookoutequipment/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_nameString

The name of the machine learning model.

Returns:

  • (String)


3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
# File 'gems/aws-sdk-lookoutequipment/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_qualityString

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.

Returns:

  • (String)


3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
# File 'gems/aws-sdk-lookoutequipment/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_dateTime

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.

Returns:

  • (Time)


3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
# File 'gems/aws-sdk-lookoutequipment/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_statusString

Indicates the status of the retraining scheduler.

Returns:

  • (String)


3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
# File 'gems/aws-sdk-lookoutequipment/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

#statusString

Indicates the status of the machine learning model.

Returns:

  • (String)


3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
# File 'gems/aws-sdk-lookoutequipment/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