Skip to content

ModelSummary

Source code in docs_src/capo_lookoutequipment/types/model_summary.py
class ModelSummary(TypedDict, closed=True):
    model_name: NotRequired["capo_lookoutequipment.types.model_name.ModelName"]
    """<p>The name of the machine learning model. </p>"""
    model_arn: NotRequired["capo_lookoutequipment.types.model_arn.ModelArn"]
    """<p> The Amazon Resource Name (ARN) of the machine learning model. </p>"""
    dataset_name: NotRequired["capo_lookoutequipment.types.dataset_name.DatasetName"]
    """<p>The name of the dataset being used for the machine learning model. </p>"""
    dataset_arn: NotRequired["capo_lookoutequipment.types.dataset_arn.DatasetArn"]
    """<p> The Amazon Resource Name (ARN) of the dataset used to create the model. </p>"""
    status: NotRequired["capo_lookoutequipment.types.model_status.ModelStatus"]
    """<p>Indicates the status of the machine learning model. </p>"""
    created_at: NotRequired["capo_lookoutequipment.types.timestamp.Timestamp"]
    """<p>The time at which the specific model was created. </p>"""
    active_model_version: NotRequired[
        "capo_lookoutequipment.types.model_version.ModelVersion"
    ]
    """<p>The model version that the inference scheduler uses to run an inference execution.</p>"""
    active_model_version_arn: NotRequired[
        "capo_lookoutequipment.types.model_version_arn.ModelVersionArn"
    ]
    """<p>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.</p>"""
    latest_scheduled_retraining_status: NotRequired[
        "capo_lookoutequipment.types.model_version_status.ModelVersionStatus"
    ]
    """<p>Indicates the status of the most recent scheduled retraining run. </p>"""
    latest_scheduled_retraining_model_version: NotRequired[
        "capo_lookoutequipment.types.model_version.ModelVersion"
    ]
    """<p>Indicates the most recent model version that was generated by retraining. </p>"""
    latest_scheduled_retraining_start_time: NotRequired[
        "capo_lookoutequipment.types.timestamp.Timestamp"
    ]
    """<p>Indicates the start time of the most recent scheduled retraining run. </p>"""
    next_scheduled_retraining_start_date: NotRequired[
        "capo_lookoutequipment.types.timestamp.Timestamp"
    ]
    """<p>Indicates the date that the next scheduled retraining run will start on. Lookout for Equipment truncates the time you provide to <a href="https://docs.aws.amazon.com/https:/docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp">the nearest UTC day</a>.</p>"""
    retraining_scheduler_status: NotRequired[
        "capo_lookoutequipment.types.retraining_scheduler_status.RetrainingSchedulerStatus"
    ]
    """<p>Indicates the status of the retraining scheduler. </p>"""
    model_diagnostics_output_configuration: NotRequired[
        "capo_lookoutequipment.types.model_diagnostics_output_configuration.ModelDiagnosticsOutputConfiguration"
    ]
    model_quality: NotRequired["capo_lookoutequipment.types.model_quality.ModelQuality"]
    """<p>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 <code>POOR_QUALITY_DETECTED</code>. Otherwise, the value is <code>QUALITY_THRESHOLD_MET</code>.</p> <p>If the model is unlabeled, the model quality can't be assessed and the value of <code>ModelQuality</code> is <code>CANNOT_DETERMINE_QUALITY</code>. In this situation, you can get a model quality assessment by adding labels to the input dataset and retraining the model.</p> <p>For information about using labels with your models, see <a href="https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-labeling.html">Understanding labeling</a>.</p> <p>For information about improving the quality of a model, see <a href="https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/best-practices.html">Best practices with Amazon Lookout for Equipment</a>.</p>"""

active_model_version instance-attribute

active_model_version: NotRequired[ModelVersion]

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

active_model_version_arn instance-attribute

active_model_version_arn: NotRequired[ModelVersionArn]

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.

created_at instance-attribute

created_at: NotRequired[Timestamp]

The time at which the specific model was created.

dataset_arn instance-attribute

dataset_arn: NotRequired[DatasetArn]

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

dataset_name instance-attribute

dataset_name: NotRequired[DatasetName]

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

latest_scheduled_retraining_model_version instance-attribute

latest_scheduled_retraining_model_version: NotRequired[ModelVersion]

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

latest_scheduled_retraining_start_time instance-attribute

latest_scheduled_retraining_start_time: NotRequired[Timestamp]

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

latest_scheduled_retraining_status instance-attribute

latest_scheduled_retraining_status: NotRequired[ModelVersionStatus]

Indicates the status of the most recent scheduled retraining run.

model_arn instance-attribute

model_arn: NotRequired[ModelArn]

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

model_diagnostics_output_configuration instance-attribute

model_diagnostics_output_configuration: NotRequired[ModelDiagnosticsOutputConfiguration]

model_name instance-attribute

model_name: NotRequired[ModelName]

The name of the machine learning model.

model_quality instance-attribute

model_quality: NotRequired[ModelQuality]

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.

next_scheduled_retraining_start_date instance-attribute

next_scheduled_retraining_start_date: NotRequired[Timestamp]

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.

retraining_scheduler_status instance-attribute

retraining_scheduler_status: NotRequired[RetrainingSchedulerStatus]

Indicates the status of the retraining scheduler.

status instance-attribute

status: NotRequired[ModelStatus]

Indicates the status of the machine learning model.