[ aws . lookoutvision ]

create-model

Description

Creates a new version of a model within an an Amazon Lookout for Vision project. CreateModel is an asynchronous operation in which Amazon Lookout for Vision trains, tests, and evaluates a new version of a model.

To get the current status, check the Status field returned in the response from DescribeModel .

If the project has a single dataset, Amazon Lookout for Vision internally splits the dataset to create a training and a test dataset. If the project has a training and a test dataset, Lookout for Vision uses the respective datasets to train and test the model.

After training completes, the evaluation metrics are stored at the location specified in OutputConfig .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-model
--project-name <value>
[--description <value>]
[--client-token <value>]
--output-config <value>
[--kms-key-id <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--project-name (string)

The name of the project in which you want to create a model version.

--description (structure)

A description for the version of the model.

ModelVersion -> (string)

The version of the model

ModelArn -> (string)

The Amazon Resource Name (ARN) of the model.

CreationTimestamp -> (timestamp)

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 -> (structure)

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 -> (structure)

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

S3Location -> (structure)

The S3 location for the output.

Bucket -> (string)

The S3 bucket that contain the manifest file.

Prefix -> (string)

The path and name of the manifest file with the S3 bucket.

EvaluationManifest -> (structure)

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 -> (structure)

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 -> (timestamp)

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.

Shorthand Syntax:

ModelVersion=string,ModelArn=string,CreationTimestamp=timestamp,Description=string,Status=string,StatusMessage=string,Performance={F1Score=float,Recall=float,Precision=float},OutputConfig={S3Location={Bucket=string,Prefix=string}},EvaluationManifest={Bucket=string,Key=string},EvaluationResult={Bucket=string,Key=string},EvaluationEndTimestamp=timestamp,KmsKeyId=string

JSON Syntax:

{
  "ModelVersion": "string",
  "ModelArn": "string",
  "CreationTimestamp": timestamp,
  "Description": "string",
  "Status": "TRAINING"|"TRAINED"|"TRAINING_FAILED"|"STARTING_HOSTING"|"HOSTED"|"HOSTING_FAILED"|"STOPPING_HOSTING"|"SYSTEM_UPDATING"|"DELETING",
  "StatusMessage": "string",
  "Performance": {
    "F1Score": float,
    "Recall": float,
    "Precision": float
  },
  "OutputConfig": {
    "S3Location": {
      "Bucket": "string",
      "Prefix": "string"
    }
  },
  "EvaluationManifest": {
    "Bucket": "string",
    "Key": "string"
  },
  "EvaluationResult": {
    "Bucket": "string",
    "Key": "string"
  },
  "EvaluationEndTimestamp": timestamp,
  "KmsKeyId": "string"
}

--client-token (string)

ClientToken is an idempotency token that ensures a call to CreateModel completes only once. You choose the value to pass. For example, An issue, such as an network outage, might prevent you from getting a response from CreateModel . In this case, safely retry your call to CreateModel by using the same ClientToken parameter value. An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to CreateModel . An idempotency token is active for 8 hours.

--output-config (structure)

The location where Amazon Lookout for Vision saves the training results.

S3Location -> (structure)

The S3 location for the output.

Bucket -> (string)

The S3 bucket that contain the manifest file.

Prefix -> (string)

The path and name of the manifest file with the S3 bucket.

Shorthand Syntax:

S3Location={Bucket=string,Prefix=string}

JSON Syntax:

{
  "S3Location": {
    "Bucket": "string",
    "Prefix": "string"
  }
}

--kms-key-id (string)

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for encypting the model. If this parameter is not specified, the model is encrypted by a key that AWS owns and manages.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

ModelMetadata -> (structure)

The response from a call to CreateModel .

CreationTimestamp -> (timestamp)

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

ModelVersion -> (string)

The version of the model.

ModelArn -> (string)

The Amazon Resource Name (ARN) of the model.

Description -> (string)

The description for the model.

Status -> (string)

The status of the model.

StatusMessage -> (string)

The status message for the model.

Performance -> (structure)

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.