LookoutEquipment / Client / describe_model

describe_model#

LookoutEquipment.Client.describe_model(**kwargs)#

Provides a JSON containing the overall information about a specific machine learning model, including model name and ARN, dataset, training and evaluation information, status, and so on.

Request Syntax

response = client.describe_model(
    ModelName='string'
)

Parameters:

ModelName (string) –

[REQUIRED]

The name of the machine learning model to be described.

Return type:

dict

Returns:

Response Syntax

{
    'ModelName': 'string',
    'ModelArn': 'string',
    'DatasetName': 'string',
    'DatasetArn': 'string',
    'Schema': 'string',
    'LabelsInputConfiguration': {
        'S3InputConfiguration': {
            'Bucket': 'string',
            'Prefix': 'string'
        },
        'LabelGroupName': 'string'
    },
    'TrainingDataStartTime': datetime(2015, 1, 1),
    'TrainingDataEndTime': datetime(2015, 1, 1),
    'EvaluationDataStartTime': datetime(2015, 1, 1),
    'EvaluationDataEndTime': datetime(2015, 1, 1),
    'RoleArn': 'string',
    'DataPreProcessingConfiguration': {
        'TargetSamplingRate': 'PT1S'|'PT5S'|'PT10S'|'PT15S'|'PT30S'|'PT1M'|'PT5M'|'PT10M'|'PT15M'|'PT30M'|'PT1H'
    },
    'Status': 'IN_PROGRESS'|'SUCCESS'|'FAILED'|'IMPORT_IN_PROGRESS',
    'TrainingExecutionStartTime': datetime(2015, 1, 1),
    'TrainingExecutionEndTime': datetime(2015, 1, 1),
    'FailedReason': 'string',
    'ModelMetrics': 'string',
    'LastUpdatedTime': datetime(2015, 1, 1),
    'CreatedAt': datetime(2015, 1, 1),
    'ServerSideKmsKeyId': 'string',
    'OffCondition': 'string',
    'SourceModelVersionArn': 'string',
    'ImportJobStartTime': datetime(2015, 1, 1),
    'ImportJobEndTime': datetime(2015, 1, 1),
    'ActiveModelVersion': 123,
    'ActiveModelVersionArn': 'string',
    'ModelVersionActivatedAt': datetime(2015, 1, 1),
    'PreviousActiveModelVersion': 123,
    'PreviousActiveModelVersionArn': 'string',
    'PreviousModelVersionActivatedAt': datetime(2015, 1, 1),
    'PriorModelMetrics': 'string',
    'LatestScheduledRetrainingFailedReason': 'string',
    'LatestScheduledRetrainingStatus': 'IN_PROGRESS'|'SUCCESS'|'FAILED'|'IMPORT_IN_PROGRESS'|'CANCELED',
    'LatestScheduledRetrainingModelVersion': 123,
    'LatestScheduledRetrainingStartTime': datetime(2015, 1, 1),
    'LatestScheduledRetrainingAvailableDataInDays': 123,
    'NextScheduledRetrainingStartDate': datetime(2015, 1, 1),
    'AccumulatedInferenceDataStartTime': datetime(2015, 1, 1),
    'AccumulatedInferenceDataEndTime': datetime(2015, 1, 1),
    'RetrainingSchedulerStatus': 'PENDING'|'RUNNING'|'STOPPING'|'STOPPED',
    'ModelDiagnosticsOutputConfiguration': {
        'S3OutputConfiguration': {
            'Bucket': 'string',
            'Prefix': 'string'
        },
        'KmsKeyId': 'string'
    },
    'ModelQuality': 'QUALITY_THRESHOLD_MET'|'CANNOT_DETERMINE_QUALITY'|'POOR_QUALITY_DETECTED'
}

Response Structure

(dict) –
- ModelName (string) –
  
  The name of the machine learning model being described.
- ModelArn (string) –
  
  The Amazon Resource Name (ARN) of the machine learning model being described.
- DatasetName (string) –
  
  The name of the dataset being used by the machine learning being described.
- DatasetArn (string) –
  
  The Amazon Resouce Name (ARN) of the dataset used to create the machine learning model being described.
- Schema (string) –
  
  A JSON description of the data that is in each time series dataset, including names, column names, and data types.
- LabelsInputConfiguration (dict) –
  
  Specifies configuration information about the labels input, including its S3 location.
  - S3InputConfiguration (dict) –
    
    Contains location information for the S3 location being used for label data.
    - Bucket (string) –
      
      The name of the S3 bucket holding the label data.
    - Prefix (string) –
      
      The prefix for the S3 bucket used for the label data.
  - LabelGroupName (string) –
    
    The name of the label group to be used for label data.
- TrainingDataStartTime (datetime) –
  
  Indicates the time reference in the dataset that was used to begin the subset of training data for the machine learning model.
- TrainingDataEndTime (datetime) –
  
  Indicates the time reference in the dataset that was used to end the subset of training data for the machine learning model.
- EvaluationDataStartTime (datetime) –
  
  Indicates the time reference in the dataset that was used to begin the subset of evaluation data for the machine learning model.
- EvaluationDataEndTime (datetime) –
  
  Indicates the time reference in the dataset that was used to end the subset of evaluation data for the machine learning model.
- RoleArn (string) –
  
  The Amazon Resource Name (ARN) of a role with permission to access the data source for the machine learning model being described.
- DataPreProcessingConfiguration (dict) –
  
  The configuration is the TargetSamplingRate, which is the sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected at a 1 second level and you want the system to resample the data at a 1 minute rate before training, the TargetSamplingRate is 1 minute.
  
  When providing a value for the TargetSamplingRate, you must attach the prefix “PT” to the rate you want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is PT15M, and the value for a 1 hour rate is PT1H
  - TargetSamplingRate (string) –
    
    The sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected at a 1 second level and you want the system to resample the data at a 1 minute rate before training, the TargetSamplingRate is 1 minute.
    
    When providing a value for the TargetSamplingRate, you must attach the prefix “PT” to the rate you want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is PT15M, and the value for a 1 hour rate is PT1H
- Status (string) –
  
  Specifies the current status of the model being described. Status describes the status of the most recent action of the model.
- TrainingExecutionStartTime (datetime) –
  
  Indicates the time at which the training of the machine learning model began.
- TrainingExecutionEndTime (datetime) –
  
  Indicates the time at which the training of the machine learning model was completed.
- FailedReason (string) –
  
  If the training of the machine learning model failed, this indicates the reason for that failure.
- ModelMetrics (string) –
  
  The Model Metrics show an aggregated summary of the model’s performance within the evaluation time range. This is the JSON content of the metrics created when evaluating the model.
- LastUpdatedTime (datetime) –
  
  Indicates the last time the machine learning model was updated. The type of update is not specified.
- CreatedAt (datetime) –
  
  Indicates the time and date at which the machine learning model was created.
- ServerSideKmsKeyId (string) –
  
  Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout for Equipment.
- OffCondition (string) –
  
  Indicates that the asset associated with this sensor has been shut off. As long as this condition is met, Lookout for Equipment will not use data from this asset for training, evaluation, or inference.
- SourceModelVersionArn (string) –
  
  The Amazon Resource Name (ARN) of the source model version. This field appears if the active model version was imported.
- ImportJobStartTime (datetime) –
  
  The date and time when the import job was started. This field appears if the active model version was imported.
- ImportJobEndTime (datetime) –
  
  The date and time when the import job was completed. This field appears if the active model version was imported.
- ActiveModelVersion (integer) –
  
  The name of the model version used by the inference schedular when running a scheduled inference execution.
- ActiveModelVersionArn (string) –
  
  The Amazon Resource Name (ARN) of the model version used by the inference scheduler when running a scheduled inference execution.
- ModelVersionActivatedAt (datetime) –
  
  The date the active model version was activated.
- PreviousActiveModelVersion (integer) –
  
  The model version that was set as the active model version prior to the current active model version.
- PreviousActiveModelVersionArn (string) –
  
  The ARN of the model version that was set as the active model version prior to the current active model version.
- PreviousModelVersionActivatedAt (datetime) –
  
  The date and time when the previous active model version was activated.
- PriorModelMetrics (string) –
  
  If the model version was retrained, this field shows a summary of the performance of the prior model on the new training range. You can use the information in this JSON-formatted object to compare the new model version and the prior model version.
- LatestScheduledRetrainingFailedReason (string) –
  
  If the model version was generated by retraining and the training failed, this indicates the reason for that failure.
- LatestScheduledRetrainingStatus (string) –
  
  Indicates the status of the most recent scheduled retraining run.
- LatestScheduledRetrainingModelVersion (integer) –
  
  Indicates the most recent model version that was generated by retraining.
- LatestScheduledRetrainingStartTime (datetime) –
  
  Indicates the start time of the most recent scheduled retraining run.
- LatestScheduledRetrainingAvailableDataInDays (integer) –
  
  Indicates the number of days of data used in the most recent scheduled retraining run.
- NextScheduledRetrainingStartDate (datetime) –
  
  Indicates the date and time that the next scheduled retraining run will start on. Lookout for Equipment truncates the time you provide to the nearest UTC day.
- AccumulatedInferenceDataStartTime (datetime) –
  
  Indicates the start time of the inference data that has been accumulated.
- AccumulatedInferenceDataEndTime (datetime) –
  
  Indicates the end time of the inference data that has been accumulated.
- RetrainingSchedulerStatus (string) –
  
  Indicates the status of the retraining scheduler.
- ModelDiagnosticsOutputConfiguration (dict) –
  
  Configuration information for the model’s pointwise model diagnostics.
  - S3OutputConfiguration (dict) –
    
    The Amazon S3 location for the pointwise model diagnostics.
    - Bucket (string) –
      
      The name of the Amazon S3 bucket where the pointwise model diagnostics are located. You must be the owner of the Amazon S3 bucket.
    - Prefix (string) –
      
      The Amazon S3 prefix for the location of the pointwise model diagnostics. The prefix specifies the folder and evaluation result file name. ( bucket).
      
      When you call CreateModel or UpdateModel, specify the path within the bucket that you want Lookout for Equipment to save the model to. During training, Lookout for Equipment creates the model evaluation model as a compressed JSON file with the name model_diagnostics_results.json.gz.
      
      When you call DescribeModel or DescribeModelVersion, prefix contains the file path and filename of the model evaluation file.
  - KmsKeyId (string) –
    
    The Amazon Web Services Key Management Service (KMS) key identifier to encrypt the pointwise model diagnostics files.
- ModelQuality (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.

Exceptions

LookoutEquipment.Client.exceptions.ValidationException
LookoutEquipment.Client.exceptions.ResourceNotFoundException
LookoutEquipment.Client.exceptions.ThrottlingException
LookoutEquipment.Client.exceptions.AccessDeniedException
LookoutEquipment.Client.exceptions.InternalServerException