LookoutEquipment / Client / describe_model

describe_model#

LookoutEquipment.Client.describe_model(**kwargs)#

Provides a JSON containing the overall information about a specific ML 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 ML 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)
}

Response Structure

(dict) –
- ModelName (string) –
  
  The name of the ML model being described.
- ModelArn (string) –
  
  The Amazon Resource Name (ARN) of the ML model being described.
- DatasetName (string) –
  
  The name of the dataset being used by the ML being described.
- DatasetArn (string) –
  
  The Amazon Resouce Name (ARN) of the dataset used to create the ML 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 ML model.
- TrainingDataEndTime (datetime) –
  
  Indicates the time reference in the dataset that was used to end the subset of training data for the ML model.
- EvaluationDataStartTime (datetime) –
  
  Indicates the time reference in the dataset that was used to begin the subset of evaluation data for the ML model.
- EvaluationDataEndTime (datetime) –
  
  Indicates the time reference in the dataset that was used to end the subset of evaluation data for the ML model.
- RoleArn (string) –
  
  The Amazon Resource Name (ARN) of a role with permission to access the data source for the ML 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 ML model began.
- TrainingExecutionEndTime (datetime) –
  
  Indicates the time at which the training of the ML model was completed.
- FailedReason (string) –
  
  If the training of the ML 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 ML model was updated. The type of update is not specified.
- CreatedAt (datetime) –
  
  Indicates the time and date at which the ML 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.

Exceptions

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