Rekognition / Client / create_project_version

create_project_version#

Rekognition.Client.create_project_version(**kwargs)#

Creates a new version of Amazon Rekognition project (like a Custom Labels model or a custom adapter) and begins training. Models and adapters are managed as part of a Rekognition project. The response from CreateProjectVersion is an Amazon Resource Name (ARN) for the project version.

The FeatureConfig operation argument allows you to configure specific model or adapter settings. You can provide a description to the project version by using the VersionDescription argment. Training can take a while to complete. You can get the current status by calling DescribeProjectVersions. Training completed successfully if the value of the Status field is TRAINING_COMPLETED. Once training has successfully completed, call DescribeProjectVersions to get the training results and evaluate the model.

This operation requires permissions to perform the rekognition:CreateProjectVersion action.

Note

The following applies only to projects with Amazon Rekognition Custom Labels as the chosen feature:

You can train a model in a project that doesn’t have associated datasets by specifying manifest files in the TrainingData and TestingData fields.

If you open the console after training a model with manifest files, Amazon Rekognition Custom Labels creates the datasets for you using the most recent manifest files. You can no longer train a model version for the project by specifying manifest files.

Instead of training with a project without associated datasets, we recommend that you use the manifest files to create training and test datasets for the project.

See also: AWS API Documentation

Request Syntax

response = client.create_project_version(
    ProjectArn='string',
    VersionName='string',
    OutputConfig={
        'S3Bucket': 'string',
        'S3KeyPrefix': 'string'
    },
    TrainingData={
        'Assets': [
            {
                'GroundTruthManifest': {
                    'S3Object': {
                        'Bucket': 'string',
                        'Name': 'string',
                        'Version': 'string'
                    }
                }
            },
        ]
    },
    TestingData={
        'Assets': [
            {
                'GroundTruthManifest': {
                    'S3Object': {
                        'Bucket': 'string',
                        'Name': 'string',
                        'Version': 'string'
                    }
                }
            },
        ],
        'AutoCreate': True|False
    },
    Tags={
        'string': 'string'
    },
    KmsKeyId='string',
    VersionDescription='string',
    FeatureConfig={
        'ContentModeration': {
            'ConfidenceThreshold': ...
        }
    }
)
Parameters:

  • ProjectArn (string) –

    [REQUIRED]

    The ARN of the Amazon Rekognition project that will manage the project version you want to train.

  • VersionName (string) –

    [REQUIRED]

    A name for the version of the project version. This value must be unique.

  • OutputConfig (dict) –

    [REQUIRED]

    The Amazon S3 bucket location to store the results of training. The bucket can be any S3 bucket in your AWS account. You need s3:PutObject permission on the bucket.

    • S3Bucket (string) –

      The S3 bucket where training output is placed.

    • S3KeyPrefix (string) –

      The prefix applied to the training output files.

  • TrainingData (dict) –

    Specifies an external manifest that the services uses to train the project version. If you specify TrainingData you must also specify TestingData. The project must not have any associated datasets.

    • Assets (list) –

      A manifest file that contains references to the training images and ground-truth annotations.

      • (dict) –

        Assets are the images that you use to train and evaluate a model version. Assets can also contain validation information that you use to debug a failed model training.

        • GroundTruthManifest (dict) –

          The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.

          • S3Object (dict) –

            Provides the S3 bucket name and object name.

            The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

            For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition Developer Guide.

            • Bucket (string) –

              Name of the S3 bucket.

            • Name (string) –

              S3 object key name.

            • Version (string) –

              If the bucket is versioning enabled, you can specify the object version.

  • TestingData (dict) –

    Specifies an external manifest that the service uses to test the project version. If you specify TestingData you must also specify TrainingData. The project must not have any associated datasets.

    • Assets (list) –

      The assets used for testing.

      • (dict) –

        Assets are the images that you use to train and evaluate a model version. Assets can also contain validation information that you use to debug a failed model training.

        • GroundTruthManifest (dict) –

          The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.

          • S3Object (dict) –

            Provides the S3 bucket name and object name.

            The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

            For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition Developer Guide.

            • Bucket (string) –

              Name of the S3 bucket.

            • Name (string) –

              S3 object key name.

            • Version (string) –

              If the bucket is versioning enabled, you can specify the object version.

    • AutoCreate (boolean) –

      If specified, Rekognition splits training dataset to create a test dataset for the training job.

  • Tags (dict) –

    A set of tags (key-value pairs) that you want to attach to the project version.

    • (string) –

      • (string) –

  • KmsKeyId (string) –

    The identifier for your AWS Key Management Service key (AWS KMS key). You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. The key is used to encrypt training images, test images, and manifest files copied into the service for the project version. Your source images are unaffected. The key is also used to encrypt training results and manifest files written to the output Amazon S3 bucket ( OutputConfig).

    If you choose to use your own KMS key, you need the following permissions on the KMS key.

    • kms:CreateGrant

    • kms:DescribeKey

    • kms:GenerateDataKey

    • kms:Decrypt

    If you don’t specify a value for KmsKeyId, images copied into the service are encrypted using a key that AWS owns and manages.

  • VersionDescription (string) – A description applied to the project version being created.

  • FeatureConfig (dict) –

    Feature-specific configuration of the training job. If the job configuration does not match the feature type associated with the project, an InvalidParameterException is returned.

    • ContentModeration (dict) –

      Configuration options for Custom Moderation training.

      • ConfidenceThreshold (float) –

        The confidence level you plan to use to identify if unsafe content is present during inference.

Return type:

dict

Returns:

Response Syntax

{
    'ProjectVersionArn': 'string'
}

Response Structure

  • (dict) –

    • ProjectVersionArn (string) –

      The ARN of the model or the project version that was created. Use DescribeProjectVersion to get the current status of the training operation.

Exceptions