create-training-session¶

Description¶

Creates a training session in Amazon SageMaker. A training session provisions compute resources for fine-tuning a foundation model using Low-Rank Adaptation (LoRA). After the session is created, you can submit training operations and sample inference requests through the Amazon SageMaker Training Session Runtime API.

The following operations are related to CreateTrainingSession :

DescribeTrainingSession
ListTrainingSessions
StopTrainingSession
DeleteTrainingSession

Synopsis¶

  create-training-session
--training-session-name <value>
[--model-package-group-arn <value>]
--lora-config <value>
--role-arn <value>
[--vpc-config <value>]
--model-config <value>
--output-config <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--training-session-name (string) [required]

The name of the training session.

Constraints:

min: 1

max: 63

pattern: [a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}

--model-package-group-arn (string)

The Amazon Resource Name (ARN) of the model package group where checkpoints and fine-tuned model artifacts are published.

Constraints:

min: 1

max: 2048

pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-package-group/[\S]{1,2048}

--lora-config (structure) [required]

The Low-Rank Adaptation (LoRA) configuration for the training session, including the rank and alpha parameters.

Rank -> (integer) [required]

The rank of the Low-Rank Adaptation (LoRA) adapter matrices.

Constraints:

min: 1

max: 256

Alpha -> (integer) [required]

The Low-Rank Adaptation (LoRA) scaling factor.

Constraints:

min: 1

Shorthand Syntax:

Rank=integer,Alpha=integer

JSON Syntax:

{
  "Rank": integer,
  "Alpha": integer
}

--role-arn (string) [required]

The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to access resources on your behalf. The role must have permissions to access the output S3 path and model package group.

Constraints:

min: 20

max: 2048

pattern: arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

--vpc-config (structure)

The Virtual Private Cloud (VPC) configuration for the training session. Specify subnets and security groups to run the training session in your VPC.

SecurityGroupIds -> (list) [required]

The VPC security group IDs, in the form sg-xxxxxxxx . Specify the security groups for the VPC that is specified in the Subnets field.

Constraints:

min: 1

max: 5

(string)

Constraints:

min: 0

max: 32

pattern: [-0-9a-zA-Z]+

Subnets -> (list) [required]

The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones .

Constraints:

min: 1

max: 16

(string)

Constraints:

min: 0

max: 32

pattern: [-0-9a-zA-Z]+

Shorthand Syntax:

SecurityGroupIds=string,string,Subnets=string,string

JSON Syntax:

{
  "SecurityGroupIds": ["string", ...],
  "Subnets": ["string", ...]
}

--model-config (structure) [required]

The configuration for the base model, including the model ARN and end-user license agreement (EULA) acceptance.

BaseModelArn -> (string) [required]

The Amazon Resource Name (ARN) of the base foundation model from SageMaker Hub.

Constraints:

min: 1

max: 2048

pattern: (arn:[a-z0-9-.]{1,63}:sagemaker:[a-zA-Z0-9]+(?:-[a-zA-Z0-9]+)+:([0-9]{12}|aws):hub-content/)[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}/Model/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}(/[0-9]{1,4}\.[0-9]{1,4}\.[0-9]{1,4})?

AcceptEula -> (boolean)

Specifies whether you accept the end-user license agreement (EULA) for gated models.

Shorthand Syntax:

BaseModelArn=string,AcceptEula=boolean

JSON Syntax:

{
  "BaseModelArn": "string",
  "AcceptEula": true|false
}

--output-config (structure) [required]

The output configuration for the training session, including the S3 location and optional encryption settings.

S3Location -> (structure) [required]

The Amazon S3 location where training session outputs, including checkpoints and model artifacts, are stored.

Path -> (string) [required]

The Amazon S3 path where training session outputs are stored.

Constraints:

min: 1

max: 1024

pattern: (https|s3)://([^/]+)/?(.*)

KmsKeyArn -> (string)

The Amazon Resource Name (ARN) of the KMS key used to encrypt output data. If not specified, the default Amazon S3 encryption is used.

Constraints:

min: 1

max: 2048

pattern: arn:aws[a-z\-]*:kms:[a-z0-9\-]+:[0-9]{12}:key/(mrk-)?[a-f0-9\-]+

Shorthand Syntax:

S3Location={Path=string,KmsKeyArn=string}

JSON Syntax:

{
  "S3Location": {
    "Path": "string",
    "KmsKeyArn": "string"
  }
}

--tags (list)

An array of key-value pairs to apply to the training session as tags. For more information, see Tagging Amazon Web Services Resources .

Constraints:

min: 0

max: 50

(structure)

A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags .

For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources . For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy .

Key -> (string) [required]

The tag key. Tag keys must be unique per resource.

Constraints:

min: 1

max: 128

pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

Value -> (string) [required]

The tag value.

Constraints:

min: 0

max: 256

pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream
off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

TrainingSessionArn -> (string)

The Amazon Resource Name (ARN) of the training session.

Constraints:

min: 0

max: 256

pattern: arn:(aws[a-z\-]*):sagemaker:[a-z0-9\-]+:[0-9]{12}:training-session/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}

Table of Contents

Feedback

User Guide

create-training-session¶

Description¶

Synopsis¶

Options¶

Global Options¶

Output¶