LookoutforVision / Client / describe_model

describe_model#

LookoutforVision.Client.describe_model(**kwargs)#

Describes a version of an Amazon Lookout for Vision model.

This operation requires permissions to perform the lookoutvision:DescribeModel operation.

See also: AWS API Documentation

Request Syntax

response = client.describe_model(
    ProjectName='string',
    ModelVersion='string'
)
Parameters:

  • ProjectName (string) –

    [REQUIRED]

    The project that contains the version of a model that you want to describe.

  • ModelVersion (string) –

    [REQUIRED]

    The version of the model that you want to describe.

Return type:

dict

Returns:

Response Syntax

{
    'ModelDescription': {
        'ModelVersion': 'string',
        'ModelArn': 'string',
        'CreationTimestamp': datetime(2015, 1, 1),
        'Description': 'string',
        'Status': 'TRAINING'|'TRAINED'|'TRAINING_FAILED'|'STARTING_HOSTING'|'HOSTED'|'HOSTING_FAILED'|'STOPPING_HOSTING'|'SYSTEM_UPDATING'|'DELETING',
        'StatusMessage': 'string',
        'Performance': {
            'F1Score': ...,
            'Recall': ...,
            'Precision': ...
        },
        'OutputConfig': {
            'S3Location': {
                'Bucket': 'string',
                'Prefix': 'string'
            }
        },
        'EvaluationManifest': {
            'Bucket': 'string',
            'Key': 'string'
        },
        'EvaluationResult': {
            'Bucket': 'string',
            'Key': 'string'
        },
        'EvaluationEndTimestamp': datetime(2015, 1, 1),
        'KmsKeyId': 'string',
        'MinInferenceUnits': 123,
        'MaxInferenceUnits': 123
    }
}

Response Structure

  • (dict) –

    • ModelDescription (dict) –

      Contains the description of the model.

      • ModelVersion (string) –

        The version of the model

      • ModelArn (string) –

        The Amazon Resource Name (ARN) of the model.

      • CreationTimestamp (datetime) –

        The unix timestamp for the date and time that the model was created.

      • Description (string) –

        The description for the model.

      • Status (string) –

        The status of the model.

      • StatusMessage (string) –

        The status message for the model.

      • Performance (dict) –

        Performance metrics for the model. Created during training.

        • F1Score (float) –

          The overall F1 score metric for the trained model.

        • Recall (float) –

          The overall recall metric value for the trained model.

        • Precision (float) –

          The overall precision metric value for the trained model.

      • OutputConfig (dict) –

        The S3 location where Amazon Lookout for Vision saves model training files.

        • S3Location (dict) –

          The S3 location for the output.

          • Bucket (string) –

            The S3 bucket that contains the training or model packaging job output. If you are training a model, the bucket must in your AWS account. If you use an S3 bucket for a model packaging job, the S3 bucket must be in the same AWS Region and AWS account in which you use AWS IoT Greengrass.

          • Prefix (string) –

            The path of the folder, within the S3 bucket, that contains the output.

      • EvaluationManifest (dict) –

        The S3 location where Amazon Lookout for Vision saves the manifest file that was used to test the trained model and generate the performance scores.

        • Bucket (string) –

          The bucket that contains the training output.

        • Key (string) –

          The location of the training output in the bucket.

      • EvaluationResult (dict) –

        The S3 location where Amazon Lookout for Vision saves the performance metrics.

        • Bucket (string) –

          The bucket that contains the training output.

        • Key (string) –

          The location of the training output in the bucket.

      • EvaluationEndTimestamp (datetime) –

        The unix timestamp for the date and time that the evaluation ended.

      • KmsKeyId (string) –

        The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during training.

      • MinInferenceUnits (integer) –

        The minimum number of inference units used by the model. For more information, see StartModel

      • MaxInferenceUnits (integer) –

        The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model. For more information, see StartModel.

Exceptions