Creates a trained model from an associated configured model algorithm using data from any member of the collaboration¶

Description¶

Creates a trained model from an associated configured model algorithm using data from any member of the collaboration.

Usage¶

cleanroomsml_create_trained_model(membershipIdentifier, name,
  configuredModelAlgorithmAssociationArn, hyperparameters, environment,
  resourceConfig, stoppingCondition, incrementalTrainingDataChannels,
  dataChannels, trainingInputMode, description, kmsKeyArn, tags,
  mlModelTrainingPayerAccountId)

Arguments¶

membershipIdentifier

[required] The membership ID of the member that is creating the trained model.
name

[required] The name of the trained model.
configuredModelAlgorithmAssociationArn

[required] The associated configured model algorithm used to train this model.
hyperparameters

Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process.
environment

The environment variables to set in the Docker container.
resourceConfig

[required] Information about the EC2 resources that are used to train this model.
stoppingCondition

The criteria that is used to stop model training.
incrementalTrainingDataChannels

Specifies the incremental training data channels for the trained model.

Incremental training allows you to create a new trained model with updates without retraining from scratch. You can specify up to one incremental training data channel that references a previously trained model and its version.

Limit: Maximum of 20 channels total (including both incrementalTrainingDataChannels and dataChannels).
dataChannels

[required] Defines the data channels that are used as input for the trained model request.

Limit: Maximum of 20 channels total (including both dataChannels and incrementalTrainingDataChannels).
trainingInputMode

The input mode for accessing the training data. This parameter determines how the training data is made available to the training algorithm. Valid values are:
- File - The training data is downloaded to the training instance and made available as files.
- FastFile - The training data is streamed directly from Amazon S3 to the training algorithm, providing faster access for large datasets.
- Pipe - The training data is streamed to the training algorithm using named pipes, which can improve performance for certain algorithms.
description

The description of the trained model.
kmsKeyArn

The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the trained ML model and the associated data.
tags

The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50.
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8.
- Maximum value length - 256 Unicode characters in UTF-8.
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case sensitive.
- Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
mlModelTrainingPayerAccountId

The account ID of the member that is responsible for paying for model training costs.

Value¶

A list with the following syntax:

list(
  trainedModelArn = "string",
  versionIdentifier = "string"
)

Request syntax¶

svc$create_trained_model(
  membershipIdentifier = "string",
  name = "string",
  configuredModelAlgorithmAssociationArn = "string",
  hyperparameters = list(
    "string"
  ),
  environment = list(
    "string"
  ),
  resourceConfig = list(
    instanceCount = 123,
    instanceType = "ml.m4.xlarge"|"ml.m4.2xlarge"|"ml.m4.4xlarge"|"ml.m4.10xlarge"|"ml.m4.16xlarge"|"ml.g4dn.xlarge"|"ml.g4dn.2xlarge"|"ml.g4dn.4xlarge"|"ml.g4dn.8xlarge"|"ml.g4dn.12xlarge"|"ml.g4dn.16xlarge"|"ml.m5.large"|"ml.m5.xlarge"|"ml.m5.2xlarge"|"ml.m5.4xlarge"|"ml.m5.12xlarge"|"ml.m5.24xlarge"|"ml.c4.xlarge"|"ml.c4.2xlarge"|"ml.c4.4xlarge"|"ml.c4.8xlarge"|"ml.p2.xlarge"|"ml.p2.8xlarge"|"ml.p2.16xlarge"|"ml.p4d.24xlarge"|"ml.p4de.24xlarge"|"ml.p5.48xlarge"|"ml.c5.xlarge"|"ml.c5.2xlarge"|"ml.c5.4xlarge"|"ml.c5.9xlarge"|"ml.c5.18xlarge"|"ml.c5n.xlarge"|"ml.c5n.2xlarge"|"ml.c5n.4xlarge"|"ml.c5n.9xlarge"|"ml.c5n.18xlarge"|"ml.g5.xlarge"|"ml.g5.2xlarge"|"ml.g5.4xlarge"|"ml.g5.8xlarge"|"ml.g5.16xlarge"|"ml.g5.12xlarge"|"ml.g5.24xlarge"|"ml.g5.48xlarge"|"ml.trn1.2xlarge"|"ml.trn1.32xlarge"|"ml.trn1n.32xlarge"|"ml.m6i.large"|"ml.m6i.xlarge"|"ml.m6i.2xlarge"|"ml.m6i.4xlarge"|"ml.m6i.8xlarge"|"ml.m6i.12xlarge"|"ml.m6i.16xlarge"|"ml.m6i.24xlarge"|"ml.m6i.32xlarge"|"ml.c6i.xlarge"|"ml.c6i.2xlarge"|"ml.c6i.8xlarge"|"ml.c6i.4xlarge"|"ml.c6i.12xlarge"|"ml.c6i.16xlarge"|"ml.c6i.24xlarge"|"ml.c6i.32xlarge"|"ml.r5d.large"|"ml.r5d.xlarge"|"ml.r5d.2xlarge"|"ml.r5d.4xlarge"|"ml.r5d.8xlarge"|"ml.r5d.12xlarge"|"ml.r5d.16xlarge"|"ml.r5d.24xlarge"|"ml.t3.medium"|"ml.t3.large"|"ml.t3.xlarge"|"ml.t3.2xlarge"|"ml.r5.large"|"ml.r5.xlarge"|"ml.r5.2xlarge"|"ml.r5.4xlarge"|"ml.r5.8xlarge"|"ml.r5.12xlarge"|"ml.r5.16xlarge"|"ml.r5.24xlarge"|"ml.c7i.large"|"ml.c7i.xlarge"|"ml.c7i.2xlarge"|"ml.c7i.4xlarge"|"ml.c7i.8xlarge"|"ml.c7i.12xlarge"|"ml.c7i.16xlarge"|"ml.c7i.24xlarge"|"ml.c7i.48xlarge"|"ml.m7i.large"|"ml.m7i.xlarge"|"ml.m7i.2xlarge"|"ml.m7i.4xlarge"|"ml.m7i.8xlarge"|"ml.m7i.12xlarge"|"ml.m7i.16xlarge"|"ml.m7i.24xlarge"|"ml.m7i.48xlarge"|"ml.r7i.large"|"ml.r7i.xlarge"|"ml.r7i.2xlarge"|"ml.r7i.4xlarge"|"ml.r7i.8xlarge"|"ml.r7i.12xlarge"|"ml.r7i.16xlarge"|"ml.r7i.24xlarge"|"ml.r7i.48xlarge"|"ml.g6.xlarge"|"ml.g6.2xlarge"|"ml.g6.4xlarge"|"ml.g6.8xlarge"|"ml.g6.12xlarge"|"ml.g6.16xlarge"|"ml.g6.24xlarge"|"ml.g6.48xlarge"|"ml.g6e.xlarge"|"ml.g6e.2xlarge"|"ml.g6e.4xlarge"|"ml.g6e.8xlarge"|"ml.g6e.12xlarge"|"ml.g6e.16xlarge"|"ml.g6e.24xlarge"|"ml.g6e.48xlarge"|"ml.p5en.48xlarge"|"ml.p3.2xlarge"|"ml.p3.8xlarge"|"ml.p3.16xlarge"|"ml.p3dn.24xlarge",
    volumeSizeInGB = 123
  ),
  stoppingCondition = list(
    maxRuntimeInSeconds = 123
  ),
  incrementalTrainingDataChannels = list(
    list(
      trainedModelArn = "string",
      versionIdentifier = "string",
      channelName = "string"
    )
  ),
  dataChannels = list(
    list(
      mlInputChannelArn = "string",
      channelName = "string",
      s3DataDistributionType = "FullyReplicated"|"ShardedByS3Key"
    )
  ),
  trainingInputMode = "File"|"FastFile"|"Pipe",
  description = "string",
  kmsKeyArn = "string",
  tags = list(
    "string"
  ),
  mlModelTrainingPayerAccountId = "string"
)