describe_flywheel_iteration

Comprehend.Client.describe_flywheel_iteration(**kwargs)

Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.describe_flywheel_iteration(
    FlywheelArn='string',
    FlywheelIterationId='string'
)

Parameters

• FlywheelArn (string) -- [REQUIRED]
• FlywheelIterationId (string) -- [REQUIRED]

Return type

dict

Returns

Response Syntax

{
    'FlywheelIterationProperties': {
        'FlywheelArn': 'string',
        'FlywheelIterationId': 'string',
        'CreationTime': datetime(2015, 1, 1),
        'EndTime': datetime(2015, 1, 1),
        'Status': 'TRAINING'|'EVALUATING'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
        'Message': 'string',
        'EvaluatedModelArn': 'string',
        'EvaluatedModelMetrics': {
            'AverageF1Score': 123.0,
            'AveragePrecision': 123.0,
            'AverageRecall': 123.0,
            'AverageAccuracy': 123.0
        },
        'TrainedModelArn': 'string',
        'TrainedModelMetrics': {
            'AverageF1Score': 123.0,
            'AveragePrecision': 123.0,
            'AverageRecall': 123.0,
            'AverageAccuracy': 123.0
        },
        'EvaluationManifestS3Prefix': 'string'
    }
}

Response Structure

• (dict) --

  • FlywheelIterationProperties (dict) --

    The configuration properties of a flywheel iteration.

    • FlywheelArn (string) --

    • FlywheelIterationId (string) --

    • CreationTime (datetime) --

      The creation start time of the flywheel iteration.

    • EndTime (datetime) --

      The completion time of this flywheel iteration.

    • Status (string) --

      The status of the flywheel iteration.

    • Message (string) --

      A description of the status of the flywheel iteration.

    • EvaluatedModelArn (string) --

      The ARN of the evaluated model associated with this flywheel iteration.

    • EvaluatedModelMetrics (dict) --

      The evaluation metrics associated with the evaluated model.

      • AverageF1Score (float) --

        The average F1 score from the evaluation metrics.

      • AveragePrecision (float) --

        Average precision metric for the model.

      • AverageRecall (float) --

        Average recall metric for the model.

      • AverageAccuracy (float) --

        Average accuracy metric for the model.

    • TrainedModelArn (string) --

      The ARN of the trained model associated with this flywheel iteration.

    • TrainedModelMetrics (dict) --

      The metrics associated with the trained model.

      • AverageF1Score (float) --

        The average F1 score from the evaluation metrics.

      • AveragePrecision (float) --

        Average precision metric for the model.

      • AverageRecall (float) --

        Average recall metric for the model.

      • AverageAccuracy (float) --

        Average accuracy metric for the model.

    • EvaluationManifestS3Prefix (string) --

Exceptions

• Comprehend.Client.exceptions.InvalidRequestException
• Comprehend.Client.exceptions.TooManyRequestsException
• Comprehend.Client.exceptions.ResourceNotFoundException
• Comprehend.Client.exceptions.InternalServerException