2020/10/26 - Amazon SageMaker Service - 14 new 19 updated api methods
Changes Update sagemaker client to latest version
Deletes an AppImageConfig.
See also: AWS API Documentation
Request Syntax
client.delete_app_image_config( AppImageConfigName='string' )
string
[REQUIRED]
The name of the AppImageConfig to delete.
None
Updates the properties of a SageMaker image. To change the image's tags, use the AddTags and DeleteTags APIs.
See also: AWS API Documentation
Request Syntax
client.update_image( DeleteProperties=[ 'string', ], Description='string', DisplayName='string', ImageName='string', RoleArn='string' )
list
A list of properties to delete. Only the Description and DisplayName properties can be deleted.
(string) --
string
The new description for the image.
string
The new display name for the image.
string
[REQUIRED]
The name of the image to update.
string
The new Amazon Resource Name (ARN) for the IAM role that enables Amazon SageMaker to perform tasks on your behalf.
dict
Response Syntax
{ 'ImageArn': 'string' }
Response Structure
(dict) --
ImageArn (string) --
The Amazon Resource Name (ARN) of the image.
Creates a configuration for running an Amazon SageMaker image as a KernelGateway app.
See also: AWS API Documentation
Request Syntax
client.create_app_image_config( AppImageConfigName='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ], KernelGatewayImageConfig={ 'KernelSpecs': [ { 'Name': 'string', 'DisplayName': 'string' }, ], 'FileSystemConfig': { 'MountPath': 'string', 'DefaultUid': 123, 'DefaultGid': 123 } } )
string
[REQUIRED]
The name of the AppImageConfig. Must be unique to your account.
list
A list of tags to apply to the AppImageConfig.
(dict) --
Describes a tag.
Key (string) -- [REQUIRED]
The tag key.
Value (string) -- [REQUIRED]
The tag value.
dict
The KernelGatewayImageConfig.
KernelSpecs (list) -- [REQUIRED]
Defines how a kernel is started and the arguments, environment variables, and metadata that are available to the kernel.
(dict) --
Defines how a kernel is started and the arguments, environment variables, and metadata that are available to the kernel.
Name (string) -- [REQUIRED]
The name of the kernel. Must be unique to your account.
DisplayName (string) --
The display name of the kernel.
FileSystemConfig (dict) --
The file system configuration.
MountPath (string) --
The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user .
DefaultUid (integer) --
The default POSIX user ID. If not specified, defaults to 1000 .
DefaultGid (integer) --
The default POSIX group ID. If not specified, defaults to 100 .
dict
Response Syntax
{ 'AppImageConfigArn': 'string' }
Response Structure
(dict) --
AppImageConfigArn (string) --
The Amazon Resource Name (ARN) of the AppImageConfig.
Lists the versions of a specified image and their properties. The list can be filtered by creation time or modified time.
See also: AWS API Documentation
Request Syntax
client.list_image_versions( CreationTimeAfter=datetime(2015, 1, 1), CreationTimeBefore=datetime(2015, 1, 1), ImageName='string', LastModifiedTimeAfter=datetime(2015, 1, 1), LastModifiedTimeBefore=datetime(2015, 1, 1), MaxResults=123, NextToken='string', SortBy='CREATION_TIME'|'LAST_MODIFIED_TIME'|'VERSION', SortOrder='ASCENDING'|'DESCENDING' )
datetime
A filter that returns only versions created on or after the specified time.
datetime
A filter that returns only versions created on or before the specified time.
string
[REQUIRED]
The name of the image to list the versions of.
datetime
A filter that returns only versions modified on or after the specified time.
datetime
A filter that returns only versions modified on or before the specified time.
integer
The maximum number of versions to return in the response. The default value is 10.
string
If the previous call to ListImageVersions didn't return the full set of versions, the call returns a token for getting the next set of versions.
string
The property used to sort results. The default value is CREATION_TIME .
string
The sort order. The default value is DESCENDING .
dict
Response Syntax
{ 'ImageVersions': [ { 'CreationTime': datetime(2015, 1, 1), 'FailureReason': 'string', 'ImageArn': 'string', 'ImageVersionArn': 'string', 'ImageVersionStatus': 'CREATING'|'CREATED'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED', 'LastModifiedTime': datetime(2015, 1, 1), 'Version': 123 }, ], 'NextToken': 'string' }
Response Structure
(dict) --
ImageVersions (list) --
A list of versions and their properties.
(dict) --
A version of a SageMaker Image . A version represents an existing container image.
CreationTime (datetime) --
When the version was created.
FailureReason (string) --
When a create or delete operation fails, the reason for the failure.
ImageArn (string) --
The Amazon Resource Name (ARN) of the image the version is based on.
ImageVersionArn (string) --
The ARN of the version.
ImageVersionStatus (string) --
The status of the version.
LastModifiedTime (datetime) --
When the version was last modified.
Version (integer) --
The version number.
NextToken (string) --
A token for getting the next set of versions, if there are any.
Lists the images in your account and their properties. The list can be filtered by creation time or modified time, and whether the image name contains a specified string.
See also: AWS API Documentation
Request Syntax
client.list_images( CreationTimeAfter=datetime(2015, 1, 1), CreationTimeBefore=datetime(2015, 1, 1), LastModifiedTimeAfter=datetime(2015, 1, 1), LastModifiedTimeBefore=datetime(2015, 1, 1), MaxResults=123, NameContains='string', NextToken='string', SortBy='CREATION_TIME'|'LAST_MODIFIED_TIME'|'IMAGE_NAME', SortOrder='ASCENDING'|'DESCENDING' )
datetime
A filter that returns only images created on or after the specified time.
datetime
A filter that returns only images created on or before the specified time.
datetime
A filter that returns only images modified on or after the specified time.
datetime
A filter that returns only images modified on or before the specified time.
integer
The maximum number of images to return in the response. The default value is 10.
string
A filter that returns only images whose name contains the specified string.
string
If the previous call to ListImages didn't return the full set of images, the call returns a token for getting the next set of images.
string
The property used to sort results. The default value is CREATION_TIME .
string
The sort order. The default value is DESCENDING .
dict
Response Syntax
{ 'Images': [ { 'CreationTime': datetime(2015, 1, 1), 'Description': 'string', 'DisplayName': 'string', 'FailureReason': 'string', 'ImageArn': 'string', 'ImageName': 'string', 'ImageStatus': 'CREATING'|'CREATED'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED', 'LastModifiedTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' }
Response Structure
(dict) --
Images (list) --
A list of images and their properties.
(dict) --
A SageMaker image. A SageMaker image represents a set of container images that are derived from a common base container image. Each of these container images is represented by a SageMaker ImageVersion .
CreationTime (datetime) --
When the image was created.
Description (string) --
The description of the image.
DisplayName (string) --
The name of the image as displayed.
FailureReason (string) --
When a create, update, or delete operation fails, the reason for the failure.
ImageArn (string) --
The Amazon Resource Name (ARN) of the image.
ImageName (string) --
The name of the image.
ImageStatus (string) --
The status of the image.
LastModifiedTime (datetime) --
When the image was last modified.
NextToken (string) --
A token for getting the next set of images, if there are any.
Describes a SageMaker image.
See also: AWS API Documentation
Request Syntax
client.describe_image( ImageName='string' )
string
[REQUIRED]
The name of the image to describe.
dict
Response Syntax
{ 'CreationTime': datetime(2015, 1, 1), 'Description': 'string', 'DisplayName': 'string', 'FailureReason': 'string', 'ImageArn': 'string', 'ImageName': 'string', 'ImageStatus': 'CREATING'|'CREATED'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED', 'LastModifiedTime': datetime(2015, 1, 1), 'RoleArn': 'string' }
Response Structure
(dict) --
CreationTime (datetime) --
When the image was created.
Description (string) --
The description of the image.
DisplayName (string) --
The name of the image as displayed.
FailureReason (string) --
When a create, update, or delete operation fails, the reason for the failure.
ImageArn (string) --
The Amazon Resource Name (ARN) of the image.
ImageName (string) --
The name of the image.
ImageStatus (string) --
The status of the image.
LastModifiedTime (datetime) --
When the image was last modified.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that enables Amazon SageMaker to perform tasks on your behalf.
Describes an AppImageConfig.
See also: AWS API Documentation
Request Syntax
client.describe_app_image_config( AppImageConfigName='string' )
string
[REQUIRED]
The name of the AppImageConfig to describe.
dict
Response Syntax
{ 'AppImageConfigArn': 'string', 'AppImageConfigName': 'string', 'CreationTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'KernelGatewayImageConfig': { 'KernelSpecs': [ { 'Name': 'string', 'DisplayName': 'string' }, ], 'FileSystemConfig': { 'MountPath': 'string', 'DefaultUid': 123, 'DefaultGid': 123 } } }
Response Structure
(dict) --
AppImageConfigArn (string) --
The Amazon Resource Name (ARN) of the AppImageConfig.
AppImageConfigName (string) --
The name of the AppImageConfig.
CreationTime (datetime) --
When the AppImageConfig was created.
LastModifiedTime (datetime) --
When the AppImageConfig was last modified.
KernelGatewayImageConfig (dict) --
The KernelGateway app.
KernelSpecs (list) --
Defines how a kernel is started and the arguments, environment variables, and metadata that are available to the kernel.
(dict) --
Defines how a kernel is started and the arguments, environment variables, and metadata that are available to the kernel.
Name (string) --
The name of the kernel. Must be unique to your account.
DisplayName (string) --
The display name of the kernel.
FileSystemConfig (dict) --
The file system configuration.
MountPath (string) --
The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user .
DefaultUid (integer) --
The default POSIX user ID. If not specified, defaults to 1000 .
DefaultGid (integer) --
The default POSIX group ID. If not specified, defaults to 100 .
Creates a SageMaker Image . A SageMaker image represents a set of container images. Each of these container images is represented by a SageMaker ImageVersion .
See also: AWS API Documentation
Request Syntax
client.create_image( Description='string', DisplayName='string', ImageName='string', RoleArn='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] )
string
The description of the image.
string
The display name of the image. When the image is added to a domain, DisplayName must be unique to the domain.
string
[REQUIRED]
The name of the image. Must be unique to your account.
string
[REQUIRED]
The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
list
A list of tags to apply to the image.
(dict) --
Describes a tag.
Key (string) -- [REQUIRED]
The tag key.
Value (string) -- [REQUIRED]
The tag value.
dict
Response Syntax
{ 'ImageArn': 'string' }
Response Structure
(dict) --
ImageArn (string) --
The Amazon Resource Name (ARN) of the image.
Describes a version of a SageMaker image.
See also: AWS API Documentation
Request Syntax
client.describe_image_version( ImageName='string', Version=123 )
string
[REQUIRED]
The name of the image.
integer
The version of the image. If not specified, the latest version is described.
dict
Response Syntax
{ 'BaseImage': 'string', 'ContainerImage': 'string', 'CreationTime': datetime(2015, 1, 1), 'FailureReason': 'string', 'ImageArn': 'string', 'ImageVersionArn': 'string', 'ImageVersionStatus': 'CREATING'|'CREATED'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED', 'LastModifiedTime': datetime(2015, 1, 1), 'Version': 123 }
Response Structure
(dict) --
BaseImage (string) --
The registry path of the container image on which this image version is based.
ContainerImage (string) --
The registry path of the container image that contains this image version.
CreationTime (datetime) --
When the version was created.
FailureReason (string) --
When a create or delete operation fails, the reason for the failure.
ImageArn (string) --
The Amazon Resource Name (ARN) of the image the version is based on.
ImageVersionArn (string) --
The ARN of the version.
ImageVersionStatus (string) --
The status of the version.
LastModifiedTime (datetime) --
When the version was last modified.
Version (integer) --
The version number.
Deletes a SageMaker image and all versions of the image. The container images aren't deleted.
See also: AWS API Documentation
Request Syntax
client.delete_image( ImageName='string' )
string
[REQUIRED]
The name of the image to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a version of a SageMaker image. The container image the version represents isn't deleted.
See also: AWS API Documentation
Request Syntax
client.delete_image_version( ImageName='string', Version=123 )
string
[REQUIRED]
The name of the image.
integer
[REQUIRED]
The version to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates the properties of an AppImageConfig.
See also: AWS API Documentation
Request Syntax
client.update_app_image_config( AppImageConfigName='string', KernelGatewayImageConfig={ 'KernelSpecs': [ { 'Name': 'string', 'DisplayName': 'string' }, ], 'FileSystemConfig': { 'MountPath': 'string', 'DefaultUid': 123, 'DefaultGid': 123 } } )
string
[REQUIRED]
The name of the AppImageConfig to update.
dict
The new KernelGateway app to run on the image.
KernelSpecs (list) -- [REQUIRED]
Defines how a kernel is started and the arguments, environment variables, and metadata that are available to the kernel.
(dict) --
Defines how a kernel is started and the arguments, environment variables, and metadata that are available to the kernel.
Name (string) -- [REQUIRED]
The name of the kernel. Must be unique to your account.
DisplayName (string) --
The display name of the kernel.
FileSystemConfig (dict) --
The file system configuration.
MountPath (string) --
The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user .
DefaultUid (integer) --
The default POSIX user ID. If not specified, defaults to 1000 .
DefaultGid (integer) --
The default POSIX group ID. If not specified, defaults to 100 .
dict
Response Syntax
{ 'AppImageConfigArn': 'string' }
Response Structure
(dict) --
AppImageConfigArn (string) --
The Amazon Resource Name (ARN) for the AppImageConfig.
Creates a version of the SageMaker image specified by ImageName . The version represents the Amazon Container Registry (ECR) container image specified by BaseImage .
See also: AWS API Documentation
Request Syntax
client.create_image_version( BaseImage='string', ClientToken='string', ImageName='string' )
string
[REQUIRED]
The registry path of the container image to use as the starting point for this version. The path is an Amazon Container Registry (ECR) URI in the following format:
<acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>
string
[REQUIRED]
A unique ID. If not specified, the AWS CLI and AWS SDKs, such as the SDK for Python (Boto3), add a unique value to the call.
This field is autopopulated if not provided.
string
[REQUIRED]
The ImageName of the Image to create a version of.
dict
Response Syntax
{ 'ImageVersionArn': 'string' }
Response Structure
(dict) --
ImageVersionArn (string) --
The Amazon Resource Name (ARN) of the image version.
Lists the AppImageConfigs in your account and their properties. The list can be filtered by creation time or modified time, and whether the AppImageConfig name contains a specified string.
See also: AWS API Documentation
Request Syntax
client.list_app_image_configs( MaxResults=123, NextToken='string', NameContains='string', CreationTimeBefore=datetime(2015, 1, 1), CreationTimeAfter=datetime(2015, 1, 1), ModifiedTimeBefore=datetime(2015, 1, 1), ModifiedTimeAfter=datetime(2015, 1, 1), SortBy='CreationTime'|'LastModifiedTime'|'Name', SortOrder='Ascending'|'Descending' )
integer
The maximum number of AppImageConfigs to return in the response. The default value is 10.
string
If the previous call to ListImages didn't return the full set of AppImageConfigs, the call returns a token for getting the next set of AppImageConfigs.
string
A filter that returns only AppImageConfigs whose name contains the specified string.
datetime
A filter that returns only AppImageConfigs created on or before the specified time.
datetime
A filter that returns only AppImageConfigs created on or after the specified time.
datetime
A filter that returns only AppImageConfigs modified on or before the specified time.
datetime
A filter that returns only AppImageConfigs modified on or after the specified time.
string
The property used to sort results. The default value is CreationTime .
string
The sort order. The default value is Descending .
dict
Response Syntax
{ 'NextToken': 'string', 'AppImageConfigs': [ { 'AppImageConfigArn': 'string', 'AppImageConfigName': 'string', 'CreationTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'KernelGatewayImageConfig': { 'KernelSpecs': [ { 'Name': 'string', 'DisplayName': 'string' }, ], 'FileSystemConfig': { 'MountPath': 'string', 'DefaultUid': 123, 'DefaultGid': 123 } } }, ] }
Response Structure
(dict) --
NextToken (string) --
A token for getting the next set of AppImageConfigs, if there are any.
AppImageConfigs (list) --
A list of AppImageConfigs and their properties.
(dict) --
The configuration for running an Amazon SageMaker image as a KernelGateway app.
AppImageConfigArn (string) --
The Amazon Resource Name (ARN) of the AppImageConfig.
AppImageConfigName (string) --
The name of the AppImageConfig.
CreationTime (datetime) --
When the AppImageConfig was created.
LastModifiedTime (datetime) --
When the AppImageConfig was last modified.
KernelGatewayImageConfig (dict) --
The KernelGateway app.
KernelSpecs (list) --
Defines how a kernel is started and the arguments, environment variables, and metadata that are available to the kernel.
(dict) --
Defines how a kernel is started and the arguments, environment variables, and metadata that are available to the kernel.
Name (string) --
The name of the kernel. Must be unique to your account.
DisplayName (string) --
The display name of the kernel.
FileSystemConfig (dict) --
The file system configuration.
MountPath (string) --
The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user .
DefaultUid (integer) --
The default POSIX user ID. If not specified, defaults to 1000 .
DefaultGid (integer) --
The default POSIX group ID. If not specified, defaults to 100 .
{'TrainingSpecification': {'SupportedTrainingInstanceTypes': {'ml.p4d.24xlarge'}}, 'ValidationSpecification': {'ValidationProfiles': {'TrainingJobDefinition': {'ResourceConfig': {'InstanceType': {'ml.p4d.24xlarge'}}}}}}
Create a machine learning algorithm that you can use in Amazon SageMaker and list in the AWS Marketplace.
See also: AWS API Documentation
Request Syntax
client.create_algorithm( AlgorithmName='string', AlgorithmDescription='string', TrainingSpecification={ 'TrainingImage': 'string', 'TrainingImageDigest': 'string', 'SupportedHyperParameters': [ { 'Name': 'string', 'Description': 'string', 'Type': 'Integer'|'Continuous'|'Categorical'|'FreeText', 'Range': { 'IntegerParameterRangeSpecification': { 'MinValue': 'string', 'MaxValue': 'string' }, 'ContinuousParameterRangeSpecification': { 'MinValue': 'string', 'MaxValue': 'string' }, 'CategoricalParameterRangeSpecification': { 'Values': [ 'string', ] } }, 'IsTunable': True|False, 'IsRequired': True|False, 'DefaultValue': 'string' }, ], 'SupportedTrainingInstanceTypes': [ '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.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.p4d.24xlarge'|'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', ], 'SupportsDistributedTraining': True|False, 'MetricDefinitions': [ { 'Name': 'string', 'Regex': 'string' }, ], 'TrainingChannels': [ { 'Name': 'string', 'Description': 'string', 'IsRequired': True|False, 'SupportedContentTypes': [ 'string', ], 'SupportedCompressionTypes': [ 'None'|'Gzip', ], 'SupportedInputModes': [ 'Pipe'|'File', ] }, ], 'SupportedTuningJobObjectiveMetrics': [ { 'Type': 'Maximize'|'Minimize', 'MetricName': 'string' }, ] }, InferenceSpecification={ 'Containers': [ { 'ContainerHostname': 'string', 'Image': 'string', 'ImageDigest': 'string', 'ModelDataUrl': 'string', 'ProductId': 'string' }, ], 'SupportedTransformInstanceTypes': [ 'ml.m4.xlarge'|'ml.m4.2xlarge'|'ml.m4.4xlarge'|'ml.m4.10xlarge'|'ml.m4.16xlarge'|'ml.c4.xlarge'|'ml.c4.2xlarge'|'ml.c4.4xlarge'|'ml.c4.8xlarge'|'ml.p2.xlarge'|'ml.p2.8xlarge'|'ml.p2.16xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.12xlarge'|'ml.m5.24xlarge', ], 'SupportedRealtimeInferenceInstanceTypes': [ 'ml.t2.medium'|'ml.t2.large'|'ml.t2.xlarge'|'ml.t2.2xlarge'|'ml.m4.xlarge'|'ml.m4.2xlarge'|'ml.m4.4xlarge'|'ml.m4.10xlarge'|'ml.m4.16xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.12xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.12xlarge'|'ml.m5d.24xlarge'|'ml.c4.large'|'ml.c4.xlarge'|'ml.c4.2xlarge'|'ml.c4.4xlarge'|'ml.c4.8xlarge'|'ml.p2.xlarge'|'ml.p2.8xlarge'|'ml.p2.16xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.18xlarge'|'ml.c5d.large'|'ml.c5d.xlarge'|'ml.c5d.2xlarge'|'ml.c5d.4xlarge'|'ml.c5d.9xlarge'|'ml.c5d.18xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.12xlarge'|'ml.r5.24xlarge'|'ml.r5d.large'|'ml.r5d.xlarge'|'ml.r5d.2xlarge'|'ml.r5d.4xlarge'|'ml.r5d.12xlarge'|'ml.r5d.24xlarge'|'ml.inf1.xlarge'|'ml.inf1.2xlarge'|'ml.inf1.6xlarge'|'ml.inf1.24xlarge', ], 'SupportedContentTypes': [ 'string', ], 'SupportedResponseMIMETypes': [ 'string', ] }, ValidationSpecification={ 'ValidationRole': 'string', 'ValidationProfiles': [ { 'ProfileName': 'string', 'TrainingJobDefinition': { 'TrainingInputMode': 'Pipe'|'File', 'HyperParameters': { 'string': 'string' }, 'InputDataConfig': [ { 'ChannelName': 'string', 'DataSource': { 'S3DataSource': { 'S3DataType': 'ManifestFile'|'S3Prefix'|'AugmentedManifestFile', 'S3Uri': 'string', 'S3DataDistributionType': 'FullyReplicated'|'ShardedByS3Key', 'AttributeNames': [ 'string', ] }, 'FileSystemDataSource': { 'FileSystemId': 'string', 'FileSystemAccessMode': 'rw'|'ro', 'FileSystemType': 'EFS'|'FSxLustre', 'DirectoryPath': 'string' } }, 'ContentType': 'string', 'CompressionType': 'None'|'Gzip', 'RecordWrapperType': 'None'|'RecordIO', 'InputMode': 'Pipe'|'File', 'ShuffleConfig': { 'Seed': 123 } }, ], 'OutputDataConfig': { 'KmsKeyId': 'string', 'S3OutputPath': 'string' }, 'ResourceConfig': { '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.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.p4d.24xlarge'|'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', 'InstanceCount': 123, 'VolumeSizeInGB': 123, 'VolumeKmsKeyId': 'string' }, 'StoppingCondition': { 'MaxRuntimeInSeconds': 123, 'MaxWaitTimeInSeconds': 123 } }, 'TransformJobDefinition': { 'MaxConcurrentTransforms': 123, 'MaxPayloadInMB': 123, 'BatchStrategy': 'MultiRecord'|'SingleRecord', 'Environment': { 'string': 'string' }, 'TransformInput': { 'DataSource': { 'S3DataSource': { 'S3DataType': 'ManifestFile'|'S3Prefix'|'AugmentedManifestFile', 'S3Uri': 'string' } }, 'ContentType': 'string', 'CompressionType': 'None'|'Gzip', 'SplitType': 'None'|'Line'|'RecordIO'|'TFRecord' }, 'TransformOutput': { 'S3OutputPath': 'string', 'Accept': 'string', 'AssembleWith': 'None'|'Line', 'KmsKeyId': 'string' }, 'TransformResources': { 'InstanceType': 'ml.m4.xlarge'|'ml.m4.2xlarge'|'ml.m4.4xlarge'|'ml.m4.10xlarge'|'ml.m4.16xlarge'|'ml.c4.xlarge'|'ml.c4.2xlarge'|'ml.c4.4xlarge'|'ml.c4.8xlarge'|'ml.p2.xlarge'|'ml.p2.8xlarge'|'ml.p2.16xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.12xlarge'|'ml.m5.24xlarge', 'InstanceCount': 123, 'VolumeKmsKeyId': 'string' } } }, ] }, CertifyForMarketplace=True|False )
string
[REQUIRED]
The name of the algorithm.
string
A description of the algorithm.
dict
[REQUIRED]
Specifies details about training jobs run by this algorithm, including the following:
The Amazon ECR path of the container and the version digest of the algorithm.
The hyperparameters that the algorithm supports.
The instance types that the algorithm supports for training.
Whether the algorithm supports distributed training.
The metrics that the algorithm emits to Amazon CloudWatch.
Which metrics that the algorithm emits can be used as the objective metric for hyperparameter tuning jobs.
The input channels that the algorithm supports for training data. For example, an algorithm might support train , validation , and test channels.
TrainingImage (string) -- [REQUIRED]
The Amazon ECR registry path of the Docker image that contains the training algorithm.
TrainingImageDigest (string) --
An MD5 hash of the training algorithm that identifies the Docker image used for training.
SupportedHyperParameters (list) --
A list of the HyperParameterSpecification objects, that define the supported hyperparameters. This is required if the algorithm supports automatic model tuning.>
(dict) --
Defines a hyperparameter to be used by an algorithm.
Name (string) -- [REQUIRED]
The name of this hyperparameter. The name must be unique.
Description (string) --
A brief description of the hyperparameter.
Type (string) -- [REQUIRED]
The type of this hyperparameter. The valid types are Integer , Continuous , Categorical , and FreeText .
Range (dict) --
The allowed range for this hyperparameter.
IntegerParameterRangeSpecification (dict) --
A IntegerParameterRangeSpecification object that defines the possible values for an integer hyperparameter.
MinValue (string) -- [REQUIRED]
The minimum integer value allowed.
MaxValue (string) -- [REQUIRED]
The maximum integer value allowed.
ContinuousParameterRangeSpecification (dict) --
A ContinuousParameterRangeSpecification object that defines the possible values for a continuous hyperparameter.
MinValue (string) -- [REQUIRED]
The minimum floating-point value allowed.
MaxValue (string) -- [REQUIRED]
The maximum floating-point value allowed.
CategoricalParameterRangeSpecification (dict) --
A CategoricalParameterRangeSpecification object that defines the possible values for a categorical hyperparameter.
Values (list) -- [REQUIRED]
The allowed categories for the hyperparameter.
(string) --
IsTunable (boolean) --
Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.
IsRequired (boolean) --
Indicates whether this hyperparameter is required.
DefaultValue (string) --
The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.
SupportedTrainingInstanceTypes (list) -- [REQUIRED]
A list of the instance types that this algorithm can use for training.
(string) --
SupportsDistributedTraining (boolean) --
Indicates whether the algorithm supports distributed training. If set to false, buyers can't request more than one instance during training.
MetricDefinitions (list) --
A list of MetricDefinition objects, which are used for parsing metrics generated by the algorithm.
(dict) --
Specifies a metric that the training algorithm writes to stderr or stdout . Amazon SageMakerhyperparameter tuning captures all defined metrics. You specify one metric that a hyperparameter tuning job uses as its objective metric to choose the best training job.
Name (string) -- [REQUIRED]
The name of the metric.
Regex (string) -- [REQUIRED]
A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining Objective Metrics.
TrainingChannels (list) -- [REQUIRED]
A list of ChannelSpecification objects, which specify the input sources to be used by the algorithm.
(dict) --
Defines a named input source, called a channel, to be used by an algorithm.
Name (string) -- [REQUIRED]
The name of the channel.
Description (string) --
A brief description of the channel.
IsRequired (boolean) --
Indicates whether the channel is required by the algorithm.
SupportedContentTypes (list) -- [REQUIRED]
The supported MIME types for the data.
(string) --
SupportedCompressionTypes (list) --
The allowed compression types, if data compression is used.
(string) --
SupportedInputModes (list) -- [REQUIRED]
The allowed input mode, either FILE or PIPE.
In FILE mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode.
In PIPE mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.
(string) --
SupportedTuningJobObjectiveMetrics (list) --
A list of the metrics that the algorithm emits that can be used as the objective metric in a hyperparameter tuning job.
(dict) --
Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning uses the value of this metric to evaluate the training jobs it launches, and returns the training job that results in either the highest or lowest value for this metric, depending on the value you specify for the Type parameter.
Type (string) -- [REQUIRED]
Whether to minimize or maximize the objective metric.
MetricName (string) -- [REQUIRED]
The name of the metric to use for the objective metric.
dict
Specifies details about inference jobs that the algorithm runs, including the following:
The Amazon ECR paths of containers that contain the inference code and model artifacts.
The instance types that the algorithm supports for transform jobs and real-time endpoints used for inference.
The input and output content formats that the algorithm supports for inference.
Containers (list) -- [REQUIRED]
The Amazon ECR registry path of the Docker image that contains the inference code.
(dict) --
Describes the Docker container for the model package.
ContainerHostname (string) --
The DNS host name for the Docker container.
Image (string) -- [REQUIRED]
The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.
If you are using your own custom algorithm instead of an algorithm provided by Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.
ImageDigest (string) --
An MD5 hash of the training algorithm that identifies the Docker image used for training.
ModelDataUrl (string) --
The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive ( .tar.gz suffix).
Note
The model artifacts must be in an S3 bucket that is in the same region as the model package.
ProductId (string) --
The AWS Marketplace product ID of the model package.
SupportedTransformInstanceTypes (list) -- [REQUIRED]
A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.
(string) --
SupportedRealtimeInferenceInstanceTypes (list) -- [REQUIRED]
A list of the instance types that are used to generate inferences in real-time.
(string) --
SupportedContentTypes (list) -- [REQUIRED]
The supported MIME types for the input data.
(string) --
SupportedResponseMIMETypes (list) -- [REQUIRED]
The supported MIME types for the output data.
(string) --
dict
Specifies configurations for one or more training jobs and that Amazon SageMaker runs to test the algorithm's training code and, optionally, one or more batch transform jobs that Amazon SageMaker runs to test the algorithm's inference code.
ValidationRole (string) -- [REQUIRED]
The IAM roles that Amazon SageMaker uses to run the training jobs.
ValidationProfiles (list) -- [REQUIRED]
An array of AlgorithmValidationProfile objects, each of which specifies a training job and batch transform job that Amazon SageMaker runs to validate your algorithm.
(dict) --
Defines a training job and a batch transform job that Amazon SageMaker runs to validate your algorithm.
The data provided in the validation profile is made available to your buyers on AWS Marketplace.
ProfileName (string) -- [REQUIRED]
The name of the profile for the algorithm. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).
TrainingJobDefinition (dict) -- [REQUIRED]
The TrainingJobDefinition object that describes the training job that Amazon SageMaker runs to validate your algorithm.
TrainingInputMode (string) -- [REQUIRED]
The input mode used by the algorithm for the training job. For the input modes that Amazon SageMaker algorithms support, see Algorithms.
If an algorithm supports the File input mode, Amazon SageMaker downloads the training data from S3 to the provisioned ML storage Volume, and mounts the directory to docker volume for training container. If an algorithm supports the Pipe input mode, Amazon SageMaker streams data directly from S3 to the container.
HyperParameters (dict) --
The hyperparameters used for the training job.
(string) --
(string) --
InputDataConfig (list) -- [REQUIRED]
An array of Channel objects, each of which specifies an input source.
(dict) --
A channel is a named input source that training algorithms can consume.
ChannelName (string) -- [REQUIRED]
The name of the channel.
DataSource (dict) -- [REQUIRED]
The location of the channel data.
S3DataSource (dict) --
The S3 location of the data source that is associated with a channel.
S3DataType (string) -- [REQUIRED]
If you choose S3Prefix , S3Uri identifies a key name prefix. Amazon SageMaker uses all objects that match the specified key name prefix for model training.
If you choose ManifestFile , S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for model training.
If you choose AugmentedManifestFile , S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel's input mode is Pipe .
S3Uri (string) -- [REQUIRED]
Depending on the value specified for the S3DataType , identifies either a key name prefix or a manifest. For example:
A key name prefix might look like this: s3://bucketname/exampleprefix
A manifest might look like this: s3://bucketname/example.manifest A manifest is an S3 object which is a JSON file consisting of an array of elements. The first element is a prefix which is followed by one or more suffixes. SageMaker appends the suffix elements to the prefix to get a full set of S3Uri . Note that the prefix must be a valid non-empty S3Uri that precludes users from specifying a manifest whose individual S3Uri is sourced from different S3 buckets. The following code example shows a valid manifest format: [ {"prefix": "s3://customer_bucket/some/prefix/"}, "relative/path/to/custdata-1", "relative/path/custdata-2", ... "relative/path/custdata-N" ] This JSON is equivalent to the following S3Uri list: s3://customer_bucket/some/prefix/relative/path/to/custdata-1 s3://customer_bucket/some/prefix/relative/path/custdata-2 ... s3://customer_bucket/some/prefix/relative/path/custdata-N The complete set of S3Uri in this manifest is the input data for the channel for this data source. The object that each S3Uri points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.
S3DataDistributionType (string) --
If you want Amazon SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated .
If you want Amazon SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key . If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data.
Don't choose more ML compute instances for training than available S3 objects. If you do, some nodes won't get any data and you will pay for nodes that aren't getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms.
In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key . If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File ), this copies 1/n of the number of objects.
AttributeNames (list) --
A list of one or more attribute names to use that are found in a specified augmented manifest file.
(string) --
FileSystemDataSource (dict) --
The file system that is associated with a channel.
FileSystemId (string) -- [REQUIRED]
The file system id.
FileSystemAccessMode (string) -- [REQUIRED]
The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write) mode.
FileSystemType (string) -- [REQUIRED]
The file system type.
DirectoryPath (string) -- [REQUIRED]
The full path to the directory to associate with the channel.
ContentType (string) --
The MIME type of the data.
CompressionType (string) --
If training data is compressed, the compression type. The default value is None . CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None.
RecordWrapperType (string) --
Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, Amazon SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.
In File mode, leave this field unset or set it to None.
InputMode (string) --
(Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode , Amazon SageMaker uses the value set for TrainingInputMode . Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.
To use a model for incremental training, choose File input model.
ShuffleConfig (dict) --
A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType , this shuffles the results of the S3 key prefix matches. If you use ManifestFile , the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile , the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.
For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key , the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.
Seed (integer) -- [REQUIRED]
Determines the shuffling order in ShuffleConfig value.
OutputDataConfig (dict) -- [REQUIRED]
the path to the S3 bucket where you want to store model artifacts. Amazon SageMaker creates subfolders for the artifacts.
KmsKeyId (string) --
The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:
// KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab"
// Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
// KMS Key Alias "alias/ExampleAlias"
// Amazon Resource Name (ARN) of a KMS Key Alias "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt . If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig . If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms" . For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob , CreateTransformJob , or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide .
S3OutputPath (string) -- [REQUIRED]
Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix .
ResourceConfig (dict) -- [REQUIRED]
The resources, including the ML compute instances and ML storage volumes, to use for model training.
InstanceType (string) -- [REQUIRED]
The ML compute instance type.
InstanceCount (integer) -- [REQUIRED]
The number of ML compute instances to use. For distributed training, provide a value greater than 1.
VolumeSizeInGB (integer) -- [REQUIRED]
The size of the ML storage volume that you want to provision.
ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.
You must specify sufficient ML storage for your scenario.
Note
Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.
Note
Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for training, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a VolumeSizeInGB greater than the total size of the local instance storage.
For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.
VolumeKmsKeyId (string) --
The AWS KMS key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job.
Note
Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
For more information about local instance storage encryption, see SSD Instance Store Volumes.
The VolumeKmsKeyId can be in any of the following formats:
// KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab"
// Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
StoppingCondition (dict) -- [REQUIRED]
Specifies a limit to how long a model training job can run. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.
To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts.
MaxRuntimeInSeconds (integer) --
The maximum length of time, in seconds, that the training or compilation job can run. If job does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. The maximum value is 28 days.
MaxWaitTimeInSeconds (integer) --
The maximum length of time, in seconds, how long you are willing to wait for a managed spot training job to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the training job runs. It must be equal to or greater than MaxRuntimeInSeconds .
TransformJobDefinition (dict) --
The TransformJobDefinition object that describes the transform job that Amazon SageMaker runs to validate your algorithm.
MaxConcurrentTransforms (integer) --
The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1.
MaxPayloadInMB (integer) --
The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata).
BatchStrategy (string) --
A string that determines the number of records included in a single mini-batch.
SingleRecord means only one record is used per mini-batch. MultiRecord means a mini-batch is set to contain as many records that can fit within the MaxPayloadInMB limit.
Environment (dict) --
The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.
(string) --
(string) --
TransformInput (dict) -- [REQUIRED]
A description of the input source and the way the transform job consumes it.
DataSource (dict) -- [REQUIRED]
Describes the location of the channel data, which is, the S3 location of the input data that the model can consume.
S3DataSource (dict) -- [REQUIRED]
The S3 location of the data source that is associated with a channel.
S3DataType (string) -- [REQUIRED]
If you choose S3Prefix , S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for batch transform.
If you choose ManifestFile , S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for batch transform.
The following values are compatible: ManifestFile , S3Prefix
The following value is not compatible: AugmentedManifestFile
S3Uri (string) -- [REQUIRED]
Depending on the value specified for the S3DataType , identifies either a key name prefix or a manifest. For example:
A key name prefix might look like this: s3://bucketname/exampleprefix .
A manifest might look like this: s3://bucketname/example.manifest The manifest is an S3 object which is a JSON file with the following format: [ {"prefix": "s3://customer_bucket/some/prefix/"}, "relative/path/to/custdata-1", "relative/path/custdata-2", ... "relative/path/custdata-N" ] The preceding JSON matches the following S3Uris : s3://customer_bucket/some/prefix/relative/path/to/custdata-1 s3://customer_bucket/some/prefix/relative/path/custdata-2 ... s3://customer_bucket/some/prefix/relative/path/custdata-N The complete set of S3Uris in this manifest constitutes the input data for the channel for this datasource. The object that each S3Uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.
ContentType (string) --
The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job.
CompressionType (string) --
If your transform data is compressed, specify the compression type. Amazon SageMaker automatically decompresses the data for the transform job accordingly. The default value is None .
SplitType (string) --
The method to use to split the transform job's data files into smaller batches. Splitting is necessary when the total size of each object is too large to fit in a single request. You can also use data splitting to improve performance by processing multiple concurrent mini-batches. The default value for SplitType is None , which indicates that input data files are not split, and request payloads contain the entire contents of an input object. Set the value of this parameter to Line to split records on a newline character boundary. SplitType also supports a number of record-oriented binary data formats. Currently, the supported record formats are:
RecordIO
TFRecord
When splitting is enabled, the size of a mini-batch depends on the values of the BatchStrategy and MaxPayloadInMB parameters. When the value of BatchStrategy is MultiRecord , Amazon SageMaker sends the maximum number of records in each request, up to the MaxPayloadInMB limit. If the value of BatchStrategy is SingleRecord , Amazon SageMaker sends individual records in each request.
Note
Some data formats represent a record as a binary payload wrapped with extra padding bytes. When splitting is applied to a binary data format, padding is removed if the value of BatchStrategy is set to SingleRecord . Padding is not removed if the value of BatchStrategy is set to MultiRecord .
For more information about RecordIO , see Create a Dataset Using RecordIO in the MXNet documentation. For more information about TFRecord , see Consuming TFRecord data in the TensorFlow documentation.
TransformOutput (dict) -- [REQUIRED]
Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
S3OutputPath (string) -- [REQUIRED]
The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For example, s3://bucket-name/key-name-prefix .
For every S3 object used as input for the transform job, batch transform stores the transformed data with an . out suffix in a corresponding subfolder in the location in the output prefix. For example, for the input data stored at s3://bucket-name/input-name-prefix/dataset01/data.csv , batch transform stores the transformed data at s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out . Batch transform doesn't upload partially processed objects. For an input S3 object that contains multiple records, it creates an . out file only if the transform job succeeds on the entire file. When the input contains multiple S3 objects, the batch transform job processes the listed S3 objects and uploads only the output for successfully processed objects. If any object fails in the transform job batch transform marks the job as failed to prompt investigation.
Accept (string) --
The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job.
AssembleWith (string) --
Defines how to assemble the results of the transform job as a single S3 object. Choose a format that is most convenient to you. To concatenate the results in binary format, specify None . To add a newline character at the end of every transformed record, specify Line .
KmsKeyId (string) --
The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
The KMS key policy must grant permission to the IAM role that you specify in your CreateModel request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide .
TransformResources (dict) -- [REQUIRED]
Identifies the ML compute instances for the transform job.
InstanceType (string) -- [REQUIRED]
The ML compute instance type for the transform job. If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or ml.m5.large instance types.
InstanceCount (integer) -- [REQUIRED]
The number of ML compute instances to use in the transform job. For distributed transform jobs, specify a value greater than 1. The default value is 1 .
VolumeKmsKeyId (string) --
The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform job. The VolumeKmsKeyId can be any of the following formats:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
boolean
Whether to certify the algorithm so that it can be listed in AWS Marketplace.
dict
Response Syntax
{ 'AlgorithmArn': 'string' }
Response Structure
(dict) --
AlgorithmArn (string) --
The Amazon Resource Name (ARN) of the new algorithm.
{'ResourceSpec': {'SageMakerImageVersionArn': 'string'}}
Creates a running App for the specified UserProfile. Supported Apps are JupyterServer and KernelGateway. This operation is automatically invoked by Amazon SageMaker Studio upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.
See also: AWS API Documentation
Request Syntax
client.create_app( DomainId='string', UserProfileName='string', AppType='JupyterServer'|'KernelGateway'|'TensorBoard', AppName='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ], ResourceSpec={ 'SageMakerImageArn': 'string', 'SageMakerImageVersionArn': 'string', 'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge' } )
string
[REQUIRED]
The domain ID.
string
[REQUIRED]
The user profile name.
string
[REQUIRED]
The type of app.
string
[REQUIRED]
The name of the app.
list
Each tag consists of a key and an optional value. Tag keys must be unique per resource.
(dict) --
Describes a tag.
Key (string) -- [REQUIRED]
The tag key.
Value (string) -- [REQUIRED]
The tag value.
dict
The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
SageMakerImageArn (string) --
The ARN of the SageMaker image that the image version belongs to.
SageMakerImageVersionArn (string) --
The ARN of the image version created on the instance.
InstanceType (string) --
The instance type that the image version runs on.
dict
Response Syntax
{ 'AppArn': 'string' }
Response Structure
(dict) --
AppArn (string) --
The Amazon Resource Name (ARN) of the app.
{'InputConfig': {'Framework': {'DARKNET'}}, 'Tags': [{'Key': 'string', 'Value': 'string'}]}
Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.
If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with AWS IoT Greengrass. In that case, deploy them as an ML resource.
In the request body, you provide the following:
A name for the compilation job
Information about the input model artifacts
The output location for the compiled model and the device (target) that the model runs on
The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the model compilation job.
You can also provide a Tag to track the model compilation job's resource use and costs. The response body contains the CompilationJobArn for the compiled job.
To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.
See also: AWS API Documentation
Request Syntax
client.create_compilation_job( CompilationJobName='string', RoleArn='string', InputConfig={ 'S3Uri': 'string', 'DataInputConfig': 'string', 'Framework': 'TENSORFLOW'|'KERAS'|'MXNET'|'ONNX'|'PYTORCH'|'XGBOOST'|'TFLITE'|'DARKNET' }, OutputConfig={ 'S3OutputLocation': 'string', 'TargetDevice': 'lambda'|'ml_m4'|'ml_m5'|'ml_c4'|'ml_c5'|'ml_p2'|'ml_p3'|'ml_g4dn'|'ml_inf1'|'jetson_tx1'|'jetson_tx2'|'jetson_nano'|'jetson_xavier'|'rasp3b'|'imx8qm'|'deeplens'|'rk3399'|'rk3288'|'aisage'|'sbe_c'|'qcs605'|'qcs603'|'sitara_am57x'|'amba_cv22'|'x86_win32'|'x86_win64'|'coreml', 'TargetPlatform': { 'Os': 'ANDROID'|'LINUX', 'Arch': 'X86_64'|'X86'|'ARM64'|'ARM_EABI'|'ARM_EABIHF', 'Accelerator': 'INTEL_GRAPHICS'|'MALI'|'NVIDIA' }, 'CompilerOptions': 'string' }, StoppingCondition={ 'MaxRuntimeInSeconds': 123, 'MaxWaitTimeInSeconds': 123 }, Tags=[ { 'Key': 'string', 'Value': 'string' }, ] )
string
[REQUIRED]
A name for the model compilation job. The name must be unique within the AWS Region and within your AWS account.
string
[REQUIRED]
The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
During model compilation, Amazon SageMaker needs your permission to:
Read input data from an S3 bucket
Write model artifacts to an S3 bucket
Write logs to Amazon CloudWatch Logs
Publish metrics to Amazon CloudWatch
You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.
dict
[REQUIRED]
Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.
S3Uri (string) -- [REQUIRED]
The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).
DataInputConfig (string) -- [REQUIRED]
Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. The data inputs are InputConfig$Framework specific.
TensorFlow : You must specify the name and shape (NHWC format) of the expected data inputs using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.
Examples for one input:
If using the console, {"input":[1,1024,1024,3]}
If using the CLI, {\"input\":[1,1024,1024,3]}
Examples for two inputs:
If using the console, {"data1": [1,28,28,1], "data2":[1,28,28,1]}
If using the CLI, {\"data1\": [1,28,28,1], \"data2\":[1,28,28,1]}
KERAS : You must specify the name and shape (NCHW format) of expected data inputs using a dictionary format for your trained model. Note that while Keras model artifacts should be uploaded in NHWC (channel-last) format, DataInputConfig should be specified in NCHW (channel-first) format. The dictionary formats required for the console and CLI are different.
Examples for one input:
If using the console, {"input_1":[1,3,224,224]}
If using the CLI, {\"input_1\":[1,3,224,224]}
Examples for two inputs:
If using the console, {"input_1": [1,3,224,224], "input_2":[1,3,224,224]}
If using the CLI, {\"input_1\": [1,3,224,224], \"input_2\":[1,3,224,224]}
MXNET/ONNX : You must specify the name and shape (NCHW format) of the expected data inputs in order using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.
Examples for one input:
If using the console, {"data":[1,3,1024,1024]}
If using the CLI, {\"data\":[1,3,1024,1024]}
Examples for two inputs:
If using the console, {"var1": [1,1,28,28], "var2":[1,1,28,28]}
If using the CLI, {\"var1\": [1,1,28,28], \"var2\":[1,1,28,28]}
PyTorch : You can either specify the name and shape (NCHW format) of expected data inputs in order using a dictionary format for your trained model or you can specify the shape only using a list format. The dictionary formats required for the console and CLI are different. The list formats for the console and CLI are the same.
Examples for one input in dictionary format:
If using the console, {"input0":[1,3,224,224]}
If using the CLI, {\"input0\":[1,3,224,224]}
Example for one input in list format: [[1,3,224,224]]
Examples for two inputs in dictionary format:
If using the console, {"input0":[1,3,224,224], "input1":[1,3,224,224]}
If using the CLI, {\"input0\":[1,3,224,224], \"input1\":[1,3,224,224]}
Example for two inputs in list format: [[1,3,224,224], [1,3,224,224]]
XGBOOST : input data name and shape are not needed.
DataInputConfig supports the following parameters for CoreML OutputConfig$TargetDevice (ML Model format):
shape : Input shape, for example {"input_1": {"shape": [1,224,224,3]}} . In addition to static input shapes, CoreML converter supports Flexible input shapes:
Range Dimension. You can use the Range Dimension feature if you know the input shape will be within some specific interval in that dimension, for example: {"input_1": {"shape": ["1..10", 224, 224, 3]}}
Enumerated shapes. Sometimes, the models are trained to work only on a select set of inputs. You can enumerate all supported input shapes, for example: {"input_1": {"shape": [[1, 224, 224, 3], [1, 160, 160, 3]]}}
default_shape : Default input shape. You can set a default shape during conversion for both Range Dimension and Enumerated Shapes. For example {"input_1": {"shape": ["1..10", 224, 224, 3], "default_shape": [1, 224, 224, 3]}}
type : Input type. Allowed values: Image and Tensor . By default, the converter generates an ML Model with inputs of type Tensor (MultiArray). User can set input type to be Image. Image input type requires additional input parameters such as bias and scale .
bias : If the input type is an Image, you need to provide the bias vector.
scale : If the input type is an Image, you need to provide a scale factor.
CoreML ClassifierConfig parameters can be specified using OutputConfig$CompilerOptions. CoreML converter supports Tensorflow and PyTorch models. CoreML conversion examples:
Tensor type input:
"DataInputConfig": {"input_1": {"shape": [[1,224,224,3], [1,160,160,3]], "default_shape": [1,224,224,3]}}
Tensor type input without input name (PyTorch):
"DataInputConfig": [{"shape": [[1,3,224,224], [1,3,160,160]], "default_shape": [1,3,224,224]}]
Image type input:
"DataInputConfig": {"input_1": {"shape": [[1,224,224,3], [1,160,160,3]], "default_shape": [1,224,224,3], "type": "Image", "bias": [-1,-1,-1], "scale": 0.007843137255}}
"CompilerOptions": {"class_labels": "imagenet_labels_1000.txt"}
Image type input without input name (PyTorch):
"DataInputConfig": [{"shape": [[1,3,224,224], [1,3,160,160]], "default_shape": [1,3,224,224], "type": "Image", "bias": [-1,-1,-1], "scale": 0.007843137255}]
"CompilerOptions": {"class_labels": "imagenet_labels_1000.txt"}
Framework (string) -- [REQUIRED]
Identifies the framework in which the model was trained. For example: TENSORFLOW.
dict
[REQUIRED]
Provides information about the output location for the compiled model and the target device the model runs on.
S3OutputLocation (string) -- [REQUIRED]
Identifies the S3 bucket where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix .
TargetDevice (string) --
Identifies the target device or the machine learning instance that you want to run your model on after the compilation has completed. Alternatively, you can specify OS, architecture, and accelerator using TargetPlatform fields. It can be used instead of TargetPlatform .
TargetPlatform (dict) --
Contains information about a target platform that you want your model to run on, such as OS, architecture, and accelerators. It is an alternative of TargetDevice .
The following examples show how to configure the TargetPlatform and CompilerOptions JSON strings for popular target platforms:
Raspberry Pi 3 Model B+ "TargetPlatform": {"Os": "LINUX", "Arch": "ARM_EABIHF"}, "CompilerOptions": {'mattr': ['+neon']}
Jetson TX2 "TargetPlatform": {"Os": "LINUX", "Arch": "ARM64", "Accelerator": "NVIDIA"}, "CompilerOptions": {'gpu-code': 'sm_62', 'trt-ver': '6.0.1', 'cuda-ver': '10.0'}
EC2 m5.2xlarge instance OS "TargetPlatform": {"Os": "LINUX", "Arch": "X86_64", "Accelerator": "NVIDIA"}, "CompilerOptions": {'mcpu': 'skylake-avx512'}
RK3399 "TargetPlatform": {"Os": "LINUX", "Arch": "ARM64", "Accelerator": "MALI"}
ARMv7 phone (CPU) "TargetPlatform": {"Os": "ANDROID", "Arch": "ARM_EABI"}, "CompilerOptions": {'ANDROID_PLATFORM': 25, 'mattr': ['+neon']}
ARMv8 phone (CPU) "TargetPlatform": {"Os": "ANDROID", "Arch": "ARM64"}, "CompilerOptions": {'ANDROID_PLATFORM': 29}
Os (string) -- [REQUIRED]
Specifies a target platform OS.
LINUX : Linux-based operating systems.
ANDROID : Android operating systems. Android API level can be specified using the ANDROID_PLATFORM compiler option. For example, "CompilerOptions": {'ANDROID_PLATFORM': 28}
Arch (string) -- [REQUIRED]
Specifies a target platform architecture.
X86_64 : 64-bit version of the x86 instruction set.
X86 : 32-bit version of the x86 instruction set.
ARM64 : ARMv8 64-bit CPU.
ARM_EABIHF : ARMv7 32-bit, Hard Float.
ARM_EABI : ARMv7 32-bit, Soft Float. Used by Android 32-bit ARM platform.
Accelerator (string) --
Specifies a target platform accelerator (optional).
NVIDIA : Nvidia graphics processing unit. It also requires gpu-code , trt-ver , cuda-ver compiler options
MALI : ARM Mali graphics processor
INTEL_GRAPHICS : Integrated Intel graphics
CompilerOptions (string) --
Specifies additional parameters for compiler options in JSON format. The compiler options are TargetPlatform specific. It is required for NVIDIA accelerators and highly recommended for CPU compilations. For any other cases, it is optional to specify CompilerOptions.
CPU : Compilation for CPU supports the following compiler options.
mcpu : CPU micro-architecture. For example, {'mcpu': 'skylake-avx512'}
mattr : CPU flags. For example, {'mattr': ['+neon', '+vfpv4']}
ARM : Details of ARM CPU compilations.
NEON : NEON is an implementation of the Advanced SIMD extension used in ARMv7 processors. For example, add {'mattr': ['+neon']} to the compiler options if compiling for ARM 32-bit platform with the NEON support.
NVIDIA : Compilation for NVIDIA GPU supports the following compiler options.
gpu_code : Specifies the targeted architecture.
trt-ver : Specifies the TensorRT versions in x.y.z. format.
cuda-ver : Specifies the CUDA version in x.y format.
For example, {'gpu-code': 'sm_72', 'trt-ver': '6.0.1', 'cuda-ver': '10.1'}
ANDROID : Compilation for the Android OS supports the following compiler options:
ANDROID_PLATFORM : Specifies the Android API levels. Available levels range from 21 to 29. For example, {'ANDROID_PLATFORM': 28} .
mattr : Add {'mattr': ['+neon']} to compiler options if compiling for ARM 32-bit platform with NEON support.
INFERENTIA : Compilation for target ml_inf1 uses compiler options passed in as a JSON string. For example, "CompilerOptions": "\"--verbose 1 --num-neuroncores 2 -O2\"" . For information about supported compiler options, see Neuron Compiler CLI.
CoreML : Compilation for the CoreML OutputConfig$TargetDevice supports the following compiler options:
class_labels : Specifies the classification labels file name inside input tar.gz file. For example, {"class_labels": "imagenet_labels_1000.txt"} . Labels inside the txt file should be separated by newlines.
dict
[REQUIRED]
Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.
MaxRuntimeInSeconds (integer) --
The maximum length of time, in seconds, that the training or compilation job can run. If job does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. The maximum value is 28 days.
MaxWaitTimeInSeconds (integer) --
The maximum length of time, in seconds, how long you are willing to wait for a managed spot training job to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the training job runs. It must be equal to or greater than MaxRuntimeInSeconds .
list
An array of key-value pairs that you want to use to organize and track your AWS resource costs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide .
(dict) --
Describes a tag.
Key (string) -- [REQUIRED]
The tag key.
Value (string) -- [REQUIRED]
The tag value.
dict
Response Syntax
{ 'CompilationJobArn': 'string' }
Response Structure
(dict) --
CompilationJobArn (string) --
If the action is successful, the service sends back an HTTP 200 response. Amazon SageMaker returns the following data in JSON format:
CompilationJobArn : The Amazon Resource Name (ARN) of the compiled job.
{'DefaultUserSettings': {'JupyterServerAppSettings': {'DefaultResourceSpec': {'SageMakerImageVersionArn': 'string'}}, 'KernelGatewayAppSettings': {'CustomImages': [{'AppImageConfigName': 'string', 'ImageName': 'string', 'ImageVersionNumber': 'integer'}], 'DefaultResourceSpec': {'SageMakerImageVersionArn': 'string'}}, 'TensorBoardAppSettings': {'DefaultResourceSpec': {'SageMakerImageVersionArn': 'string'}}}}
Creates a Domain used by Amazon SageMaker Studio. A domain consists of an associated Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. An AWS account is limited to one domain per region. Users within a domain can share notebook files and other artifacts with each other.
When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files.
VPC configuration
All SageMaker Studio traffic between the domain and the EFS volume is through the specified VPC and subnets. For other Studio traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to Studio. The following options are available:
PublicInternetOnly - Non-EFS traffic goes through a VPC managed by Amazon SageMaker, which allows internet access. This is the default value.
VpcOnly - All Studio traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway. When internet access is disabled, you won't be able to run a Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker API and runtime or a NAT gateway and your security groups allow outbound connections.
For more information, see Connect SageMaker Studio Notebooks to Resources in a VPC.
See also: AWS API Documentation
Request Syntax
client.create_domain( DomainName='string', AuthMode='SSO'|'IAM', DefaultUserSettings={ 'ExecutionRole': 'string', 'SecurityGroups': [ 'string', ], 'SharingSettings': { 'NotebookOutputOption': 'Allowed'|'Disabled', 'S3OutputPath': 'string', 'S3KmsKeyId': 'string' }, 'JupyterServerAppSettings': { 'DefaultResourceSpec': { 'SageMakerImageArn': 'string', 'SageMakerImageVersionArn': 'string', 'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge' } }, 'KernelGatewayAppSettings': { 'DefaultResourceSpec': { 'SageMakerImageArn': 'string', 'SageMakerImageVersionArn': 'string', 'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge' }, 'CustomImages': [ { 'ImageName': 'string', 'ImageVersionNumber': 123, 'AppImageConfigName': 'string' }, ] }, 'TensorBoardAppSettings': { 'DefaultResourceSpec': { 'SageMakerImageArn': 'string', 'SageMakerImageVersionArn': 'string', 'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge' } } }, SubnetIds=[ 'string', ], VpcId='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ], AppNetworkAccessType='PublicInternetOnly'|'VpcOnly', HomeEfsFileSystemKmsKeyId='string' )
string
[REQUIRED]
A name for the domain.
string
[REQUIRED]
The mode of authentication that members use to access the domain.
dict
[REQUIRED]
The default user settings.
ExecutionRole (string) --
The execution role for the user.
SecurityGroups (list) --
The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly .
Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly .
(string) --
SharingSettings (dict) --
The sharing settings.
NotebookOutputOption (string) --
Whether to include the notebook cell output when sharing the notebook. The default is Disabled .
S3OutputPath (string) --
When NotebookOutputOption is Allowed , the Amazon S3 bucket used to save the notebook cell output.
S3KmsKeyId (string) --
When NotebookOutputOption is Allowed , the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.
JupyterServerAppSettings (dict) --
The Jupyter server's app settings.
DefaultResourceSpec (dict) --
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
SageMakerImageArn (string) --
The ARN of the SageMaker image that the image version belongs to.
SageMakerImageVersionArn (string) --
The ARN of the image version created on the instance.
InstanceType (string) --
The instance type that the image version runs on.
KernelGatewayAppSettings (dict) --
The kernel gateway app settings.
DefaultResourceSpec (dict) --
The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.
SageMakerImageArn (string) --
The ARN of the SageMaker image that the image version belongs to.
SageMakerImageVersionArn (string) --
The ARN of the image version created on the instance.
InstanceType (string) --
The instance type that the image version runs on.
CustomImages (list) --
A list of custom images that are configured to run as a KernelGateway app.
(dict) --
A custom image.
ImageName (string) -- [REQUIRED]
The name of the CustomImage. Must be unique to your account.
ImageVersionNumber (integer) --
The version number of the CustomImage.
AppImageConfigName (string) -- [REQUIRED]
The name of the AppImageConfig.
TensorBoardAppSettings (dict) --
The TensorBoard app settings.
DefaultResourceSpec (dict) --
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
SageMakerImageArn (string) --
The ARN of the SageMaker image that the image version belongs to.
SageMakerImageVersionArn (string) --
The ARN of the image version created on the instance.
InstanceType (string) --
The instance type that the image version runs on.
list
[REQUIRED]
The VPC subnets that Studio uses for communication.
(string) --
string
[REQUIRED]
The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
list
Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.
(dict) --
Describes a tag.
Key (string) -- [REQUIRED]
The tag key.
Value (string) -- [REQUIRED]
The tag value.
string
Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly .
PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access
VpcOnly - All Studio traffic is through the specified VPC and subnets
string
The AWS Key Management Service (KMS) encryption key ID. Encryption with a customer master key (CMK) is not supported.
dict
Response Syntax
{ 'DomainArn': 'string', 'Url': 'string' }
Response Structure
(dict) --
DomainArn (string) --
The Amazon Resource Name (ARN) of the created domain.
Url (string) --
The URL to the created domain.
{'TrainingJobDefinition': {'ResourceConfig': {'InstanceType': {'ml.p4d.24xlarge'}}}, 'TrainingJobDefinitions': {'ResourceConfig': {'InstanceType': {'ml.p4d.24xlarge'}}}}
Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version of a model by running many training jobs on your dataset using the algorithm you choose and values for hyperparameters within ranges that you specify. It then chooses the hyperparameter values that result in a model that performs the best, as measured by an objective metric that you choose.
See also: AWS API Documentation
Request Syntax
client.create_hyper_parameter_tuning_job( HyperParameterTuningJobName='string', HyperParameterTuningJobConfig={ 'Strategy': 'Bayesian'|'Random', 'HyperParameterTuningJobObjective': { 'Type': 'Maximize'|'Minimize', 'MetricName': 'string' }, 'ResourceLimits': { 'MaxNumberOfTrainingJobs': 123, 'MaxParallelTrainingJobs': 123 }, 'ParameterRanges': { 'IntegerParameterRanges': [ { 'Name': 'string', 'MinValue': 'string', 'MaxValue': 'string', 'ScalingType': 'Auto'|'Linear'|'Logarithmic'|'ReverseLogarithmic' }, ], 'ContinuousParameterRanges': [ { 'Name': 'string', 'MinValue': 'string', 'MaxValue': 'string', 'ScalingType': 'Auto'|'Linear'|'Logarithmic'|'ReverseLogarithmic' }, ], 'CategoricalParameterRanges': [ { 'Name': 'string', 'Values': [ 'string', ] }, ] }, 'TrainingJobEarlyStoppingType': 'Off'|'Auto', 'TuningJobCompletionCriteria': { 'TargetObjectiveMetricValue': ... } }, TrainingJobDefinition={ 'DefinitionName': 'string', 'TuningObjective': { 'Type': 'Maximize'|'Minimize', 'MetricName': 'string' }, 'HyperParameterRanges': { 'IntegerParameterRanges': [ { 'Name': 'string', 'MinValue': 'string', 'MaxValue': 'string', 'ScalingType': 'Auto'|'Linear'|'Logarithmic'|'ReverseLogarithmic' }, ], 'ContinuousParameterRanges': [ { 'Name': 'string', 'MinValue': 'string', 'MaxValue': 'string', 'ScalingType': 'Auto'|'Linear'|'Logarithmic'|'ReverseLogarithmic' }, ], 'CategoricalParameterRanges': [ { 'Name': 'string', 'Values': [ 'string', ] }, ] }, 'StaticHyperParameters': { 'string': 'string' }, 'AlgorithmSpecification': { 'TrainingImage': 'string', 'TrainingInputMode': 'Pipe'|'File', 'AlgorithmName': 'string', 'MetricDefinitions': [ { 'Name': 'string', 'Regex': 'string' }, ] }, 'RoleArn': 'string', 'InputDataConfig': [ { 'ChannelName': 'string', 'DataSource': { 'S3DataSource': { 'S3DataType': 'ManifestFile'|'S3Prefix'|'AugmentedManifestFile', 'S3Uri': 'string', 'S3DataDistributionType': 'FullyReplicated'|'ShardedByS3Key', 'AttributeNames': [ 'string', ] }, 'FileSystemDataSource': { 'FileSystemId': 'string', 'FileSystemAccessMode': 'rw'|'ro', 'FileSystemType': 'EFS'|'FSxLustre', 'DirectoryPath': 'string' } }, 'ContentType': 'string', 'CompressionType': 'None'|'Gzip', 'RecordWrapperType': 'None'|'RecordIO', 'InputMode': 'Pipe'|'File', 'ShuffleConfig': { 'Seed': 123 } }, ], 'VpcConfig': { 'SecurityGroupIds': [ 'string', ], 'Subnets': [ 'string', ] }, 'OutputDataConfig': { 'KmsKeyId': 'string', 'S3OutputPath': 'string' }, 'ResourceConfig': { '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.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.p4d.24xlarge'|'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', 'InstanceCount': 123, 'VolumeSizeInGB': 123, 'VolumeKmsKeyId': 'string' }, 'StoppingCondition': { 'MaxRuntimeInSeconds': 123, 'MaxWaitTimeInSeconds': 123 }, 'EnableNetworkIsolation': True|False, 'EnableInterContainerTrafficEncryption': True|False, 'EnableManagedSpotTraining': True|False, 'CheckpointConfig': { 'S3Uri': 'string', 'LocalPath': 'string' } }, TrainingJobDefinitions=[ { 'DefinitionName': 'string', 'TuningObjective': { 'Type': 'Maximize'|'Minimize', 'MetricName': 'string' }, 'HyperParameterRanges': { 'IntegerParameterRanges': [ { 'Name': 'string', 'MinValue': 'string', 'MaxValue': 'string', 'ScalingType': 'Auto'|'Linear'|'Logarithmic'|'ReverseLogarithmic' }, ], 'ContinuousParameterRanges': [ { 'Name': 'string', 'MinValue': 'string', 'MaxValue': 'string', 'ScalingType': 'Auto'|'Linear'|'Logarithmic'|'ReverseLogarithmic' }, ], 'CategoricalParameterRanges': [ { 'Name': 'string', 'Values': [ 'string', ] }, ] }, 'StaticHyperParameters': { 'string': 'string' }, 'AlgorithmSpecification': { 'TrainingImage': 'string', 'TrainingInputMode': 'Pipe'|'File', 'AlgorithmName': 'string', 'MetricDefinitions': [ { 'Name': 'string', 'Regex': 'string' }, ] }, 'RoleArn': 'string', 'InputDataConfig': [ { 'ChannelName': 'string', 'DataSource': { 'S3DataSource': { 'S3DataType': 'ManifestFile'|'S3Prefix'|'AugmentedManifestFile', 'S3Uri': 'string', 'S3DataDistributionType': 'FullyReplicated'|'ShardedByS3Key', 'AttributeNames': [ 'string', ] }, 'FileSystemDataSource': { 'FileSystemId': 'string', 'FileSystemAccessMode': 'rw'|'ro', 'FileSystemType': 'EFS'|'FSxLustre', 'DirectoryPath': 'string' } }, 'ContentType': 'string', 'CompressionType': 'None'|'Gzip', 'RecordWrapperType': 'None'|'RecordIO', 'InputMode': 'Pipe'|'File', 'ShuffleConfig': { 'Seed': 123 } }, ], 'VpcConfig': { 'SecurityGroupIds': [ 'string', ], 'Subnets': [ 'string', ] }, 'OutputDataConfig': { 'KmsKeyId': 'string', 'S3OutputPath': 'string' }, 'ResourceConfig': { '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.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.p4d.24xlarge'|'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', 'InstanceCount': 123, 'VolumeSizeInGB': 123, 'VolumeKmsKeyId': 'string' }, 'StoppingCondition': { 'MaxRuntimeInSeconds': 123, 'MaxWaitTimeInSeconds': 123 }, 'EnableNetworkIsolation': True|False, 'EnableInterContainerTrafficEncryption': True|False, 'EnableManagedSpotTraining': True|False, 'CheckpointConfig': { 'S3Uri': 'string', 'LocalPath': 'string' } }, ], WarmStartConfig={ 'ParentHyperParameterTuningJobs': [ { 'HyperParameterTuningJobName': 'string' }, ], 'WarmStartType': 'IdenticalDataAndAlgorithm'|'TransferLearning' }, Tags=[ { 'Key': 'string', 'Value': 'string' }, ] )
string
[REQUIRED]
The name of the tuning job. This name is the prefix for the names of all training jobs that this tuning job launches. The name must be unique within the same AWS account and AWS Region. The name must have 1 to 32 characters. Valid characters are a-z, A-Z, 0-9, and : + = @ _ % - (hyphen). The name is not case sensitive.
dict
[REQUIRED]
The HyperParameterTuningJobConfig object that describes the tuning job, including the search strategy, the objective metric used to evaluate training jobs, ranges of parameters to search, and resource limits for the tuning job. For more information, see How Hyperparameter Tuning Works.
Strategy (string) -- [REQUIRED]
Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training job it launches. To use the Bayesian search strategy, set this to Bayesian . To randomly search, set it to Random . For information about search strategies, see How Hyperparameter Tuning Works.
HyperParameterTuningJobObjective (dict) --
The HyperParameterTuningJobObjective object that specifies the objective metric for this tuning job.
Type (string) -- [REQUIRED]
Whether to minimize or maximize the objective metric.
MetricName (string) -- [REQUIRED]
The name of the metric to use for the objective metric.
ResourceLimits (dict) -- [REQUIRED]
The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs for this tuning job.
MaxNumberOfTrainingJobs (integer) -- [REQUIRED]
The maximum number of training jobs that a hyperparameter tuning job can launch.
MaxParallelTrainingJobs (integer) -- [REQUIRED]
The maximum number of concurrent training jobs that a hyperparameter tuning job can launch.
ParameterRanges (dict) --
The ParameterRanges object that specifies the ranges of hyperparameters that this tuning job searches.
IntegerParameterRanges (list) --
The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.
(dict) --
For a hyperparameter of the integer type, specifies the range that a hyperparameter tuning job searches.
Name (string) -- [REQUIRED]
The name of the hyperparameter to search.
MinValue (string) -- [REQUIRED]
The minimum value of the hyperparameter to search.
MaxValue (string) -- [REQUIRED]
The maximum value of the hyperparameter to search.
ScalingType (string) --
The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
Auto
Amazon SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.
Linear
Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
Logarithmic
Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.
Logarithmic scaling works only for ranges that have only values greater than 0.
ContinuousParameterRanges (list) --
The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.
(dict) --
A list of continuous hyperparameters to tune.
Name (string) -- [REQUIRED]
The name of the continuous hyperparameter to tune.
MinValue (string) -- [REQUIRED]
The minimum value for the hyperparameter. The tuning job uses floating-point values between this value and MaxValue for tuning.
MaxValue (string) -- [REQUIRED]
The maximum value for the hyperparameter. The tuning job uses floating-point values between MinValue value and this value for tuning.
ScalingType (string) --
The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
Auto
Amazon SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.
Linear
Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
Logarithmic
Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.
Logarithmic scaling works only for ranges that have only values greater than 0.
ReverseLogarithmic
Hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale.
Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0.
CategoricalParameterRanges (list) --
The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.
(dict) --
A list of categorical hyperparameters to tune.
Name (string) -- [REQUIRED]
The name of the categorical hyperparameter to tune.
Values (list) -- [REQUIRED]
A list of the categories for the hyperparameter.
(string) --
TrainingJobEarlyStoppingType (string) --
Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job. This can be one of the following values (the default value is OFF ):
OFF
Training jobs launched by the hyperparameter tuning job do not use early stopping.
AUTO
Amazon SageMaker stops training jobs launched by the hyperparameter tuning job when they are unlikely to perform better than previously completed training jobs. For more information, see Stop Training Jobs Early.
TuningJobCompletionCriteria (dict) --
The tuning job's completion criteria.
TargetObjectiveMetricValue (float) -- [REQUIRED]
The value of the objective metric.
dict
The HyperParameterTrainingJobDefinition object that describes the training jobs that this tuning job launches, including static hyperparameters, input data configuration, output data configuration, resource configuration, and stopping condition.
DefinitionName (string) --
The job definition name.
TuningObjective (dict) --
Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning uses the value of this metric to evaluate the training jobs it launches, and returns the training job that results in either the highest or lowest value for this metric, depending on the value you specify for the Type parameter.
Type (string) -- [REQUIRED]
Whether to minimize or maximize the objective metric.
MetricName (string) -- [REQUIRED]
The name of the metric to use for the objective metric.
HyperParameterRanges (dict) --
Specifies ranges of integer, continuous, and categorical hyperparameters that a hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs with hyperparameter values within these ranges to find the combination of values that result in the training job with the best performance as measured by the objective metric of the hyperparameter tuning job.
Note
You can specify a maximum of 20 hyperparameters that a hyperparameter tuning job can search over. Every possible value of a categorical parameter range counts against this limit.
IntegerParameterRanges (list) --
The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.
(dict) --
For a hyperparameter of the integer type, specifies the range that a hyperparameter tuning job searches.
Name (string) -- [REQUIRED]
The name of the hyperparameter to search.
MinValue (string) -- [REQUIRED]
The minimum value of the hyperparameter to search.
MaxValue (string) -- [REQUIRED]
The maximum value of the hyperparameter to search.
ScalingType (string) --
The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
Auto
Amazon SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.
Linear
Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
Logarithmic
Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.
Logarithmic scaling works only for ranges that have only values greater than 0.
ContinuousParameterRanges (list) --
The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.
(dict) --
A list of continuous hyperparameters to tune.
Name (string) -- [REQUIRED]
The name of the continuous hyperparameter to tune.
MinValue (string) -- [REQUIRED]
The minimum value for the hyperparameter. The tuning job uses floating-point values between this value and MaxValue for tuning.
MaxValue (string) -- [REQUIRED]
The maximum value for the hyperparameter. The tuning job uses floating-point values between MinValue value and this value for tuning.
ScalingType (string) --
The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
Auto
Amazon SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.
Linear
Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
Logarithmic
Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.
Logarithmic scaling works only for ranges that have only values greater than 0.
ReverseLogarithmic
Hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale.
Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0.
CategoricalParameterRanges (list) --
The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.
(dict) --
A list of categorical hyperparameters to tune.
Name (string) -- [REQUIRED]
The name of the categorical hyperparameter to tune.
Values (list) -- [REQUIRED]
A list of the categories for the hyperparameter.
(string) --
StaticHyperParameters (dict) --
Specifies the values of hyperparameters that do not change for the tuning job.
(string) --
(string) --
AlgorithmSpecification (dict) -- [REQUIRED]
The HyperParameterAlgorithmSpecification object that specifies the resource algorithm to use for the training jobs that the tuning job launches.
TrainingImage (string) --
The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.
TrainingInputMode (string) -- [REQUIRED]
The input mode that the algorithm supports: File or Pipe. In File input mode, Amazon SageMaker downloads the training data from Amazon S3 to the storage volume that is attached to the training instance and mounts the directory to the Docker volume for the training container. In Pipe input mode, Amazon SageMaker streams data directly from Amazon S3 to the container.
If you specify File mode, make sure that you provision the storage volume that is attached to the training instance with enough capacity to accommodate the training data downloaded from Amazon S3, the model artifacts, and intermediate information.
For more information about input modes, see Algorithms.
AlgorithmName (string) --
The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage .
MetricDefinitions (list) --
An array of MetricDefinition objects that specify the metrics that the algorithm emits.
(dict) --
Specifies a metric that the training algorithm writes to stderr or stdout . Amazon SageMakerhyperparameter tuning captures all defined metrics. You specify one metric that a hyperparameter tuning job uses as its objective metric to choose the best training job.
Name (string) -- [REQUIRED]
The name of the metric.
Regex (string) -- [REQUIRED]
A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining Objective Metrics.
RoleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the IAM role associated with the training jobs that the tuning job launches.
InputDataConfig (list) --
An array of Channel objects that specify the input for the training jobs that the tuning job launches.
(dict) --
A channel is a named input source that training algorithms can consume.
ChannelName (string) -- [REQUIRED]
The name of the channel.
DataSource (dict) -- [REQUIRED]
The location of the channel data.
S3DataSource (dict) --
The S3 location of the data source that is associated with a channel.
S3DataType (string) -- [REQUIRED]
If you choose S3Prefix , S3Uri identifies a key name prefix. Amazon SageMaker uses all objects that match the specified key name prefix for model training.
If you choose ManifestFile , S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for model training.
If you choose AugmentedManifestFile , S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel's input mode is Pipe .
S3Uri (string) -- [REQUIRED]
Depending on the value specified for the S3DataType , identifies either a key name prefix or a manifest. For example:
A key name prefix might look like this: s3://bucketname/exampleprefix
A manifest might look like this: s3://bucketname/example.manifest A manifest is an S3 object which is a JSON file consisting of an array of elements. The first element is a prefix which is followed by one or more suffixes. SageMaker appends the suffix elements to the prefix to get a full set of S3Uri . Note that the prefix must be a valid non-empty S3Uri that precludes users from specifying a manifest whose individual S3Uri is sourced from different S3 buckets. The following code example shows a valid manifest format: [ {"prefix": "s3://customer_bucket/some/prefix/"}, "relative/path/to/custdata-1", "relative/path/custdata-2", ... "relative/path/custdata-N" ] This JSON is equivalent to the following S3Uri list: s3://customer_bucket/some/prefix/relative/path/to/custdata-1 s3://customer_bucket/some/prefix/relative/path/custdata-2 ... s3://customer_bucket/some/prefix/relative/path/custdata-N The complete set of S3Uri in this manifest is the input data for the channel for this data source. The object that each S3Uri points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.
S3DataDistributionType (string) --
If you want Amazon SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated .
If you want Amazon SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key . If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data.
Don't choose more ML compute instances for training than available S3 objects. If you do, some nodes won't get any data and you will pay for nodes that aren't getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms.
In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key . If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File ), this copies 1/n of the number of objects.
AttributeNames (list) --
A list of one or more attribute names to use that are found in a specified augmented manifest file.
(string) --
FileSystemDataSource (dict) --
The file system that is associated with a channel.
FileSystemId (string) -- [REQUIRED]
The file system id.
FileSystemAccessMode (string) -- [REQUIRED]
The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write) mode.
FileSystemType (string) -- [REQUIRED]
The file system type.
DirectoryPath (string) -- [REQUIRED]
The full path to the directory to associate with the channel.
ContentType (string) --
The MIME type of the data.
CompressionType (string) --
If training data is compressed, the compression type. The default value is None . CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None.
RecordWrapperType (string) --
Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, Amazon SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.
In File mode, leave this field unset or set it to None.
InputMode (string) --
(Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode , Amazon SageMaker uses the value set for TrainingInputMode . Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.
To use a model for incremental training, choose File input model.
ShuffleConfig (dict) --
A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType , this shuffles the results of the S3 key prefix matches. If you use ManifestFile , the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile , the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.
For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key , the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.
Seed (integer) -- [REQUIRED]
Determines the shuffling order in ShuffleConfig value.
VpcConfig (dict) --
The VpcConfig object that specifies the VPC that you want the training jobs that this hyperparameter tuning job launches to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.
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.
(string) --
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.
(string) --
OutputDataConfig (dict) -- [REQUIRED]
Specifies the path to the Amazon S3 bucket where you store model artifacts from the training jobs that the tuning job launches.
KmsKeyId (string) --
The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:
// KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab"
// Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
// KMS Key Alias "alias/ExampleAlias"
// Amazon Resource Name (ARN) of a KMS Key Alias "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt . If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig . If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms" . For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob , CreateTransformJob , or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide .
S3OutputPath (string) -- [REQUIRED]
Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix .
ResourceConfig (dict) -- [REQUIRED]
The resources, including the compute instances and storage volumes, to use for the training jobs that the tuning job launches.
Storage volumes store model artifacts and incremental states. Training algorithms might also use storage volumes for scratch space. If you want Amazon SageMaker to use the storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.
InstanceType (string) -- [REQUIRED]
The ML compute instance type.
InstanceCount (integer) -- [REQUIRED]
The number of ML compute instances to use. For distributed training, provide a value greater than 1.
VolumeSizeInGB (integer) -- [REQUIRED]
The size of the ML storage volume that you want to provision.
ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.
You must specify sufficient ML storage for your scenario.
Note
Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.
Note
Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for training, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a VolumeSizeInGB greater than the total size of the local instance storage.
For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.
VolumeKmsKeyId (string) --
The AWS KMS key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job.
Note
Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
For more information about local instance storage encryption, see SSD Instance Store Volumes.
The VolumeKmsKeyId can be in any of the following formats:
// KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab"
// Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
StoppingCondition (dict) -- [REQUIRED]
Specifies a limit to how long a model hyperparameter training job can run. It also specifies how long you are willing to wait for a managed spot training job to complete. When the job reaches the a limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.
MaxRuntimeInSeconds (integer) --
The maximum length of time, in seconds, that the training or compilation job can run. If job does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. The maximum value is 28 days.
MaxWaitTimeInSeconds (integer) --
The maximum length of time, in seconds, how long you are willing to wait for a managed spot training job to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the training job runs. It must be equal to or greater than MaxRuntimeInSeconds .
EnableNetworkIsolation (boolean) --
Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.
EnableInterContainerTrafficEncryption (boolean) --
To encrypt all communications between ML compute instances in distributed training, choose True . Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.
EnableManagedSpotTraining (boolean) --
A Boolean indicating whether managed spot training is enabled ( True ) or not ( False ).
CheckpointConfig (dict) --
Contains information about the output location for managed spot training checkpoint data.
S3Uri (string) -- [REQUIRED]
Identifies the S3 path where you want Amazon SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix .
LocalPath (string) --
(Optional) The local directory where checkpoints are written. The default directory is /opt/ml/checkpoints/ .
list
A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.
(dict) --
Defines the training jobs launched by a hyperparameter tuning job.
DefinitionName (string) --
The job definition name.
TuningObjective (dict) --
Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning uses the value of this metric to evaluate the training jobs it launches, and returns the training job that results in either the highest or lowest value for this metric, depending on the value you specify for the Type parameter.
Type (string) -- [REQUIRED]
Whether to minimize or maximize the objective metric.
MetricName (string) -- [REQUIRED]
The name of the metric to use for the objective metric.
HyperParameterRanges (dict) --
Specifies ranges of integer, continuous, and categorical hyperparameters that a hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs with hyperparameter values within these ranges to find the combination of values that result in the training job with the best performance as measured by the objective metric of the hyperparameter tuning job.
Note
You can specify a maximum of 20 hyperparameters that a hyperparameter tuning job can search over. Every possible value of a categorical parameter range counts against this limit.
IntegerParameterRanges (list) --
The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.
(dict) --
For a hyperparameter of the integer type, specifies the range that a hyperparameter tuning job searches.
Name (string) -- [REQUIRED]
The name of the hyperparameter to search.
MinValue (string) -- [REQUIRED]
The minimum value of the hyperparameter to search.
MaxValue (string) -- [REQUIRED]
The maximum value of the hyperparameter to search.
ScalingType (string) --
The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
Auto
Amazon SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.
Linear
Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
Logarithmic
Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.
Logarithmic scaling works only for ranges that have only values greater than 0.
ContinuousParameterRanges (list) --
The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.
(dict) --
A list of continuous hyperparameters to tune.
Name (string) -- [REQUIRED]
The name of the continuous hyperparameter to tune.
MinValue (string) -- [REQUIRED]
The minimum value for the hyperparameter. The tuning job uses floating-point values between this value and MaxValue for tuning.
MaxValue (string) -- [REQUIRED]
The maximum value for the hyperparameter. The tuning job uses floating-point values between MinValue value and this value for tuning.
ScalingType (string) --
The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
Auto
Amazon SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.
Linear
Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
Logarithmic
Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.
Logarithmic scaling works only for ranges that have only values greater than 0.
ReverseLogarithmic
Hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale.
Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0.
CategoricalParameterRanges (list) --
The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.
(dict) --
A list of categorical hyperparameters to tune.
Name (string) -- [REQUIRED]
The name of the categorical hyperparameter to tune.
Values (list) -- [REQUIRED]
A list of the categories for the hyperparameter.
(string) --
StaticHyperParameters (dict) --
Specifies the values of hyperparameters that do not change for the tuning job.
(string) --
(string) --
AlgorithmSpecification (dict) -- [REQUIRED]
The HyperParameterAlgorithmSpecification object that specifies the resource algorithm to use for the training jobs that the tuning job launches.
TrainingImage (string) --
The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.
TrainingInputMode (string) -- [REQUIRED]
The input mode that the algorithm supports: File or Pipe. In File input mode, Amazon SageMaker downloads the training data from Amazon S3 to the storage volume that is attached to the training instance and mounts the directory to the Docker volume for the training container. In Pipe input mode, Amazon SageMaker streams data directly from Amazon S3 to the container.
If you specify File mode, make sure that you provision the storage volume that is attached to the training instance with enough capacity to accommodate the training data downloaded from Amazon S3, the model artifacts, and intermediate information.
For more information about input modes, see Algorithms.
AlgorithmName (string) --
The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage .
MetricDefinitions (list) --
An array of MetricDefinition objects that specify the metrics that the algorithm emits.
(dict) --
Specifies a metric that the training algorithm writes to stderr or stdout . Amazon SageMakerhyperparameter tuning captures all defined metrics. You specify one metric that a hyperparameter tuning job uses as its objective metric to choose the best training job.
Name (string) -- [REQUIRED]
The name of the metric.
Regex (string) -- [REQUIRED]
A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining Objective Metrics.
RoleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the IAM role associated with the training jobs that the tuning job launches.
InputDataConfig (list) --
An array of Channel objects that specify the input for the training jobs that the tuning job launches.
(dict) --
A channel is a named input source that training algorithms can consume.
ChannelName (string) -- [REQUIRED]
The name of the channel.
DataSource (dict) -- [REQUIRED]
The location of the channel data.
S3DataSource (dict) --
The S3 location of the data source that is associated with a channel.
S3DataType (string) -- [REQUIRED]
If you choose S3Prefix , S3Uri identifies a key name prefix. Amazon SageMaker uses all objects that match the specified key name prefix for model training.
If you choose ManifestFile , S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for model training.
If you choose AugmentedManifestFile , S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel's input mode is Pipe .
S3Uri (string) -- [REQUIRED]
Depending on the value specified for the S3DataType , identifies either a key name prefix or a manifest. For example:
A key name prefix might look like this: s3://bucketname/exampleprefix
A manifest might look like this: s3://bucketname/example.manifest A manifest is an S3 object which is a JSON file consisting of an array of elements. The first element is a prefix which is followed by one or more suffixes. SageMaker appends the suffix elements to the prefix to get a full set of S3Uri . Note that the prefix must be a valid non-empty S3Uri that precludes users from specifying a manifest whose individual S3Uri is sourced from different S3 buckets. The following code example shows a valid manifest format: [ {"prefix": "s3://customer_bucket/some/prefix/"}, "relative/path/to/custdata-1", "relative/path/custdata-2", ... "relative/path/custdata-N" ] This JSON is equivalent to the following S3Uri list: s3://customer_bucket/some/prefix/relative/path/to/custdata-1 s3://customer_bucket/some/prefix/relative/path/custdata-2 ... s3://customer_bucket/some/prefix/relative/path/custdata-N The complete set of S3Uri in this manifest is the input data for the channel for this data source. The object that each S3Uri points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.
S3DataDistributionType (string) --
If you want Amazon SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated .
If you want Amazon SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key . If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data.
Don't choose more ML compute instances for training than available S3 objects. If you do, some nodes won't get any data and you will pay for nodes that aren't getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms.
In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key . If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File ), this copies 1/n of the number of objects.
AttributeNames (list) --
A list of one or more attribute names to use that are found in a specified augmented manifest file.
(string) --
FileSystemDataSource (dict) --
The file system that is associated with a channel.
FileSystemId (string) -- [REQUIRED]
The file system id.
FileSystemAccessMode (string) -- [REQUIRED]
The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write) mode.
FileSystemType (string) -- [REQUIRED]
The file system type.
DirectoryPath (string) -- [REQUIRED]
The full path to the directory to associate with the channel.
ContentType (string) --
The MIME type of the data.
CompressionType (string) --
If training data is compressed, the compression type. The default value is None . CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None.
RecordWrapperType (string) --
Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, Amazon SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.
In File mode, leave this field unset or set it to None.
InputMode (string) --
(Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode , Amazon SageMaker uses the value set for TrainingInputMode . Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.
To use a model for incremental training, choose File input model.
ShuffleConfig (dict) --
A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType , this shuffles the results of the S3 key prefix matches. If you use ManifestFile , the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile , the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.
For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key , the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.
Seed (integer) -- [REQUIRED]
Determines the shuffling order in ShuffleConfig value.
VpcConfig (dict) --
The VpcConfig object that specifies the VPC that you want the training jobs that this hyperparameter tuning job launches to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.
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.
(string) --
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.
(string) --
OutputDataConfig (dict) -- [REQUIRED]
Specifies the path to the Amazon S3 bucket where you store model artifacts from the training jobs that the tuning job launches.
KmsKeyId (string) --
The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:
// KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab"
// Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
// KMS Key Alias "alias/ExampleAlias"
// Amazon Resource Name (ARN) of a KMS Key Alias "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt . If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig . If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms" . For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob , CreateTransformJob , or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide .
S3OutputPath (string) -- [REQUIRED]
Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix .
ResourceConfig (dict) -- [REQUIRED]
The resources, including the compute instances and storage volumes, to use for the training jobs that the tuning job launches.
Storage volumes store model artifacts and incremental states. Training algorithms might also use storage volumes for scratch space. If you want Amazon SageMaker to use the storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.
InstanceType (string) -- [REQUIRED]
The ML compute instance type.
InstanceCount (integer) -- [REQUIRED]
The number of ML compute instances to use. For distributed training, provide a value greater than 1.
VolumeSizeInGB (integer) -- [REQUIRED]
The size of the ML storage volume that you want to provision.
ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.
You must specify sufficient ML storage for your scenario.
Note
Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.
Note
Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for training, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a VolumeSizeInGB greater than the total size of the local instance storage.
For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.
VolumeKmsKeyId (string) --
The AWS KMS key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job.
Note
Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
For more information about local instance storage encryption, see SSD Instance Store Volumes.
The VolumeKmsKeyId can be in any of the following formats:
// KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab"
// Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
StoppingCondition (dict) -- [REQUIRED]
Specifies a limit to how long a model hyperparameter training job can run. It also specifies how long you are willing to wait for a managed spot training job to complete. When the job reaches the a limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.
MaxRuntimeInSeconds (integer) --
The maximum length of time, in seconds, that the training or compilation job can run. If job does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. The maximum value is 28 days.
MaxWaitTimeInSeconds (integer) --
The maximum length of time, in seconds, how long you are willing to wait for a managed spot training job to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the training job runs. It must be equal to or greater than MaxRuntimeInSeconds .
EnableNetworkIsolation (boolean) --
Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.
EnableInterContainerTrafficEncryption (boolean) --
To encrypt all communications between ML compute instances in distributed training, choose True . Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.
EnableManagedSpotTraining (boolean) --
A Boolean indicating whether managed spot training is enabled ( True ) or not ( False ).
CheckpointConfig (dict) --
Contains information about the output location for managed spot training checkpoint data.
S3Uri (string) -- [REQUIRED]
Identifies the S3 path where you want Amazon SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix .
LocalPath (string) --
(Optional) The local directory where checkpoints are written. The default directory is /opt/ml/checkpoints/ .
dict
Specifies the configuration for starting the hyperparameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.
All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric. If you specify IDENTICAL_DATA_AND_ALGORITHM as the WarmStartType value for the warm start configuration, the training job that performs the best in the new tuning job is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.
Note
All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.
ParentHyperParameterTuningJobs (list) -- [REQUIRED]
An array of hyperparameter tuning jobs that are used as the starting point for the new hyperparameter tuning job. For more information about warm starting a hyperparameter tuning job, see Using a Previous Hyperparameter Tuning Job as a Starting Point.
Hyperparameter tuning jobs created before October 1, 2018 cannot be used as parent jobs for warm start tuning jobs.
(dict) --
A previously completed or stopped hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.
HyperParameterTuningJobName (string) --
The name of the hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.
WarmStartType (string) -- [REQUIRED]
Specifies one of the following:
IDENTICAL_DATA_AND_ALGORITHM
The new hyperparameter tuning job uses the same input data and training image as the parent tuning jobs. You can change the hyperparameter ranges to search and the maximum number of training jobs that the hyperparameter tuning job launches. You cannot use a new version of the training algorithm, unless the changes in the new version do not affect the algorithm itself. For example, changes that improve logging or adding support for a different data format are allowed. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.
TRANSFER_LEARNING
The new hyperparameter tuning job can include input data, hyperparameter ranges, maximum number of concurrent training jobs, and maximum number of training jobs that are different than those of its parent hyperparameter tuning jobs. The training image can also be a different version from the version used in the parent hyperparameter tuning job. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.
list
An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see AWS Tagging Strategies.
Tags that you specify for the tuning job are also added to all training jobs that the tuning job launches.
(dict) --
Describes a tag.
Key (string) -- [REQUIRED]
The tag key.
Value (string) -- [REQUIRED]
The tag value.
dict
Response Syntax
{ 'HyperParameterTuningJobArn': 'string' }
Response Structure
(dict) --
HyperParameterTuningJobArn (string) --
The Amazon Resource Name (ARN) of the tuning job. Amazon SageMaker assigns an ARN to a hyperparameter tuning job when you create it.
{'ResourceConfig': {'InstanceType': {'ml.p4d.24xlarge'}}}
Starts a model training job. After training completes, Amazon SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify.
If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than Amazon SageMaker, provided that you know how to use them for inferences.
In the request body, you provide the following:
AlgorithmSpecification - Identifies the training algorithm to use.
HyperParameters - Specify these algorithm-specific parameters to enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by Amazon SageMaker, see Algorithms.
InputDataConfig - Describes the training dataset and the Amazon S3, EFS, or FSx location where it is stored.
OutputDataConfig - Identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of model training.
ResourceConfig - Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance.
EnableManagedSpotTraining - Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see Managed Spot Training.
RoleARN - The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete model training.
StoppingCondition - To help cap training costs, use MaxRuntimeInSeconds to set a time limit for training. Use MaxWaitTimeInSeconds to specify how long you are willing to wait for a managed spot training job to complete.
For more information about Amazon SageMaker, see How It Works.
See also: AWS API Documentation
Request Syntax
client.create_training_job( TrainingJobName='string', HyperParameters={ 'string': 'string' }, AlgorithmSpecification={ 'TrainingImage': 'string', 'AlgorithmName': 'string', 'TrainingInputMode': 'Pipe'|'File', 'MetricDefinitions': [ { 'Name': 'string', 'Regex': 'string' }, ], 'EnableSageMakerMetricsTimeSeries': True|False }, RoleArn='string', InputDataConfig=[ { 'ChannelName': 'string', 'DataSource': { 'S3DataSource': { 'S3DataType': 'ManifestFile'|'S3Prefix'|'AugmentedManifestFile', 'S3Uri': 'string', 'S3DataDistributionType': 'FullyReplicated'|'ShardedByS3Key', 'AttributeNames': [ 'string', ] }, 'FileSystemDataSource': { 'FileSystemId': 'string', 'FileSystemAccessMode': 'rw'|'ro', 'FileSystemType': 'EFS'|'FSxLustre', 'DirectoryPath': 'string' } }, 'ContentType': 'string', 'CompressionType': 'None'|'Gzip', 'RecordWrapperType': 'None'|'RecordIO', 'InputMode': 'Pipe'|'File', 'ShuffleConfig': { 'Seed': 123 } }, ], OutputDataConfig={ 'KmsKeyId': 'string', 'S3OutputPath': 'string' }, ResourceConfig={ '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.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.p4d.24xlarge'|'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', 'InstanceCount': 123, 'VolumeSizeInGB': 123, 'VolumeKmsKeyId': 'string' }, VpcConfig={ 'SecurityGroupIds': [ 'string', ], 'Subnets': [ 'string', ] }, StoppingCondition={ 'MaxRuntimeInSeconds': 123, 'MaxWaitTimeInSeconds': 123 }, Tags=[ { 'Key': 'string', 'Value': 'string' }, ], EnableNetworkIsolation=True|False, EnableInterContainerTrafficEncryption=True|False, EnableManagedSpotTraining=True|False, CheckpointConfig={ 'S3Uri': 'string', 'LocalPath': 'string' }, DebugHookConfig={ 'LocalPath': 'string', 'S3OutputPath': 'string', 'HookParameters': { 'string': 'string' }, 'CollectionConfigurations': [ { 'CollectionName': 'string', 'CollectionParameters': { 'string': 'string' } }, ] }, DebugRuleConfigurations=[ { 'RuleConfigurationName': 'string', 'LocalPath': 'string', 'S3OutputPath': 'string', 'RuleEvaluatorImage': 'string', 'InstanceType': 'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m4.xlarge'|'ml.m4.2xlarge'|'ml.m4.4xlarge'|'ml.m4.10xlarge'|'ml.m4.16xlarge'|'ml.c4.xlarge'|'ml.c4.2xlarge'|'ml.c4.4xlarge'|'ml.c4.8xlarge'|'ml.p2.xlarge'|'ml.p2.8xlarge'|'ml.p2.16xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.12xlarge'|'ml.m5.24xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge', 'VolumeSizeInGB': 123, 'RuleParameters': { 'string': 'string' } }, ], TensorBoardOutputConfig={ 'LocalPath': 'string', 'S3OutputPath': 'string' }, ExperimentConfig={ 'ExperimentName': 'string', 'TrialName': 'string', 'TrialComponentDisplayName': 'string' } )
string
[REQUIRED]
The name of the training job. The name must be unique within an AWS Region in an AWS account.
dict
Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process. For a list of hyperparameters for each training algorithm provided by Amazon SageMaker, see Algorithms.
You can specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value pair. Each key and value is limited to 256 characters, as specified by the Length Constraint .
(string) --
(string) --
dict
[REQUIRED]
The registry path of the Docker image that contains the training algorithm and algorithm-specific metadata, including the input mode. For more information about algorithms provided by Amazon SageMaker, see Algorithms. For information about providing your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.
TrainingImage (string) --
The registry path of the Docker image that contains the training algorithm. For information about docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.
AlgorithmName (string) --
The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on AWS Marketplace. If you specify a value for this parameter, you can't specify a value for TrainingImage .
TrainingInputMode (string) -- [REQUIRED]
The input mode that the algorithm supports. For the input modes that Amazon SageMaker algorithms support, see Algorithms. If an algorithm supports the File input mode, Amazon SageMaker downloads the training data from S3 to the provisioned ML storage Volume, and mounts the directory to docker volume for training container. If an algorithm supports the Pipe input mode, Amazon SageMaker streams data directly from S3 to the container.
In File mode, make sure you provision ML storage volume with sufficient capacity to accommodate the data download from S3. In addition to the training data, the ML storage volume also stores the output model. The algorithm container use ML storage volume to also store intermediate information, if any.
For distributed algorithms using File mode, training data is distributed uniformly, and your training duration is predictable if the input data objects size is approximately same. Amazon SageMaker does not split the files any further for model training. If the object sizes are skewed, training won't be optimal as the data distribution is also skewed where one host in a training cluster is overloaded, thus becoming bottleneck in training.
MetricDefinitions (list) --
A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. Amazon SageMaker publishes each metric to Amazon CloudWatch.
(dict) --
Specifies a metric that the training algorithm writes to stderr or stdout . Amazon SageMakerhyperparameter tuning captures all defined metrics. You specify one metric that a hyperparameter tuning job uses as its objective metric to choose the best training job.
Name (string) -- [REQUIRED]
The name of the metric.
Regex (string) -- [REQUIRED]
A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining Objective Metrics.
EnableSageMakerMetricsTimeSeries (boolean) --
To generate and save time-series metrics during training, set to true . The default is false and time-series metrics aren't generated except in the following cases:
You use one of the Amazon SageMaker built-in algorithms
You use one of the following Prebuilt Amazon SageMaker Docker Images:
Tensorflow (version >= 1.15)
MXNet (version >= 1.6)
PyTorch (version >= 1.3)
You specify at least one MetricDefinition
string
[REQUIRED]
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
During model training, Amazon SageMaker needs your permission to read input data from an S3 bucket, download a Docker image that contains training code, write model artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant permissions for all of these tasks to an IAM role. For more information, see Amazon SageMaker Roles.
Note
To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.
list
An array of Channel objects. Each channel is a named input source. InputDataConfig describes the input data and its location.
Algorithms can accept input data from one or more channels. For example, an algorithm might have two channels of input data, training_data and validation_data . The configuration for each channel provides the S3, EFS, or FSx location where the input data is stored. It also provides information about the stored data: the MIME type, compression method, and whether the data is wrapped in RecordIO format.
Depending on the input mode that the algorithm supports, Amazon SageMaker either copies input data files from an S3 bucket to a local directory in the Docker container, or makes it available as input streams. For example, if you specify an EFS location, input data files will be made available as input streams. They do not need to be downloaded.
(dict) --
A channel is a named input source that training algorithms can consume.
ChannelName (string) -- [REQUIRED]
The name of the channel.
DataSource (dict) -- [REQUIRED]
The location of the channel data.
S3DataSource (dict) --
The S3 location of the data source that is associated with a channel.
S3DataType (string) -- [REQUIRED]
If you choose S3Prefix , S3Uri identifies a key name prefix. Amazon SageMaker uses all objects that match the specified key name prefix for model training.
If you choose ManifestFile , S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for model training.
If you choose AugmentedManifestFile , S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel's input mode is Pipe .
S3Uri (string) -- [REQUIRED]
Depending on the value specified for the S3DataType , identifies either a key name prefix or a manifest. For example:
A key name prefix might look like this: s3://bucketname/exampleprefix
A manifest might look like this: s3://bucketname/example.manifest A manifest is an S3 object which is a JSON file consisting of an array of elements. The first element is a prefix which is followed by one or more suffixes. SageMaker appends the suffix elements to the prefix to get a full set of S3Uri . Note that the prefix must be a valid non-empty S3Uri that precludes users from specifying a manifest whose individual S3Uri is sourced from different S3 buckets. The following code example shows a valid manifest format: [ {"prefix": "s3://customer_bucket/some/prefix/"}, "relative/path/to/custdata-1", "relative/path/custdata-2", ... "relative/path/custdata-N" ] This JSON is equivalent to the following S3Uri list: s3://customer_bucket/some/prefix/relative/path/to/custdata-1 s3://customer_bucket/some/prefix/relative/path/custdata-2 ... s3://customer_bucket/some/prefix/relative/path/custdata-N The complete set of S3Uri in this manifest is the input data for the channel for this data source. The object that each S3Uri points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.
S3DataDistributionType (string) --
If you want Amazon SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated .
If you want Amazon SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key . If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data.
Don't choose more ML compute instances for training than available S3 objects. If you do, some nodes won't get any data and you will pay for nodes that aren't getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms.
In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key . If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File ), this copies 1/n of the number of objects.
AttributeNames (list) --
A list of one or more attribute names to use that are found in a specified augmented manifest file.
(string) --
FileSystemDataSource (dict) --
The file system that is associated with a channel.
FileSystemId (string) -- [REQUIRED]
The file system id.
FileSystemAccessMode (string) -- [REQUIRED]
The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write) mode.
FileSystemType (string) -- [REQUIRED]
The file system type.
DirectoryPath (string) -- [REQUIRED]
The full path to the directory to associate with the channel.
ContentType (string) --
The MIME type of the data.
CompressionType (string) --
If training data is compressed, the compression type. The default value is None . CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None.
RecordWrapperType (string) --
Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, Amazon SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.
In File mode, leave this field unset or set it to None.
InputMode (string) --
(Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode , Amazon SageMaker uses the value set for TrainingInputMode . Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.
To use a model for incremental training, choose File input model.
ShuffleConfig (dict) --
A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType , this shuffles the results of the S3 key prefix matches. If you use ManifestFile , the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile , the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.
For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key , the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.
Seed (integer) -- [REQUIRED]
Determines the shuffling order in ShuffleConfig value.
dict
[REQUIRED]
Specifies the path to the S3 location where you want to store model artifacts. Amazon SageMaker creates subfolders for the artifacts.
KmsKeyId (string) --
The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:
// KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab"
// Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
// KMS Key Alias "alias/ExampleAlias"
// Amazon Resource Name (ARN) of a KMS Key Alias "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt . If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig . If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms" . For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob , CreateTransformJob , or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide .
S3OutputPath (string) -- [REQUIRED]
Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix .
dict
[REQUIRED]
The resources, including the ML compute instances and ML storage volumes, to use for model training.
ML storage volumes store model artifacts and incremental states. Training algorithms might also use ML storage volumes for scratch space. If you want Amazon SageMaker to use the ML storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.
InstanceType (string) -- [REQUIRED]
The ML compute instance type.
InstanceCount (integer) -- [REQUIRED]
The number of ML compute instances to use. For distributed training, provide a value greater than 1.
VolumeSizeInGB (integer) -- [REQUIRED]
The size of the ML storage volume that you want to provision.
ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.
You must specify sufficient ML storage for your scenario.
Note
Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.
Note
Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for training, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a VolumeSizeInGB greater than the total size of the local instance storage.
For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.
VolumeKmsKeyId (string) --
The AWS KMS key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job.
Note
Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
For more information about local instance storage encryption, see SSD Instance Store Volumes.
The VolumeKmsKeyId can be in any of the following formats:
// KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab"
// Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
dict
A VpcConfig object that specifies the VPC that you want your training job to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.
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.
(string) --
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.
(string) --
dict
[REQUIRED]
Specifies a limit to how long a model training job can run. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.
To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.
MaxRuntimeInSeconds (integer) --
The maximum length of time, in seconds, that the training or compilation job can run. If job does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. The maximum value is 28 days.
MaxWaitTimeInSeconds (integer) --
The maximum length of time, in seconds, how long you are willing to wait for a managed spot training job to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the training job runs. It must be equal to or greater than MaxRuntimeInSeconds .
list
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide .
(dict) --
Describes a tag.
Key (string) -- [REQUIRED]
The tag key.
Value (string) -- [REQUIRED]
The tag value.
boolean
Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If you enable network isolation for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.
boolean
To encrypt all communications between ML compute instances in distributed training, choose True . Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training. For more information, see Protect Communications Between ML Compute Instances in a Distributed Training Job.
boolean
To train models using managed spot training, choose True . Managed spot training provides a fully managed and scalable infrastructure for training machine learning models. this option is useful when training jobs can be interrupted and when there is flexibility when the training job is run.
The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be used as a starting point to train models incrementally. Amazon SageMaker provides metrics and logs in CloudWatch. They can be used to see when managed spot training jobs are running, interrupted, resumed, or completed.
dict
Contains information about the output location for managed spot training checkpoint data.
S3Uri (string) -- [REQUIRED]
Identifies the S3 path where you want Amazon SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix .
LocalPath (string) --
(Optional) The local directory where checkpoints are written. The default directory is /opt/ml/checkpoints/ .
dict
Configuration information for the debug hook parameters, collection configuration, and storage paths.
LocalPath (string) --
Path to local storage location for tensors. Defaults to /opt/ml/output/tensors/ .
S3OutputPath (string) -- [REQUIRED]
Path to Amazon S3 storage location for tensors.
HookParameters (dict) --
Configuration information for the debug hook parameters.
(string) --
(string) --
CollectionConfigurations (list) --
Configuration information for tensor collections.
(dict) --
Configuration information for tensor collections.
CollectionName (string) --
The name of the tensor collection. The name must be unique relative to other rule configuration names.
CollectionParameters (dict) --
Parameter values for the tensor collection. The allowed parameters are "name" , "include_regex" , "reduction_config" , "save_config" , "tensor_names" , and "save_histogram" .
(string) --
(string) --
list
Configuration information for debugging rules.
(dict) --
Configuration information for debugging rules.
RuleConfigurationName (string) -- [REQUIRED]
The name of the rule configuration. It must be unique relative to other rule configuration names.
LocalPath (string) --
Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/ .
S3OutputPath (string) --
Path to Amazon S3 storage location for rules.
RuleEvaluatorImage (string) -- [REQUIRED]
The Amazon Elastic Container (ECR) Image for the managed rule evaluation.
InstanceType (string) --
The instance type to deploy for a training job.
VolumeSizeInGB (integer) --
The size, in GB, of the ML storage volume attached to the processing instance.
RuleParameters (dict) --
Runtime configuration for rule container.
(string) --
(string) --
dict
Configuration of storage locations for TensorBoard output.
LocalPath (string) --
Path to local storage location for tensorBoard output. Defaults to /opt/ml/output/tensorboard .
S3OutputPath (string) -- [REQUIRED]
Path to Amazon S3 storage location for TensorBoard output.
dict
Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:
CreateProcessingJob
CreateTrainingJob
CreateTransformJob
ExperimentName (string) --
The name of an existing experiment to associate the trial component with.
TrialName (string) --
The name of an existing trial to associate the trial component with. If not specified, a new trial is created.
TrialComponentDisplayName (string) --
The display name for the trial component. If this key isn't specified, the display name is the trial component name.
dict
Response Syntax
{ 'TrainingJobArn': 'string' }
Response Structure
(dict) --
TrainingJobArn (string) --
The Amazon Resource Name (ARN) of the training job.
{'UserSettings': {'JupyterServerAppSettings': {'DefaultResourceSpec': {'SageMakerImageVersionArn': 'string'}}, 'KernelGatewayAppSettings': {'CustomImages': [{'AppImageConfigName': 'string', 'ImageName': 'string', 'ImageVersionNumber': 'integer'}], 'DefaultResourceSpec': {'SageMakerImageVersionArn': 'string'}}, 'TensorBoardAppSettings': {'DefaultResourceSpec': {'SageMakerImageVersionArn': 'string'}}}}
Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a "person" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to Amazon SageMaker Studio. If an administrator invites a person by email or imports them from SSO, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System (EFS) home directory.
See also: AWS API Documentation
Request Syntax
client.create_user_profile( DomainId='string', UserProfileName='string', SingleSignOnUserIdentifier='string', SingleSignOnUserValue='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ], UserSettings={ 'ExecutionRole': 'string', 'SecurityGroups': [ 'string', ], 'SharingSettings': { 'NotebookOutputOption': 'Allowed'|'Disabled', 'S3OutputPath': 'string', 'S3KmsKeyId': 'string' }, 'JupyterServerAppSettings': { 'DefaultResourceSpec': { 'SageMakerImageArn': 'string', 'SageMakerImageVersionArn': 'string', 'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge' } }, 'KernelGatewayAppSettings': { 'DefaultResourceSpec': { 'SageMakerImageArn': 'string', 'SageMakerImageVersionArn': 'string', 'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge' }, 'CustomImages': [ { 'ImageName': 'string', 'ImageVersionNumber': 123, 'AppImageConfigName': 'string' }, ] }, 'TensorBoardAppSettings': { 'DefaultResourceSpec': { 'SageMakerImageArn': 'string', 'SageMakerImageVersionArn': 'string', 'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge' } } } )
string
[REQUIRED]
The ID of the associated Domain.
string
[REQUIRED]
A name for the UserProfile.
string
A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified.
string
The username of the associated AWS Single Sign-On User for this UserProfile. If the Domain's AuthMode is SSO, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not SSO, this field cannot be specified.
list
Each tag consists of a key and an optional value. Tag keys must be unique per resource.
(dict) --
Describes a tag.
Key (string) -- [REQUIRED]
The tag key.
Value (string) -- [REQUIRED]
The tag value.
dict
A collection of settings.
ExecutionRole (string) --
The execution role for the user.
SecurityGroups (list) --
The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly .
Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly .
(string) --
SharingSettings (dict) --
The sharing settings.
NotebookOutputOption (string) --
Whether to include the notebook cell output when sharing the notebook. The default is Disabled .
S3OutputPath (string) --
When NotebookOutputOption is Allowed , the Amazon S3 bucket used to save the notebook cell output.
S3KmsKeyId (string) --
When NotebookOutputOption is Allowed , the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.
JupyterServerAppSettings (dict) --
The Jupyter server's app settings.
DefaultResourceSpec (dict) --
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
SageMakerImageArn (string) --
The ARN of the SageMaker image that the image version belongs to.
SageMakerImageVersionArn (string) --
The ARN of the image version created on the instance.
InstanceType (string) --
The instance type that the image version runs on.
KernelGatewayAppSettings (dict) --
The kernel gateway app settings.
DefaultResourceSpec (dict) --
The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.
SageMakerImageArn (string) --
The ARN of the SageMaker image that the image version belongs to.
SageMakerImageVersionArn (string) --
The ARN of the image version created on the instance.
InstanceType (string) --
The instance type that the image version runs on.
CustomImages (list) --
A list of custom images that are configured to run as a KernelGateway app.
(dict) --
A custom image.
ImageName (string) -- [REQUIRED]
The name of the CustomImage. Must be unique to your account.
ImageVersionNumber (integer) --
The version number of the CustomImage.
AppImageConfigName (string) -- [REQUIRED]
The name of the AppImageConfig.
TensorBoardAppSettings (dict) --
The TensorBoard app settings.
DefaultResourceSpec (dict) --
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
SageMakerImageArn (string) --
The ARN of the SageMaker image that the image version belongs to.
SageMakerImageVersionArn (string) --
The ARN of the image version created on the instance.
InstanceType (string) --
The instance type that the image version runs on.
dict
Response Syntax
{ 'UserProfileArn': 'string' }
Response Structure
(dict) --
UserProfileArn (string) --
The user profile Amazon Resource Name (ARN).
{'TrainingSpecification': {'SupportedTrainingInstanceTypes': {'ml.p4d.24xlarge'}}, 'ValidationSpecification': {'ValidationProfiles': {'TrainingJobDefinition': {'ResourceConfig': {'InstanceType': {'ml.p4d.24xlarge'}}}}}}
Returns a description of the specified algorithm that is in your account.
See also: AWS API Documentation
Request Syntax
client.describe_algorithm( AlgorithmName='string' )
string
[REQUIRED]
The name of the algorithm to describe.
dict
Response Syntax
{ 'AlgorithmName': 'string', 'AlgorithmArn': 'string', 'AlgorithmDescription': 'string', 'CreationTime': datetime(2015, 1, 1), 'TrainingSpecification': { 'TrainingImage': 'string', 'TrainingImageDigest': 'string', 'SupportedHyperParameters': [ { 'Name': 'string', 'Description': 'string', 'Type': 'Integer'|'Continuous'|'Categorical'|'FreeText', 'Range': { 'IntegerParameterRangeSpecification': { 'MinValue': 'string', 'MaxValue': 'string' }, 'ContinuousParameterRangeSpecification': { 'MinValue': 'string', 'MaxValue': 'string' }, 'CategoricalParameterRangeSpecification': { 'Values': [ 'string', ] } }, 'IsTunable': True|False, 'IsRequired': True|False, 'DefaultValue': 'string' }, ], 'SupportedTrainingInstanceTypes': [ '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.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.p4d.24xlarge'|'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', ], 'SupportsDistributedTraining': True|False, 'MetricDefinitions': [ { 'Name': 'string', 'Regex': 'string' }, ], 'TrainingChannels': [ { 'Name': 'string', 'Description': 'string', 'IsRequired': True|False, 'SupportedContentTypes': [ 'string', ], 'SupportedCompressionTypes': [ 'None'|'Gzip', ], 'SupportedInputModes': [ 'Pipe'|'File', ] }, ], 'SupportedTuningJobObjectiveMetrics': [ { 'Type': 'Maximize'|'Minimize', 'MetricName': 'string' }, ] }, 'InferenceSpecification': { 'Containers': [ { 'ContainerHostname': 'string', 'Image': 'string', 'ImageDigest': 'string', 'ModelDataUrl': 'string', 'ProductId': 'string' }, ], 'SupportedTransformInstanceTypes': [ 'ml.m4.xlarge'|'ml.m4.2xlarge'|'ml.m4.4xlarge'|'ml.m4.10xlarge'|'ml.m4.16xlarge'|'ml.c4.xlarge'|'ml.c4.2xlarge'|'ml.c4.4xlarge'|'ml.c4.8xlarge'|'ml.p2.xlarge'|'ml.p2.8xlarge'|'ml.p2.16xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.12xlarge'|'ml.m5.24xlarge', ], 'SupportedRealtimeInferenceInstanceTypes': [ 'ml.t2.medium'|'ml.t2.large'|'ml.t2.xlarge'|'ml.t2.2xlarge'|'ml.m4.xlarge'|'ml.m4.2xlarge'|'ml.m4.4xlarge'|'ml.m4.10xlarge'|'ml.m4.16xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.12xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.12xlarge'|'ml.m5d.24xlarge'|'ml.c4.large'|'ml.c4.xlarge'|'ml.c4.2xlarge'|'ml.c4.4xlarge'|'ml.c4.8xlarge'|'ml.p2.xlarge'|'ml.p2.8xlarge'|'ml.p2.16xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.18xlarge'|'ml.c5d.large'|'ml.c5d.xlarge'|'ml.c5d.2xlarge'|'ml.c5d.4xlarge'|'ml.c5d.9xlarge'|'ml.c5d.18xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.12xlarge'|'ml.r5.24xlarge'|'ml.r5d.large'|'ml.r5d.xlarge'|'ml.r5d.2xlarge'|'ml.r5d.4xlarge'|'ml.r5d.12xlarge'|'ml.r5d.24xlarge'|'ml.inf1.xlarge'|'ml.inf1.2xlarge'|'ml.inf1.6xlarge'|'ml.inf1.24xlarge', ], 'SupportedContentTypes': [ 'string', ], 'SupportedResponseMIMETypes': [ 'string', ] }, 'ValidationSpecification': { 'ValidationRole': 'string', 'ValidationProfiles': [ { 'ProfileName': 'string', 'TrainingJobDefinition': { 'TrainingInputMode': 'Pipe'|'File', 'HyperParameters': { 'string': 'string' }, 'InputDataConfig': [ { 'ChannelName': 'string', 'DataSource': { 'S3DataSource': { 'S3DataType': 'ManifestFile'|'S3Prefix'|'AugmentedManifestFile', 'S3Uri': 'string', 'S3DataDistributionType': 'FullyReplicated'|'ShardedByS3Key', 'AttributeNames': [ 'string', ] }, 'FileSystemDataSource': { 'FileSystemId': 'string', 'FileSystemAccessMode': 'rw'|'ro', 'FileSystemType': 'EFS'|'FSxLustre', 'DirectoryPath': 'string' } }, 'ContentType': 'string', 'CompressionType': 'None'|'Gzip', 'RecordWrapperType': 'None'|'RecordIO', 'InputMode': 'Pipe'|'File', 'ShuffleConfig': { 'Seed': 123 } }, ], 'OutputDataConfig': { 'KmsKeyId': 'string', 'S3OutputPath': 'string' }, 'ResourceConfig': { '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.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.p4d.24xlarge'|'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', 'InstanceCount': 123, 'VolumeSizeInGB': 123, 'VolumeKmsKeyId': 'string' }, 'StoppingCondition': { 'MaxRuntimeInSeconds': 123, 'MaxWaitTimeInSeconds': 123 } }, 'TransformJobDefinition': { 'MaxConcurrentTransforms': 123, 'MaxPayloadInMB': 123, 'BatchStrategy': 'MultiRecord'|'SingleRecord', 'Environment': { 'string': 'string' }, 'TransformInput': { 'DataSource': { 'S3DataSource': { 'S3DataType': 'ManifestFile'|'S3Prefix'|'AugmentedManifestFile', 'S3Uri': 'string' } }, 'ContentType': 'string', 'CompressionType': 'None'|'Gzip', 'SplitType': 'None'|'Line'|'RecordIO'|'TFRecord' }, 'TransformOutput': { 'S3OutputPath': 'string', 'Accept': 'string', 'AssembleWith': 'None'|'Line', 'KmsKeyId': 'string' }, 'TransformResources': { 'InstanceType': 'ml.m4.xlarge'|'ml.m4.2xlarge'|'ml.m4.4xlarge'|'ml.m4.10xlarge'|'ml.m4.16xlarge'|'ml.c4.xlarge'|'ml.c4.2xlarge'|'ml.c4.4xlarge'|'ml.c4.8xlarge'|'ml.p2.xlarge'|'ml.p2.8xlarge'|'ml.p2.16xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.12xlarge'|'ml.m5.24xlarge', 'InstanceCount': 123, 'VolumeKmsKeyId': 'string' } } }, ] }, 'AlgorithmStatus': 'Pending'|'InProgress'|'Completed'|'Failed'|'Deleting', 'AlgorithmStatusDetails': { 'ValidationStatuses': [ { 'Name': 'string', 'Status': 'NotStarted'|'InProgress'|'Completed'|'Failed', 'FailureReason': 'string' }, ], 'ImageScanStatuses': [ { 'Name': 'string', 'Status': 'NotStarted'|'InProgress'|'Completed'|'Failed', 'FailureReason': 'string' }, ] }, 'ProductId': 'string', 'CertifyForMarketplace': True|False }
Response Structure
(dict) --
AlgorithmName (string) --
The name of the algorithm being described.
AlgorithmArn (string) --
The Amazon Resource Name (ARN) of the algorithm.
AlgorithmDescription (string) --
A brief summary about the algorithm.
CreationTime (datetime) --
A timestamp specifying when the algorithm was created.
TrainingSpecification (dict) --
Details about training jobs run by this algorithm.
TrainingImage (string) --
The Amazon ECR registry path of the Docker image that contains the training algorithm.
TrainingImageDigest (string) --
An MD5 hash of the training algorithm that identifies the Docker image used for training.
SupportedHyperParameters (list) --
A list of the HyperParameterSpecification objects, that define the supported hyperparameters. This is required if the algorithm supports automatic model tuning.>
(dict) --
Defines a hyperparameter to be used by an algorithm.
Name (string) --
The name of this hyperparameter. The name must be unique.
Description (string) --
A brief description of the hyperparameter.
Type (string) --
The type of this hyperparameter. The valid types are Integer , Continuous , Categorical , and FreeText .
Range (dict) --
The allowed range for this hyperparameter.
IntegerParameterRangeSpecification (dict) --
A IntegerParameterRangeSpecification object that defines the possible values for an integer hyperparameter.
MinValue (string) --
The minimum integer value allowed.
MaxValue (string) --
The maximum integer value allowed.
ContinuousParameterRangeSpecification (dict) --
A ContinuousParameterRangeSpecification object that defines the possible values for a continuous hyperparameter.
MinValue (string) --
The minimum floating-point value allowed.
MaxValue (string) --
The maximum floating-point value allowed.
CategoricalParameterRangeSpecification (dict) --
A CategoricalParameterRangeSpecification object that defines the possible values for a categorical hyperparameter.
Values (list) --
The allowed categories for the hyperparameter.
(string) --
IsTunable (boolean) --
Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.
IsRequired (boolean) --
Indicates whether this hyperparameter is required.
DefaultValue (string) --
The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.
SupportedTrainingInstanceTypes (list) --
A list of the instance types that this algorithm can use for training.
(string) --
SupportsDistributedTraining (boolean) --
Indicates whether the algorithm supports distributed training. If set to false, buyers can't request more than one instance during training.
MetricDefinitions (list) --
A list of MetricDefinition objects, which are used for parsing metrics generated by the algorithm.
(dict) --
Specifies a metric that the training algorithm writes to stderr or stdout . Amazon SageMakerhyperparameter tuning captures all defined metrics. You specify one metric that a hyperparameter tuning job uses as its objective metric to choose the best training job.
Name (string) --
The name of the metric.
Regex (string) --
A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining Objective Metrics.
TrainingChannels (list) --
A list of ChannelSpecification objects, which specify the input sources to be used by the algorithm.
(dict) --
Defines a named input source, called a channel, to be used by an algorithm.
Name (string) --
The name of the channel.
Description (string) --
A brief description of the channel.
IsRequired (boolean) --
Indicates whether the channel is required by the algorithm.
SupportedContentTypes (list) --
The supported MIME types for the data.
(string) --
SupportedCompressionTypes (list) --
The allowed compression types, if data compression is used.
(string) --
SupportedInputModes (list) --
The allowed input mode, either FILE or PIPE.
In FILE mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode.
In PIPE mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.
(string) --
SupportedTuningJobObjectiveMetrics (list) --
A list of the metrics that the algorithm emits that can be used as the objective metric in a hyperparameter tuning job.
(dict) --
Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning uses the value of this metric to evaluate the training jobs it launches, and returns the training job that results in either the highest or lowest value for this metric, depending on the value you specify for the Type parameter.
Type (string) --
Whether to minimize or maximize the objective metric.
MetricName (string) --
The name of the metric to use for the objective metric.
InferenceSpecification (dict) --
Details about inference jobs that the algorithm runs.
Containers (list) --
The Amazon ECR registry path of the Docker image that contains the inference code.
(dict) --
Describes the Docker container for the model package.
ContainerHostname (string) --
The DNS host name for the Docker container.
Image (string) --
The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.
If you are using your own custom algorithm instead of an algorithm provided by Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.
ImageDigest (string) --
An MD5 hash of the training algorithm that identifies the Docker image used for training.
ModelDataUrl (string) --
The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive ( .tar.gz suffix).
Note
The model artifacts must be in an S3 bucket that is in the same region as the model package.
ProductId (string) --
The AWS Marketplace product ID of the model package.
SupportedTransformInstanceTypes (list) --
A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.
(string) --
SupportedRealtimeInferenceInstanceTypes (list) --
A list of the instance types that are used to generate inferences in real-time.
(string) --
SupportedContentTypes (list) --
The supported MIME types for the input data.
(string) --
SupportedResponseMIMETypes (list) --
The supported MIME types for the output data.
(string) --
ValidationSpecification (dict) --
Details about configurations for one or more training jobs that Amazon SageMaker runs to test the algorithm.
ValidationRole (string) --
The IAM roles that Amazon SageMaker uses to run the training jobs.
ValidationProfiles (list) --
An array of AlgorithmValidationProfile objects, each of which specifies a training job and batch transform job that Amazon SageMaker runs to validate your algorithm.
(dict) --
Defines a training job and a batch transform job that Amazon SageMaker runs to validate your algorithm.
The data provided in the validation profile is made available to your buyers on AWS Marketplace.
ProfileName (string) --
The name of the profile for the algorithm. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).
TrainingJobDefinition (dict) --
The TrainingJobDefinition object that describes the training job that Amazon SageMaker runs to validate your algorithm.
TrainingInputMode (string) --
The input mode used by the algorithm for the training job. For the input modes that Amazon SageMaker algorithms support, see Algorithms.
If an algorithm supports the File input mode, Amazon SageMaker downloads the training data from S3 to the provisioned ML storage Volume, and mounts the directory to docker volume for training container. If an algorithm supports the Pipe input mode, Amazon SageMaker streams data directly from S3 to the container.
HyperParameters (dict) --
The hyperparameters used for the training job.
(string) --
(string) --
InputDataConfig (list) --
An array of Channel objects, each of which specifies an input source.
(dict) --
A channel is a named input source that training algorithms can consume.
ChannelName (string) --
The name of the channel.
DataSource (dict) --
The location of the channel data.
S3DataSource (dict) --
The S3 location of the data source that is associated with a channel.
S3DataType (string) --
If you choose S3Prefix , S3Uri identifies a key name prefix. Amazon SageMaker uses all objects that match the specified key name prefix for model training.
If you choose ManifestFile , S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for model training.
If you choose AugmentedManifestFile , S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel's input mode is Pipe .
S3Uri (string) --
Depending on the value specified for the S3DataType , identifies either a key name prefix or a manifest. For example:
A key name prefix might look like this: s3://bucketname/exampleprefix
A manifest might look like this: s3://bucketname/example.manifest A manifest is an S3 object which is a JSON file consisting of an array of elements. The first element is a prefix which is followed by one or more suffixes. SageMaker appends the suffix elements to the prefix to get a full set of S3Uri . Note that the prefix must be a valid non-empty S3Uri that precludes users from specifying a manifest whose individual S3Uri is sourced from different S3 buckets. The following code example shows a valid manifest format: [ {"prefix": "s3://customer_bucket/some/prefix/"}, "relative/path/to/custdata-1", "relative/path/custdata-2", ... "relative/path/custdata-N" ] This JSON is equivalent to the following S3Uri list: s3://customer_bucket/some/prefix/relative/path/to/custdata-1 s3://customer_bucket/some/prefix/relative/path/custdata-2 ... s3://customer_bucket/some/prefix/relative/path/custdata-N The complete set of S3Uri in this manifest is the input data for the channel for this data source. The object that each S3Uri points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.
S3DataDistributionType (string) --
If you want Amazon SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated .
If you want Amazon SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key . If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data.
Don't choose more ML compute instances for training than available S3 objects. If you do, some nodes won't get any data and you will pay for nodes that aren't getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms.
In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key . If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File ), this copies 1/n of the number of objects.
AttributeNames (list) --
A list of one or more attribute names to use that are found in a specified augmented manifest file.
(string) --
FileSystemDataSource (dict) --
The file system that is associated with a channel.
FileSystemId (string) --
The file system id.
FileSystemAccessMode (string) --
The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write) mode.
FileSystemType (string) --
The file system type.
DirectoryPath (string) --
The full path to the directory to associate with the channel.
ContentType (string) --
The MIME type of the data.
CompressionType (string) --
If training data is compressed, the compression type. The default value is None . CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None.
RecordWrapperType (string) --
Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, Amazon SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.
In File mode, leave this field unset or set it to None.
InputMode (string) --
(Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode , Amazon SageMaker uses the value set for TrainingInputMode . Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.
To use a model for incremental training, choose File input model.
ShuffleConfig (dict) --
A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType , this shuffles the results of the S3 key prefix matches. If you use ManifestFile , the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile , the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.
For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key , the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.
Seed (integer) --
Determines the shuffling order in ShuffleConfig value.
OutputDataConfig (dict) --
the path to the S3 bucket where you want to store model artifacts. Amazon SageMaker creates subfolders for the artifacts.
KmsKeyId (string) --
The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:
// KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab"
// Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
// KMS Key Alias "alias/ExampleAlias"
// Amazon Resource Name (ARN) of a KMS Key Alias "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt . If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig . If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms" . For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob , CreateTransformJob , or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide .
S3OutputPath (string) --
Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix .
ResourceConfig (dict) --
The resources, including the ML compute instances and ML storage volumes, to use for model training.
InstanceType (string) --
The ML compute instance type.
InstanceCount (integer) --
The number of ML compute instances to use. For distributed training, provide a value greater than 1.
VolumeSizeInGB (integer) --
The size of the ML storage volume that you want to provision.
ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.
You must specify sufficient ML storage for your scenario.
Note
Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.
Note
Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for training, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a VolumeSizeInGB greater than the total size of the local instance storage.
For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.
VolumeKmsKeyId (string) --
The AWS KMS key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job.
Note
Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
For more information about local instance storage encryption, see SSD Instance Store Volumes.
The VolumeKmsKeyId can be in any of the following formats:
// KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab"
// Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
StoppingCondition (dict) --
Specifies a limit to how long a model training job can run. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.
To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts.
MaxRuntimeInSeconds (integer) --
The maximum length of time, in seconds, that the training or compilation job can run. If job does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. The maximum value is 28 days.
MaxWaitTimeInSeconds (integer) --
The maximum length of time, in seconds, how long you are willing to wait for a managed spot training job to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the training job runs. It must be equal to or greater than MaxRuntimeInSeconds .
TransformJobDefinition (dict) --
The TransformJobDefinition object that describes the transform job that Amazon SageMaker runs to validate your algorithm.
MaxConcurrentTransforms (integer) --
The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1.
MaxPayloadInMB (integer) --
The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata).
BatchStrategy (string) --
A string that determines the number of records included in a single mini-batch.
SingleRecord means only one record is used per mini-batch. MultiRecord means a mini-batch is set to contain as many records that can fit within the MaxPayloadInMB limit.
Environment (dict) --
The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.
(string) --
(string) --
TransformInput (dict) --
A description of the input source and the way the transform job consumes it.
DataSource (dict) --
Describes the location of the channel data, which is, the S3 location of the input data that the model can consume.
S3DataSource (dict) --
The S3 location of the data source that is associated with a channel.
S3DataType (string) --
If you choose S3Prefix , S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for batch transform.
If you choose ManifestFile , S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for batch transform.
The following values are compatible: ManifestFile , S3Prefix
The following value is not compatible: AugmentedManifestFile
S3Uri (string) --
Depending on the value specified for the S3DataType , identifies either a key name prefix or a manifest. For example:
A key name prefix might look like this: s3://bucketname/exampleprefix .
A manifest might look like this: s3://bucketname/example.manifest The manifest is an S3 object which is a JSON file with the following format: [ {"prefix": "s3://customer_bucket/some/prefix/"}, "relative/path/to/custdata-1", "relative/path/custdata-2", ... "relative/path/custdata-N" ] The preceding JSON matches the following S3Uris : s3://customer_bucket/some/prefix/relative/path/to/custdata-1 s3://customer_bucket/some/prefix/relative/path/custdata-2 ... s3://customer_bucket/some/prefix/relative/path/custdata-N The complete set of S3Uris in this manifest constitutes the input data for the channel for this datasource. The object that each S3Uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.
ContentType (string) --
The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job.
CompressionType (string) --
If your transform data is compressed, specify the compression type. Amazon SageMaker automatically decompresses the data for the transform job accordingly. The default value is None .
SplitType (string) --
The method to use to split the transform job's data files into smaller batches. Splitting is necessary when the total size of each object is too large to fit in a single request. You can also use data splitting to improve performance by processing multiple concurrent mini-batches. The default value for SplitType is None , which indicates that input data files are not split, and request payloads contain the entire contents of an input object. Set the value of this parameter to Line to split records on a newline character boundary. SplitType also supports a number of record-oriented binary data formats. Currently, the supported record formats are:
RecordIO
TFRecord
When splitting is enabled, the size of a mini-batch depends on the values of the BatchStrategy and MaxPayloadInMB parameters. When the value of BatchStrategy is MultiRecord , Amazon SageMaker sends the maximum number of records in each request, up to the MaxPayloadInMB limit. If the value of BatchStrategy is SingleRecord , Amazon SageMaker sends individual records in each request.
Note
Some data formats represent a record as a binary payload wrapped with extra padding bytes. When splitting is applied to a binary data format, padding is removed if the value of BatchStrategy is set to SingleRecord . Padding is not removed if the value of BatchStrategy is set to MultiRecord .
For more information about RecordIO , see Create a Dataset Using RecordIO in the MXNet documentation. For more information about TFRecord , see Consuming TFRecord data in the TensorFlow documentation.
TransformOutput (dict) --
Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
S3OutputPath (string) --
The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For example, s3://bucket-name/key-name-prefix .
For every S3 object used as input for the transform job, batch transform stores the transformed data with an . out suffix in a corresponding subfolder in the location in the output prefix. For example, for the input data stored at s3://bucket-name/input-name-prefix/dataset01/data.csv , batch transform stores the transformed data at s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out . Batch transform doesn't upload partially processed objects. For an input S3 object that contains multiple records, it creates an . out file only if the transform job succeeds on the entire file. When the input contains multiple S3 objects, the batch transform job processes the listed S3 objects and uploads only the output for successfully processed objects. If any object fails in the transform job batch transform marks the job as failed to prompt investigation.
Accept (string) --
The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job.
AssembleWith (string) --
Defines how to assemble the results of the transform job as a single S3 object. Choose a format that is most convenient to you. To concatenate the results in binary format, specify None . To add a newline character at the end of every transformed record, specify Line .
KmsKeyId (string) --
The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
The KMS key policy must grant permission to the IAM role that you specify in your CreateModel request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide .
TransformResources (dict) --
Identifies the ML compute instances for the transform job.
InstanceType (string) --
The ML compute instance type for the transform job. If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or ml.m5.large instance types.
InstanceCount (integer) --
The number of ML compute instances to use in the transform job. For distributed transform jobs, specify a value greater than 1. The default value is 1 .
VolumeKmsKeyId (string) --
The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform job. The VolumeKmsKeyId can be any of the following formats:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
AlgorithmStatus (string) --
The current status of the algorithm.
AlgorithmStatusDetails (dict) --
Details about the current status of the algorithm.
ValidationStatuses (list) --
The status of algorithm validation.
(dict) --
Represents the overall status of an algorithm.
Name (string) --
The name of the algorithm for which the overall status is being reported.
Status (string) --
The current status.
FailureReason (string) --
if the overall status is Failed , the reason for the failure.
ImageScanStatuses (list) --
The status of the scan of the algorithm's Docker image container.
(dict) --
Represents the overall status of an algorithm.
Name (string) --
The name of the algorithm for which the overall status is being reported.
Status (string) --
The current status.
FailureReason (string) --
if the overall status is Failed , the reason for the failure.
ProductId (string) --
The product identifier of the algorithm.
CertifyForMarketplace (boolean) --
Whether the algorithm is certified to be listed in AWS Marketplace.
{'ResourceSpec': {'SageMakerImageVersionArn': 'string'}}
Describes the app.
See also: AWS API Documentation
Request Syntax
client.describe_app( DomainId='string', UserProfileName='string', AppType='JupyterServer'|'KernelGateway'|'TensorBoard', AppName='string' )
string
[REQUIRED]
The domain ID.
string
[REQUIRED]
The user profile name.
string
[REQUIRED]
The type of app.
string
[REQUIRED]
The name of the app.
dict
Response Syntax
{ 'AppArn': 'string', 'AppType': 'JupyterServer'|'KernelGateway'|'TensorBoard', 'AppName': 'string', 'DomainId': 'string', 'UserProfileName': 'string', 'Status': 'Deleted'|'Deleting'|'Failed'|'InService'|'Pending', 'LastHealthCheckTimestamp': datetime(2015, 1, 1), 'LastUserActivityTimestamp': datetime(2015, 1, 1), 'CreationTime': datetime(2015, 1, 1), 'FailureReason': 'string', 'ResourceSpec': { 'SageMakerImageArn': 'string', 'SageMakerImageVersionArn': 'string', 'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge' } }
Response Structure
(dict) --
AppArn (string) --
The Amazon Resource Name (ARN) of the app.
AppType (string) --
The type of app.
AppName (string) --
The name of the app.
DomainId (string) --
The domain ID.
UserProfileName (string) --
The user profile name.
Status (string) --
The status.
LastHealthCheckTimestamp (datetime) --
The timestamp of the last health check.
LastUserActivityTimestamp (datetime) --
The timestamp of the last user's activity.
CreationTime (datetime) --
The creation time.
FailureReason (string) --
The failure reason.
ResourceSpec (dict) --
The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
SageMakerImageArn (string) --
The ARN of the SageMaker image that the image version belongs to.
SageMakerImageVersionArn (string) --
The ARN of the image version created on the instance.
InstanceType (string) --
The instance type that the image version runs on.
{'InputConfig': {'Framework': {'DARKNET'}}}
Returns information about a model compilation job.
To create a model compilation job, use CreateCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.
See also: AWS API Documentation
Request Syntax
client.describe_compilation_job( CompilationJobName='string' )
string
[REQUIRED]
The name of the model compilation job that you want information about.
dict
Response Syntax
{ 'CompilationJobName': 'string', 'CompilationJobArn': 'string', 'CompilationJobStatus': 'INPROGRESS'|'COMPLETED'|'FAILED'|'STARTING'|'STOPPING'|'STOPPED', 'CompilationStartTime': datetime(2015, 1, 1), 'CompilationEndTime': datetime(2015, 1, 1), 'StoppingCondition': { 'MaxRuntimeInSeconds': 123, 'MaxWaitTimeInSeconds': 123 }, 'CreationTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'FailureReason': 'string', 'ModelArtifacts': { 'S3ModelArtifacts': 'string' }, 'RoleArn': 'string', 'InputConfig': { 'S3Uri': 'string', 'DataInputConfig': 'string', 'Framework': 'TENSORFLOW'|'KERAS'|'MXNET'|'ONNX'|'PYTORCH'|'XGBOOST'|'TFLITE'|'DARKNET' }, 'OutputConfig': { 'S3OutputLocation': 'string', 'TargetDevice': 'lambda'|'ml_m4'|'ml_m5'|'ml_c4'|'ml_c5'|'ml_p2'|'ml_p3'|'ml_g4dn'|'ml_inf1'|'jetson_tx1'|'jetson_tx2'|'jetson_nano'|'jetson_xavier'|'rasp3b'|'imx8qm'|'deeplens'|'rk3399'|'rk3288'|'aisage'|'sbe_c'|'qcs605'|'qcs603'|'sitara_am57x'|'amba_cv22'|'x86_win32'|'x86_win64'|'coreml', 'TargetPlatform': { 'Os': 'ANDROID'|'LINUX', 'Arch': 'X86_64'|'X86'|'ARM64'|'ARM_EABI'|'ARM_EABIHF', 'Accelerator': 'INTEL_GRAPHICS'|'MALI'|'NVIDIA' }, 'CompilerOptions': 'string' } }
Response Structure
(dict) --
CompilationJobName (string) --
The name of the model compilation job.
CompilationJobArn (string) --
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model compilation job.
CompilationJobStatus (string) --
The status of the model compilation job.
CompilationStartTime (datetime) --
The time when the model compilation job started the CompilationJob instances.
You are billed for the time between this timestamp and the timestamp in the DescribeCompilationJobResponse$CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later than this time. That's because it takes time to download the compilation job, which depends on the size of the compilation job container.
CompilationEndTime (datetime) --
The time when the model compilation job on a compilation job instance ended. For a successful or stopped job, this is when the job's model artifacts have finished uploading. For a failed job, this is when Amazon SageMaker detected that the job failed.
StoppingCondition (dict) --
Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.
MaxRuntimeInSeconds (integer) --
The maximum length of time, in seconds, that the training or compilation job can run. If job does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. The maximum value is 28 days.
MaxWaitTimeInSeconds (integer) --
The maximum length of time, in seconds, how long you are willing to wait for a managed spot training job to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the training job runs. It must be equal to or greater than MaxRuntimeInSeconds .
CreationTime (datetime) --
The time that the model compilation job was created.
LastModifiedTime (datetime) --
The time that the status of the model compilation job was last modified.
FailureReason (string) --
If a model compilation job failed, the reason it failed.
ModelArtifacts (dict) --
Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.
S3ModelArtifacts (string) --
The path of the S3 object that contains the model artifacts. For example, s3://bucket-name/keynameprefix/model.tar.gz .
RoleArn (string) --
The Amazon Resource Name (ARN) of the model compilation job.
InputConfig (dict) --
Information about the location in Amazon S3 of the input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.
S3Uri (string) --
The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).
DataInputConfig (string) --
Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. The data inputs are InputConfig$Framework specific.
TensorFlow : You must specify the name and shape (NHWC format) of the expected data inputs using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.
Examples for one input:
If using the console, {"input":[1,1024,1024,3]}
If using the CLI, {\"input\":[1,1024,1024,3]}
Examples for two inputs:
If using the console, {"data1": [1,28,28,1], "data2":[1,28,28,1]}
If using the CLI, {\"data1\": [1,28,28,1], \"data2\":[1,28,28,1]}
KERAS : You must specify the name and shape (NCHW format) of expected data inputs using a dictionary format for your trained model. Note that while Keras model artifacts should be uploaded in NHWC (channel-last) format, DataInputConfig should be specified in NCHW (channel-first) format. The dictionary formats required for the console and CLI are different.
Examples for one input:
If using the console, {"input_1":[1,3,224,224]}
If using the CLI, {\"input_1\":[1,3,224,224]}
Examples for two inputs:
If using the console, {"input_1": [1,3,224,224], "input_2":[1,3,224,224]}
If using the CLI, {\"input_1\": [1,3,224,224], \"input_2\":[1,3,224,224]}
MXNET/ONNX : You must specify the name and shape (NCHW format) of the expected data inputs in order using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.
Examples for one input:
If using the console, {"data":[1,3,1024,1024]}
If using the CLI, {\"data\":[1,3,1024,1024]}
Examples for two inputs:
If using the console, {"var1": [1,1,28,28], "var2":[1,1,28,28]}
If using the CLI, {\"var1\": [1,1,28,28], \"var2\":[1,1,28,28]}
PyTorch : You can either specify the name and shape (NCHW format) of expected data inputs in order using a dictionary format for your trained model or you can specify the shape only using a list format. The dictionary formats required for the console and CLI are different. The list formats for the console and CLI are the same.
Examples for one input in dictionary format:
If using the console, {"input0":[1,3,224,224]}
If using the CLI, {\"input0\":[1,3,224,224]}
Example for one input in list format: [[1,3,224,224]]
Examples for two inputs in dictionary format:
If using the console, {"input0":[1,3,224,224], "input1":[1,3,224,224]}
If using the CLI, {\"input0\":[1,3,224,224], \"input1\":[1,3,224,224]}
Example for two inputs in list format: [[1,3,224,224], [1,3,224,224]]
XGBOOST : input data name and shape are not needed.
DataInputConfig supports the following parameters for CoreML OutputConfig$TargetDevice (ML Model format):
shape : Input shape, for example {"input_1": {"shape": [1,224,224,3]}} . In addition to static input shapes, CoreML converter supports Flexible input shapes:
Range Dimension. You can use the Range Dimension feature if you know the input shape will be within some specific interval in that dimension, for example: {"input_1": {"shape": ["1..10", 224, 224, 3]}}
Enumerated shapes. Sometimes, the models are trained to work only on a select set of inputs. You can enumerate all supported input shapes, for example: {"input_1": {"shape": [[1, 224, 224, 3], [1, 160, 160, 3]]}}
default_shape : Default input shape. You can set a default shape during conversion for both Range Dimension and Enumerated Shapes. For example {"input_1": {"shape": ["1..10", 224, 224, 3], "default_shape": [1, 224, 224, 3]}}
type : Input type. Allowed values: Image and Tensor . By default, the converter generates an ML Model with inputs of type Tensor (MultiArray). User can set input type to be Image. Image input type requires additional input parameters such as bias and scale .
bias : If the input type is an Image, you need to provide the bias vector.
scale : If the input type is an Image, you need to provide a scale factor.
CoreML ClassifierConfig parameters can be specified using OutputConfig$CompilerOptions. CoreML converter supports Tensorflow and PyTorch models. CoreML conversion examples:
Tensor type input:
"DataInputConfig": {"input_1": {"shape": [[1,224,224,3], [1,160,160,3]], "default_shape": [1,224,224,3]}}
Tensor type input without input name (PyTorch):
"DataInputConfig": [{"shape": [[1,3,224,224], [1,3,160,160]], "default_shape": [1,3,224,224]}]
Image type input:
"DataInputConfig": {"input_1": {"shape": [[1,224,224,3], [1,160,160,3]], "default_shape": [1,224,224,3], "type": "Image", "bias": [-1,-1,-1], "scale": 0.007843137255}}
"CompilerOptions": {"class_labels": "imagenet_labels_1000.txt"}
Image type input without input name (PyTorch):
"DataInputConfig": [{"shape": [[1,3,224,224], [1,3,160,160]], "default_shape": [1,3,224,224], "type": "Image", "bias": [-1,-1,-1], "scale": 0.007843137255}]
"CompilerOptions": {"class_labels": "imagenet_labels_1000.txt"}
Framework (string) --
Identifies the framework in which the model was trained. For example: TENSORFLOW.
OutputConfig (dict) --
Information about the output location for the compiled model and the target device that the model runs on.
S3OutputLocation (string) --
Identifies the S3 bucket where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix .
TargetDevice (string) --
Identifies the target device or the machine learning instance that you want to run your model on after the compilation has completed. Alternatively, you can specify OS, architecture, and accelerator using TargetPlatform fields. It can be used instead of TargetPlatform .
TargetPlatform (dict) --
Contains information about a target platform that you want your model to run on, such as OS, architecture, and accelerators. It is an alternative of TargetDevice .
The following examples show how to configure the TargetPlatform and CompilerOptions JSON strings for popular target platforms:
Raspberry Pi 3 Model B+ "TargetPlatform": {"Os": "LINUX", "Arch": "ARM_EABIHF"}, "CompilerOptions": {'mattr': ['+neon']}
Jetson TX2 "TargetPlatform": {"Os": "LINUX", "Arch": "ARM64", "Accelerator": "NVIDIA"}, "CompilerOptions": {'gpu-code': 'sm_62', 'trt-ver': '6.0.1', 'cuda-ver': '10.0'}
EC2 m5.2xlarge instance OS "TargetPlatform": {"Os": "LINUX", "Arch": "X86_64", "Accelerator": "NVIDIA"}, "CompilerOptions": {'mcpu': 'skylake-avx512'}
RK3399 "TargetPlatform": {"Os": "LINUX", "Arch": "ARM64", "Accelerator": "MALI"}
ARMv7 phone (CPU) "TargetPlatform": {"Os": "ANDROID", "Arch": "ARM_EABI"}, "CompilerOptions": {'ANDROID_PLATFORM': 25, 'mattr': ['+neon']}
ARMv8 phone (CPU) "TargetPlatform": {"Os": "ANDROID", "Arch": "ARM64"}, "CompilerOptions": {'ANDROID_PLATFORM': 29}
Os (string) --
Specifies a target platform OS.
LINUX : Linux-based operating systems.
ANDROID : Android operating systems. Android API level can be specified using the ANDROID_PLATFORM compiler option. For example, "CompilerOptions": {'ANDROID_PLATFORM': 28}
Arch (string) --
Specifies a target platform architecture.
X86_64 : 64-bit version of the x86 instruction set.
X86 : 32-bit version of the x86 instruction set.
ARM64 : ARMv8 64-bit CPU.
ARM_EABIHF : ARMv7 32-bit, Hard Float.
ARM_EABI : ARMv7 32-bit, Soft Float. Used by Android 32-bit ARM platform.
Accelerator (string) --
Specifies a target platform accelerator (optional).
NVIDIA : Nvidia graphics processing unit. It also requires gpu-code , trt-ver , cuda-ver compiler options
MALI : ARM Mali graphics processor
INTEL_GRAPHICS : Integrated Intel graphics
CompilerOptions (string) --
Specifies additional parameters for compiler options in JSON format. The compiler options are TargetPlatform specific. It is required for NVIDIA accelerators and highly recommended for CPU compilations. For any other cases, it is optional to specify CompilerOptions.
CPU : Compilation for CPU supports the following compiler options.
mcpu : CPU micro-architecture. For example, {'mcpu': 'skylake-avx512'}
mattr : CPU flags. For example, {'mattr': ['+neon', '+vfpv4']}
ARM : Details of ARM CPU compilations.
NEON : NEON is an implementation of the Advanced SIMD extension used in ARMv7 processors. For example, add {'mattr': ['+neon']} to the compiler options if compiling for ARM 32-bit platform with the NEON support.
NVIDIA : Compilation for NVIDIA GPU supports the following compiler options.
gpu_code : Specifies the targeted architecture.
trt-ver : Specifies the TensorRT versions in x.y.z. format.
cuda-ver : Specifies the CUDA version in x.y format.
For example, {'gpu-code': 'sm_72', 'trt-ver': '6.0.1', 'cuda-ver': '10.1'}
ANDROID : Compilation for the Android OS supports the following compiler options:
ANDROID_PLATFORM : Specifies the Android API levels. Available levels range from 21 to 29. For example, {'ANDROID_PLATFORM': 28} .
mattr : Add {'mattr': ['+neon']} to compiler options if compiling for ARM 32-bit platform with NEON support.
INFERENTIA : Compilation for target ml_inf1 uses compiler options passed in as a JSON string. For example, "CompilerOptions": "\"--verbose 1 --num-neuroncores 2 -O2\"" . For information about supported compiler options, see Neuron Compiler CLI.
CoreML : Compilation for the CoreML OutputConfig$TargetDevice supports the following compiler options:
class_labels : Specifies the classification labels file name inside input tar.gz file. For example, {"class_labels": "imagenet_labels_1000.txt"} . Labels inside the txt file should be separated by newlines.
{'DefaultUserSettings': {'JupyterServerAppSettings': {'DefaultResourceSpec': {'SageMakerImageVersionArn': 'string'}}, 'KernelGatewayAppSettings': {'CustomImages': [{'AppImageConfigName': 'string', 'ImageName': 'string', 'ImageVersionNumber': 'integer'}], 'DefaultResourceSpec': {'SageMakerImageVersionArn': 'string'}}, 'TensorBoardAppSettings': {'DefaultResourceSpec': {'SageMakerImageVersionArn': 'string'}}}, 'Status': {'Updating', 'Delete_Failed', 'Update_Failed'}}
The description of the domain.
See also: AWS API Documentation
Request Syntax
client.describe_domain( DomainId='string' )
string
[REQUIRED]
The domain ID.
dict
Response Syntax
{ 'DomainArn': 'string', 'DomainId': 'string', 'DomainName': 'string', 'HomeEfsFileSystemId': 'string', 'SingleSignOnManagedApplicationInstanceId': 'string', 'Status': 'Deleting'|'Failed'|'InService'|'Pending'|'Updating'|'Update_Failed'|'Delete_Failed', 'CreationTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'FailureReason': 'string', 'AuthMode': 'SSO'|'IAM', 'DefaultUserSettings': { 'ExecutionRole': 'string', 'SecurityGroups': [ 'string', ], 'SharingSettings': { 'NotebookOutputOption': 'Allowed'|'Disabled', 'S3OutputPath': 'string', 'S3KmsKeyId': 'string' }, 'JupyterServerAppSettings': { 'DefaultResourceSpec': { 'SageMakerImageArn': 'string', 'SageMakerImageVersionArn': 'string', 'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge' } }, 'KernelGatewayAppSettings': { 'DefaultResourceSpec': { 'SageMakerImageArn': 'string', 'SageMakerImageVersionArn': 'string', 'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge' }, 'CustomImages': [ { 'ImageName': 'string', 'ImageVersionNumber': 123, 'AppImageConfigName': 'string' }, ] }, 'TensorBoardAppSettings': { 'DefaultResourceSpec': { 'SageMakerImageArn': 'string', 'SageMakerImageVersionArn': 'string', 'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge' } } }, 'AppNetworkAccessType': 'PublicInternetOnly'|'VpcOnly', 'HomeEfsFileSystemKmsKeyId': 'string', 'SubnetIds': [ 'string', ], 'Url': 'string', 'VpcId': 'string' }
Response Structure
(dict) --
DomainArn (string) --
The domain's Amazon Resource Name (ARN).
DomainId (string) --
The domain ID.
DomainName (string) --
The domain name.
HomeEfsFileSystemId (string) --
The ID of the Amazon Elastic File System (EFS) managed by this Domain.
SingleSignOnManagedApplicationInstanceId (string) --
The SSO managed application instance ID.
Status (string) --
The status.
CreationTime (datetime) --
The creation time.
LastModifiedTime (datetime) --
The last modified time.
FailureReason (string) --
The failure reason.
AuthMode (string) --
The domain's authentication mode.
DefaultUserSettings (dict) --
Settings which are applied to all UserProfile in this domain, if settings are not explicitly specified in a given UserProfile.
ExecutionRole (string) --
The execution role for the user.
SecurityGroups (list) --
The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly .
Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly .
(string) --
SharingSettings (dict) --
The sharing settings.
NotebookOutputOption (string) --
Whether to include the notebook cell output when sharing the notebook. The default is Disabled .
S3OutputPath (string) --
When NotebookOutputOption is Allowed , the Amazon S3 bucket used to save the notebook cell output.
S3KmsKeyId (string) --
When NotebookOutputOption is Allowed , the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.
JupyterServerAppSettings (dict) --
The Jupyter server's app settings.
DefaultResourceSpec (dict) --
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
SageMakerImageArn (string) --
The ARN of the SageMaker image that the image version belongs to.
SageMakerImageVersionArn (string) --
The ARN of the image version created on the instance.
InstanceType (string) --
The instance type that the image version runs on.
KernelGatewayAppSettings (dict) --
The kernel gateway app settings.
DefaultResourceSpec (dict) --
The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.
SageMakerImageArn (string) --
The ARN of the SageMaker image that the image version belongs to.
SageMakerImageVersionArn (string) --
The ARN of the image version created on the instance.
InstanceType (string) --
The instance type that the image version runs on.
CustomImages (list) --
A list of custom images that are configured to run as a KernelGateway app.
(dict) --
A custom image.
ImageName (string) --
The name of the CustomImage. Must be unique to your account.
ImageVersionNumber (integer) --
The version number of the CustomImage.
AppImageConfigName (string) --
The name of the AppImageConfig.
TensorBoardAppSettings (dict) --
The TensorBoard app settings.
DefaultResourceSpec (dict) --
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
SageMakerImageArn (string) --
The ARN of the SageMaker image that the image version belongs to.
SageMakerImageVersionArn (string) --
The ARN of the image version created on the instance.
InstanceType (string) --
The instance type that the image version runs on.
AppNetworkAccessType (string) --
Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly .
PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access
VpcOnly - All Studio traffic is through the specified VPC and subnets
HomeEfsFileSystemKmsKeyId (string) --
The AWS Key Management Service encryption key ID.
SubnetIds (list) --
The VPC subnets that Studio uses for communication.
(string) --
Url (string) --
The domain's URL.
VpcId (string) --
The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
{'TrainingJobDefinition': {'ResourceConfig': {'InstanceType': {'ml.p4d.24xlarge'}}}, 'TrainingJobDefinitions': {'ResourceConfig': {'InstanceType': {'ml.p4d.24xlarge'}}}}
Gets a description of a hyperparameter tuning job.
See also: AWS API Documentation
Request Syntax
client.describe_hyper_parameter_tuning_job( HyperParameterTuningJobName='string' )
string
[REQUIRED]
The name of the tuning job.
dict
Response Syntax
{ 'HyperParameterTuningJobName': 'string', 'HyperParameterTuningJobArn': 'string', 'HyperParameterTuningJobConfig': { 'Strategy': 'Bayesian'|'Random', 'HyperParameterTuningJobObjective': { 'Type': 'Maximize'|'Minimize', 'MetricName': 'string' }, 'ResourceLimits': { 'MaxNumberOfTrainingJobs': 123, 'MaxParallelTrainingJobs': 123 }, 'ParameterRanges': { 'IntegerParameterRanges': [ { 'Name': 'string', 'MinValue': 'string', 'MaxValue': 'string', 'ScalingType': 'Auto'|'Linear'|'Logarithmic'|'ReverseLogarithmic' }, ], 'ContinuousParameterRanges': [ { 'Name': 'string', 'MinValue': 'string', 'MaxValue': 'string', 'ScalingType': 'Auto'|'Linear'|'Logarithmic'|'ReverseLogarithmic' }, ], 'CategoricalParameterRanges': [ { 'Name': 'string', 'Values': [ 'string', ] }, ] }, 'TrainingJobEarlyStoppingType': 'Off'|'Auto', 'TuningJobCompletionCriteria': { 'TargetObjectiveMetricValue': ... } }, 'TrainingJobDefinition': { 'DefinitionName': 'string', 'TuningObjective': { 'Type': 'Maximize'|'Minimize', 'MetricName': 'string' }, 'HyperParameterRanges': { 'IntegerParameterRanges': [ { 'Name': 'string', 'MinValue': 'string', 'MaxValue': 'string', 'ScalingType': 'Auto'|'Linear'|'Logarithmic'|'ReverseLogarithmic' }, ], 'ContinuousParameterRanges': [ { 'Name': 'string', 'MinValue': 'string', 'MaxValue': 'string', 'ScalingType': 'Auto'|'Linear'|'Logarithmic'|'ReverseLogarithmic' }, ], 'CategoricalParameterRanges': [ { 'Name': 'string', 'Values': [ 'string', ] }, ] }, 'StaticHyperParameters': { 'string': 'string' }, 'AlgorithmSpecification': { 'TrainingImage': 'string', 'TrainingInputMode': 'Pipe'|'File', 'AlgorithmName': 'string', 'MetricDefinitions': [ { 'Name': 'string', 'Regex': 'string' }, ] }, 'RoleArn': 'string', 'InputDataConfig': [ { 'ChannelName': 'string', 'DataSource': { 'S3DataSource': { 'S3DataType': 'ManifestFile'|'S3Prefix'|'AugmentedManifestFile', 'S3Uri': 'string', 'S3DataDistributionType': 'FullyReplicated'|'ShardedByS3Key', 'AttributeNames': [ 'string', ] }, 'FileSystemDataSource': { 'FileSystemId': 'string', 'FileSystemAccessMode': 'rw'|'ro', 'FileSystemType': 'EFS'|'FSxLustre', 'DirectoryPath': 'string' } }, 'ContentType': 'string', 'CompressionType': 'None'|'Gzip', 'RecordWrapperType': 'None'|'RecordIO', 'InputMode': 'Pipe'|'File', 'ShuffleConfig': { 'Seed': 123 } }, ], 'VpcConfig': { 'SecurityGroupIds': [ 'string', ], 'Subnets': [ 'string', ] }, 'OutputDataConfig': { 'KmsKeyId': 'string', 'S3OutputPath': 'string' }, 'ResourceConfig': { '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.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.p4d.24xlarge'|'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', 'InstanceCount': 123, 'VolumeSizeInGB': 123, 'VolumeKmsKeyId': 'string' }, 'StoppingCondition': { 'MaxRuntimeInSeconds': 123, 'MaxWaitTimeInSeconds': 123 }, 'EnableNetworkIsolation': True|False, 'EnableInterContainerTrafficEncryption': True|False, 'EnableManagedSpotTraining': True|False, 'CheckpointConfig': { 'S3Uri': 'string', 'LocalPath': 'string' } }, 'TrainingJobDefinitions': [ { 'DefinitionName': 'string', 'TuningObjective': { 'Type': 'Maximize'|'Minimize', 'MetricName': 'string' }, 'HyperParameterRanges': { 'IntegerParameterRanges': [ { 'Name': 'string', 'MinValue': 'string', 'MaxValue': 'string', 'ScalingType': 'Auto'|'Linear'|'Logarithmic'|'ReverseLogarithmic' }, ], 'ContinuousParameterRanges': [ { 'Name': 'string', 'MinValue': 'string', 'MaxValue': 'string', 'ScalingType': 'Auto'|'Linear'|'Logarithmic'|'ReverseLogarithmic' }, ], 'CategoricalParameterRanges': [ { 'Name': 'string', 'Values': [ 'string', ] }, ] }, 'StaticHyperParameters': { 'string': 'string' }, 'AlgorithmSpecification': { 'TrainingImage': 'string', 'TrainingInputMode': 'Pipe'|'File', 'AlgorithmName': 'string', 'MetricDefinitions': [ { 'Name': 'string', 'Regex': 'string' }, ] }, 'RoleArn': 'string', 'InputDataConfig': [ { 'ChannelName': 'string', 'DataSource': { 'S3DataSource': { 'S3DataType': 'ManifestFile'|'S3Prefix'|'AugmentedManifestFile', 'S3Uri': 'string', 'S3DataDistributionType': 'FullyReplicated'|'ShardedByS3Key', 'AttributeNames': [ 'string', ] }, 'FileSystemDataSource': { 'FileSystemId': 'string', 'FileSystemAccessMode': 'rw'|'ro', 'FileSystemType': 'EFS'|'FSxLustre', 'DirectoryPath': 'string' } }, 'ContentType': 'string', 'CompressionType': 'None'|'Gzip', 'RecordWrapperType': 'None'|'RecordIO', 'InputMode': 'Pipe'|'File', 'ShuffleConfig': { 'Seed': 123 } }, ], 'VpcConfig': { 'SecurityGroupIds': [ 'string', ], 'Subnets': [ 'string', ] }, 'OutputDataConfig': { 'KmsKeyId': 'string', 'S3OutputPath': 'string' }, 'ResourceConfig': { '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.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.p4d.24xlarge'|'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', 'InstanceCount': 123, 'VolumeSizeInGB': 123, 'VolumeKmsKeyId': 'string' }, 'StoppingCondition': { 'MaxRuntimeInSeconds': 123, 'MaxWaitTimeInSeconds': 123 }, 'EnableNetworkIsolation': True|False, 'EnableInterContainerTrafficEncryption': True|False, 'EnableManagedSpotTraining': True|False, 'CheckpointConfig': { 'S3Uri': 'string', 'LocalPath': 'string' } }, ], 'HyperParameterTuningJobStatus': 'Completed'|'InProgress'|'Failed'|'Stopped'|'Stopping', 'CreationTime': datetime(2015, 1, 1), 'HyperParameterTuningEndTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'TrainingJobStatusCounters': { 'Completed': 123, 'InProgress': 123, 'RetryableError': 123, 'NonRetryableError': 123, 'Stopped': 123 }, 'ObjectiveStatusCounters': { 'Succeeded': 123, 'Pending': 123, 'Failed': 123 }, 'BestTrainingJob': { 'TrainingJobDefinitionName': 'string', 'TrainingJobName': 'string', 'TrainingJobArn': 'string', 'TuningJobName': 'string', 'CreationTime': datetime(2015, 1, 1), 'TrainingStartTime': datetime(2015, 1, 1), 'TrainingEndTime': datetime(2015, 1, 1), 'TrainingJobStatus': 'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped', 'TunedHyperParameters': { 'string': 'string' }, 'FailureReason': 'string', 'FinalHyperParameterTuningJobObjectiveMetric': { 'Type': 'Maximize'|'Minimize', 'MetricName': 'string', 'Value': ... }, 'ObjectiveStatus': 'Succeeded'|'Pending'|'Failed' }, 'OverallBestTrainingJob': { 'TrainingJobDefinitionName': 'string', 'TrainingJobName': 'string', 'TrainingJobArn': 'string', 'TuningJobName': 'string', 'CreationTime': datetime(2015, 1, 1), 'TrainingStartTime': datetime(2015, 1, 1), 'TrainingEndTime': datetime(2015, 1, 1), 'TrainingJobStatus': 'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped', 'TunedHyperParameters': { 'string': 'string' }, 'FailureReason': 'string', 'FinalHyperParameterTuningJobObjectiveMetric': { 'Type': 'Maximize'|'Minimize', 'MetricName': 'string', 'Value': ... }, 'ObjectiveStatus': 'Succeeded'|'Pending'|'Failed' }, 'WarmStartConfig': { 'ParentHyperParameterTuningJobs': [ { 'HyperParameterTuningJobName': 'string' }, ], 'WarmStartType': 'IdenticalDataAndAlgorithm'|'TransferLearning' }, 'FailureReason': 'string' }
Response Structure
(dict) --
HyperParameterTuningJobName (string) --
The name of the tuning job.
HyperParameterTuningJobArn (string) --
The Amazon Resource Name (ARN) of the tuning job.
HyperParameterTuningJobConfig (dict) --
The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.
Strategy (string) --
Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training job it launches. To use the Bayesian search strategy, set this to Bayesian . To randomly search, set it to Random . For information about search strategies, see How Hyperparameter Tuning Works.
HyperParameterTuningJobObjective (dict) --
The HyperParameterTuningJobObjective object that specifies the objective metric for this tuning job.
Type (string) --
Whether to minimize or maximize the objective metric.
MetricName (string) --
The name of the metric to use for the objective metric.
ResourceLimits (dict) --
The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs for this tuning job.
MaxNumberOfTrainingJobs (integer) --
The maximum number of training jobs that a hyperparameter tuning job can launch.
MaxParallelTrainingJobs (integer) --
The maximum number of concurrent training jobs that a hyperparameter tuning job can launch.
ParameterRanges (dict) --
The ParameterRanges object that specifies the ranges of hyperparameters that this tuning job searches.
IntegerParameterRanges (list) --
The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.
(dict) --
For a hyperparameter of the integer type, specifies the range that a hyperparameter tuning job searches.
Name (string) --
The name of the hyperparameter to search.
MinValue (string) --
The minimum value of the hyperparameter to search.
MaxValue (string) --
The maximum value of the hyperparameter to search.
ScalingType (string) --
The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
Auto
Amazon SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.
Linear
Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
Logarithmic
Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.
Logarithmic scaling works only for ranges that have only values greater than 0.
ContinuousParameterRanges (list) --
The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.
(dict) --
A list of continuous hyperparameters to tune.
Name (string) --
The name of the continuous hyperparameter to tune.
MinValue (string) --
The minimum value for the hyperparameter. The tuning job uses floating-point values between this value and MaxValue for tuning.
MaxValue (string) --
The maximum value for the hyperparameter. The tuning job uses floating-point values between MinValue value and this value for tuning.
ScalingType (string) --
The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
Auto
Amazon SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.
Linear
Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
Logarithmic
Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.
Logarithmic scaling works only for ranges that have only values greater than 0.
ReverseLogarithmic
Hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale.
Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0.
CategoricalParameterRanges (list) --
The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.
(dict) --
A list of categorical hyperparameters to tune.
Name (string) --
The name of the categorical hyperparameter to tune.
Values (list) --
A list of the categories for the hyperparameter.
(string) --
TrainingJobEarlyStoppingType (string) --
Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job. This can be one of the following values (the default value is OFF ):
OFF
Training jobs launched by the hyperparameter tuning job do not use early stopping.
AUTO
Amazon SageMaker stops training jobs launched by the hyperparameter tuning job when they are unlikely to perform better than previously completed training jobs. For more information, see Stop Training Jobs Early.
TuningJobCompletionCriteria (dict) --
The tuning job's completion criteria.
TargetObjectiveMetricValue (float) --
The value of the objective metric.
TrainingJobDefinition (dict) --
The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.
DefinitionName (string) --
The job definition name.
TuningObjective (dict) --
Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning uses the value of this metric to evaluate the training jobs it launches, and returns the training job that results in either the highest or lowest value for this metric, depending on the value you specify for the Type parameter.
Type (string) --
Whether to minimize or maximize the objective metric.
MetricName (string) --
The name of the metric to use for the objective metric.
HyperParameterRanges (dict) --
Specifies ranges of integer, continuous, and categorical hyperparameters that a hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs with hyperparameter values within these ranges to find the combination of values that result in the training job with the best performance as measured by the objective metric of the hyperparameter tuning job.
Note
You can specify a maximum of 20 hyperparameters that a hyperparameter tuning job can search over. Every possible value of a categorical parameter range counts against this limit.
IntegerParameterRanges (list) --
The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.
(dict) --
For a hyperparameter of the integer type, specifies the range that a hyperparameter tuning job searches.
Name (string) --
The name of the hyperparameter to search.
MinValue (string) --
The minimum value of the hyperparameter to search.
MaxValue (string) --
The maximum value of the hyperparameter to search.
ScalingType (string) --
The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
Auto
Amazon SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.
Linear
Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
Logarithmic
Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.
Logarithmic scaling works only for ranges that have only values greater than 0.
ContinuousParameterRanges (list) --
The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.
(dict) --
A list of continuous hyperparameters to tune.
Name (string) --
The name of the continuous hyperparameter to tune.
MinValue (string) --
The minimum value for the hyperparameter. The tuning job uses floating-point values between this value and MaxValue for tuning.
MaxValue (string) --
The maximum value for the hyperparameter. The tuning job uses floating-point values between MinValue value and this value for tuning.
ScalingType (string) --
The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
Auto
Amazon SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.
Linear
Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
Logarithmic
Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.
Logarithmic scaling works only for ranges that have only values greater than 0.
ReverseLogarithmic
Hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale.
Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0.
CategoricalParameterRanges (list) --
The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.
(dict) --
A list of categorical hyperparameters to tune.
Name (string) --
The name of the categorical hyperparameter to tune.
Values (list) --
A list of the categories for the hyperparameter.
(string) --
StaticHyperParameters (dict) --
Specifies the values of hyperparameters that do not change for the tuning job.
(string) --
(string) --
AlgorithmSpecification (dict) --
The HyperParameterAlgorithmSpecification object that specifies the resource algorithm to use for the training jobs that the tuning job launches.
TrainingImage (string) --
The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.
TrainingInputMode (string) --
The input mode that the algorithm supports: File or Pipe. In File input mode, Amazon SageMaker downloads the training data from Amazon S3 to the storage volume that is attached to the training instance and mounts the directory to the Docker volume for the training container. In Pipe input mode, Amazon SageMaker streams data directly from Amazon S3 to the container.
If you specify File mode, make sure that you provision the storage volume that is attached to the training instance with enough capacity to accommodate the training data downloaded from Amazon S3, the model artifacts, and intermediate information.
For more information about input modes, see Algorithms.
AlgorithmName (string) --
The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage .
MetricDefinitions (list) --
An array of MetricDefinition objects that specify the metrics that the algorithm emits.
(dict) --
Specifies a metric that the training algorithm writes to stderr or stdout . Amazon SageMakerhyperparameter tuning captures all defined metrics. You specify one metric that a hyperparameter tuning job uses as its objective metric to choose the best training job.
Name (string) --
The name of the metric.
Regex (string) --
A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining Objective Metrics.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role associated with the training jobs that the tuning job launches.
InputDataConfig (list) --
An array of Channel objects that specify the input for the training jobs that the tuning job launches.
(dict) --
A channel is a named input source that training algorithms can consume.
ChannelName (string) --
The name of the channel.
DataSource (dict) --
The location of the channel data.
S3DataSource (dict) --
The S3 location of the data source that is associated with a channel.
S3DataType (string) --
If you choose S3Prefix , S3Uri identifies a key name prefix. Amazon SageMaker uses all objects that match the specified key name prefix for model training.
If you choose ManifestFile , S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for model training.
If you choose AugmentedManifestFile , S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel's input mode is Pipe .
S3Uri (string) --
Depending on the value specified for the S3DataType , identifies either a key name prefix or a manifest. For example:
A key name prefix might look like this: s3://bucketname/exampleprefix
A manifest might look like this: s3://bucketname/example.manifest A manifest is an S3 object which is a JSON file consisting of an array of elements. The first element is a prefix which is followed by one or more suffixes. SageMaker appends the suffix elements to the prefix to get a full set of S3Uri . Note that the prefix must be a valid non-empty S3Uri that precludes users from specifying a manifest whose individual S3Uri is sourced from different S3 buckets. The following code example shows a valid manifest format: [ {"prefix": "s3://customer_bucket/some/prefix/"}, "relative/path/to/custdata-1", "relative/path/custdata-2", ... "relative/path/custdata-N" ] This JSON is equivalent to the following S3Uri list: s3://customer_bucket/some/prefix/relative/path/to/custdata-1 s3://customer_bucket/some/prefix/relative/path/custdata-2 ... s3://customer_bucket/some/prefix/relative/path/custdata-N The complete set of S3Uri in this manifest is the input data for the channel for this data source. The object that each S3Uri points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.
S3DataDistributionType (string) --
If you want Amazon SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated .
If you want Amazon SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key . If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data.
Don't choose more ML compute instances for training than available S3 objects. If you do, some nodes won't get any data and you will pay for nodes that aren't getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms.
In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key . If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File ), this copies 1/n of the number of objects.
AttributeNames (list) --
A list of one or more attribute names to use that are found in a specified augmented manifest file.
(string) --
FileSystemDataSource (dict) --
The file system that is associated with a channel.
FileSystemId (string) --
The file system id.
FileSystemAccessMode (string) --
The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write) mode.
FileSystemType (string) --
The file system type.
DirectoryPath (string) --
The full path to the directory to associate with the channel.
ContentType (string) --
The MIME type of the data.
CompressionType (string) --
If training data is compressed, the compression type. The default value is None . CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None.
RecordWrapperType (string) --
Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, Amazon SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.
In File mode, leave this field unset or set it to None.
InputMode (string) --
(Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode , Amazon SageMaker uses the value set for TrainingInputMode . Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.
To use a model for incremental training, choose File input model.
ShuffleConfig (dict) --
A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType , this shuffles the results of the S3 key prefix matches. If you use ManifestFile , the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile , the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.
For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key , the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.
Seed (integer) --
Determines the shuffling order in ShuffleConfig value.
VpcConfig (dict) --
The VpcConfig object that specifies the VPC that you want the training jobs that this hyperparameter tuning job launches to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.
SecurityGroupIds (list) --
The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
(string) --
Subnets (list) --
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.
(string) --
OutputDataConfig (dict) --
Specifies the path to the Amazon S3 bucket where you store model artifacts from the training jobs that the tuning job launches.
KmsKeyId (string) --
The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:
// KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab"
// Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
// KMS Key Alias "alias/ExampleAlias"
// Amazon Resource Name (ARN) of a KMS Key Alias "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt . If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig . If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms" . For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob , CreateTransformJob , or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide .
S3OutputPath (string) --
Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix .
ResourceConfig (dict) --
The resources, including the compute instances and storage volumes, to use for the training jobs that the tuning job launches.
Storage volumes store model artifacts and incremental states. Training algorithms might also use storage volumes for scratch space. If you want Amazon SageMaker to use the storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.
InstanceType (string) --
The ML compute instance type.
InstanceCount (integer) --
The number of ML compute instances to use. For distributed training, provide a value greater than 1.
VolumeSizeInGB (integer) --
The size of the ML storage volume that you want to provision.
ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.
You must specify sufficient ML storage for your scenario.
Note
Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.
Note
Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for training, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a VolumeSizeInGB greater than the total size of the local instance storage.
For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.
VolumeKmsKeyId (string) --
The AWS KMS key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job.
Note
Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
For more information about local instance storage encryption, see SSD Instance Store Volumes.
The VolumeKmsKeyId can be in any of the following formats:
// KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab"
// Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
StoppingCondition (dict) --
Specifies a limit to how long a model hyperparameter training job can run. It also specifies how long you are willing to wait for a managed spot training job to complete. When the job reaches the a limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.
MaxRuntimeInSeconds (integer) --
The maximum length of time, in seconds, that the training or compilation job can run. If job does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. The maximum value is 28 days.
MaxWaitTimeInSeconds (integer) --
The maximum length of time, in seconds, how long you are willing to wait for a managed spot training job to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the training job runs. It must be equal to or greater than MaxRuntimeInSeconds .
EnableNetworkIsolation (boolean) --
Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.
EnableInterContainerTrafficEncryption (boolean) --
To encrypt all communications between ML compute instances in distributed training, choose True . Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.
EnableManagedSpotTraining (boolean) --
A Boolean indicating whether managed spot training is enabled ( True ) or not ( False ).
CheckpointConfig (dict) --
Contains information about the output location for managed spot training checkpoint data.
S3Uri (string) --
Identifies the S3 path where you want Amazon SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix .
LocalPath (string) --
(Optional) The local directory where checkpoints are written. The default directory is /opt/ml/checkpoints/ .
TrainingJobDefinitions (list) --
A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.
(dict) --
Defines the training jobs launched by a hyperparameter tuning job.
DefinitionName (string) --
The job definition name.
TuningObjective (dict) --
Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning uses the value of this metric to evaluate the training jobs it launches, and returns the training job that results in either the highest or lowest value for this metric, depending on the value you specify for the Type parameter.
Type (string) --
Whether to minimize or maximize the objective metric.
MetricName (string) --
The name of the metric to use for the objective metric.
HyperParameterRanges (dict) --
Specifies ranges of integer, continuous, and categorical hyperparameters that a hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs with hyperparameter values within these ranges to find the combination of values that result in the training job with the best performance as measured by the objective metric of the hyperparameter tuning job.
Note
You can specify a maximum of 20 hyperparameters that a hyperparameter tuning job can search over. Every possible value of a categorical parameter range counts against this limit.
IntegerParameterRanges (list) --
The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.
(dict) --
For a hyperparameter of the integer type, specifies the range that a hyperparameter tuning job searches.
Name (string) --
The name of the hyperparameter to search.
MinValue (string) --
The minimum value of the hyperparameter to search.
MaxValue (string) --
The maximum value of the hyperparameter to search.
ScalingType (string) --
The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
Auto
Amazon SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.
Linear
Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
Logarithmic
Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.
Logarithmic scaling works only for ranges that have only values greater than 0.
ContinuousParameterRanges (list) --
The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.
(dict) --
A list of continuous hyperparameters to tune.
Name (string) --
The name of the continuous hyperparameter to tune.
MinValue (string) --
The minimum value for the hyperparameter. The tuning job uses floating-point values between this value and MaxValue for tuning.
MaxValue (string) --
The maximum value for the hyperparameter. The tuning job uses floating-point values between MinValue value and this value for tuning.
ScalingType (string) --
The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
Auto
Amazon SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.
Linear
Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
Logarithmic
Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.
Logarithmic scaling works only for ranges that have only values greater than 0.
ReverseLogarithmic
Hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale.
Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0.
CategoricalParameterRanges (list) --
The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.
(dict) --
A list of categorical hyperparameters to tune.
Name (string) --
The name of the categorical hyperparameter to tune.
Values (list) --
A list of the categories for the hyperparameter.
(string) --
StaticHyperParameters (dict) --
Specifies the values of hyperparameters that do not change for the tuning job.
(string) --
(string) --
AlgorithmSpecification (dict) --
The HyperParameterAlgorithmSpecification object that specifies the resource algorithm to use for the training jobs that the tuning job launches.
TrainingImage (string) --
The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.
TrainingInputMode (string) --
The input mode that the algorithm supports: File or Pipe. In File input mode, Amazon SageMaker downloads the training data from Amazon S3 to the storage volume that is attached to the training instance and mounts the directory to the Docker volume for the training container. In Pipe input mode, Amazon SageMaker streams data directly from Amazon S3 to the container.
If you specify File mode, make sure that you provision the storage volume that is attached to the training instance with enough capacity to accommodate the training data downloaded from Amazon S3, the model artifacts, and intermediate information.
For more information about input modes, see Algorithms.
AlgorithmName (string) --
The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage .
MetricDefinitions (list) --
An array of MetricDefinition objects that specify the metrics that the algorithm emits.
(dict) --
Specifies a metric that the training algorithm writes to stderr or stdout . Amazon SageMakerhyperparameter tuning captures all defined metrics. You specify one metric that a hyperparameter tuning job uses as its objective metric to choose the best training job.
Name (string) --
The name of the metric.
Regex (string) --
A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining Objective Metrics.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role associated with the training jobs that the tuning job launches.
InputDataConfig (list) --
An array of Channel objects that specify the input for the training jobs that the tuning job launches.
(dict) --
A channel is a named input source that training algorithms can consume.
ChannelName (string) --
The name of the channel.
DataSource (dict) --
The location of the channel data.
S3DataSource (dict) --
The S3 location of the data source that is associated with a channel.
S3DataType (string) --
If you choose S3Prefix , S3Uri identifies a key name prefix. Amazon SageMaker uses all objects that match the specified key name prefix for model training.
If you choose ManifestFile , S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for model training.
If you choose AugmentedManifestFile , S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel's input mode is Pipe .
S3Uri (string) --
Depending on the value specified for the S3DataType , identifies either a key name prefix or a manifest. For example:
A key name prefix might look like this: s3://bucketname/exampleprefix
A manifest might look like this: s3://bucketname/example.manifest A manifest is an S3 object which is a JSON file consisting of an array of elements. The first element is a prefix which is followed by one or more suffixes. SageMaker appends the suffix elements to the prefix to get a full set of S3Uri . Note that the prefix must be a valid non-empty S3Uri that precludes users from specifying a manifest whose individual S3Uri is sourced from different S3 buckets. The following code example shows a valid manifest format: [ {"prefix": "s3://customer_bucket/some/prefix/"}, "relative/path/to/custdata-1", "relative/path/custdata-2", ... "relative/path/custdata-N" ] This JSON is equivalent to the following S3Uri list: s3://customer_bucket/some/prefix/relative/path/to/custdata-1 s3://customer_bucket/some/prefix/relative/path/custdata-2 ... s3://customer_bucket/some/prefix/relative/path/custdata-N The complete set of S3Uri in this manifest is the input data for the channel for this data source. The object that each S3Uri points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.
S3DataDistributionType (string) --
If you want Amazon SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated .
If you want Amazon SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key . If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data.
Don't choose more ML compute instances for training than available S3 objects. If you do, some nodes won't get any data and you will pay for nodes that aren't getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms.
In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key . If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File ), this copies 1/n of the number of objects.
AttributeNames (list) --
A list of one or more attribute names to use that are found in a specified augmented manifest file.
(string) --
FileSystemDataSource (dict) --
The file system that is associated with a channel.
FileSystemId (string) --
The file system id.
FileSystemAccessMode (string) --
The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write) mode.
FileSystemType (string) --
The file system type.
DirectoryPath (string) --
The full path to the directory to associate with the channel.
ContentType (string) --
The MIME type of the data.
CompressionType (string) --
If training data is compressed, the compression type. The default value is None . CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None.
RecordWrapperType (string) --
Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, Amazon SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.
In File mode, leave this field unset or set it to None.
InputMode (string) --
(Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode , Amazon SageMaker uses the value set for TrainingInputMode . Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.
To use a model for incremental training, choose File input model.
ShuffleConfig (dict) --
A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType , this shuffles the results of the S3 key prefix matches. If you use ManifestFile , the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile , the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.
For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key , the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.
Seed (integer) --
Determines the shuffling order in ShuffleConfig value.
VpcConfig (dict) --
The VpcConfig object that specifies the VPC that you want the training jobs that this hyperparameter tuning job launches to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.
SecurityGroupIds (list) --
The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
(string) --
Subnets (list) --
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.
(string) --
OutputDataConfig (dict) --
Specifies the path to the Amazon S3 bucket where you store model artifacts from the training jobs that the tuning job launches.
KmsKeyId (string) --
The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:
// KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab"
// Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
// KMS Key Alias "alias/ExampleAlias"
// Amazon Resource Name (ARN) of a KMS Key Alias "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt . If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig . If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms" . For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob , CreateTransformJob , or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide .
S3OutputPath (string) --
Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix .
ResourceConfig (dict) --
The resources, including the compute instances and storage volumes, to use for the training jobs that the tuning job launches.
Storage volumes store model artifacts and incremental states. Training algorithms might also use storage volumes for scratch space. If you want Amazon SageMaker to use the storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.
InstanceType (string) --
The ML compute instance type.
InstanceCount (integer) --
The number of ML compute instances to use. For distributed training, provide a value greater than 1.
VolumeSizeInGB (integer) --
The size of the ML storage volume that you want to provision.
ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.
You must specify sufficient ML storage for your scenario.
Note
Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.
Note
Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for training, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a VolumeSizeInGB greater than the total size of the local instance storage.
For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.
VolumeKmsKeyId (string) --
The AWS KMS key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job.
Note
Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
For more information about local instance storage encryption, see SSD Instance Store Volumes.
The VolumeKmsKeyId can be in any of the following formats:
// KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab"
// Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
StoppingCondition (dict) --
Specifies a limit to how long a model hyperparameter training job can run. It also specifies how long you are willing to wait for a managed spot training job to complete. When the job reaches the a limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.
MaxRuntimeInSeconds (integer) --
The maximum length of time, in seconds, that the training or compilation job can run. If job does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. The maximum value is 28 days.
MaxWaitTimeInSeconds (integer) --
The maximum length of time, in seconds, how long you are willing to wait for a managed spot training job to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the training job runs. It must be equal to or greater than MaxRuntimeInSeconds .
EnableNetworkIsolation (boolean) --
Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.
EnableInterContainerTrafficEncryption (boolean) --
To encrypt all communications between ML compute instances in distributed training, choose True . Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.
EnableManagedSpotTraining (boolean) --
A Boolean indicating whether managed spot training is enabled ( True ) or not ( False ).
CheckpointConfig (dict) --
Contains information about the output location for managed spot training checkpoint data.
S3Uri (string) --
Identifies the S3 path where you want Amazon SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix .
LocalPath (string) --
(Optional) The local directory where checkpoints are written. The default directory is /opt/ml/checkpoints/ .
HyperParameterTuningJobStatus (string) --
The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.
CreationTime (datetime) --
The date and time that the tuning job started.
HyperParameterTuningEndTime (datetime) --
The date and time that the tuning job ended.
LastModifiedTime (datetime) --
The date and time that the status of the tuning job was modified.
TrainingJobStatusCounters (dict) --
The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.
Completed (integer) --
The number of completed training jobs launched by the hyperparameter tuning job.
InProgress (integer) --
The number of in-progress training jobs launched by a hyperparameter tuning job.
RetryableError (integer) --
The number of training jobs that failed, but can be retried. A failed training job can be retried only if it failed because an internal service error occurred.
NonRetryableError (integer) --
The number of training jobs that failed and can't be retried. A failed training job can't be retried if it failed because a client error occurred.
Stopped (integer) --
The number of training jobs launched by a hyperparameter tuning job that were manually stopped.
ObjectiveStatusCounters (dict) --
The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.
Succeeded (integer) --
The number of training jobs whose final objective metric was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.
Pending (integer) --
The number of training jobs that are in progress and pending evaluation of their final objective metric.
Failed (integer) --
The number of training jobs whose final objective metric was not evaluated and used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.
BestTrainingJob (dict) --
A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.
TrainingJobDefinitionName (string) --
The training job definition name.
TrainingJobName (string) --
The name of the training job.
TrainingJobArn (string) --
The Amazon Resource Name (ARN) of the training job.
TuningJobName (string) --
The HyperParameter tuning job that launched the training job.
CreationTime (datetime) --
The date and time that the training job was created.
TrainingStartTime (datetime) --
The date and time that the training job started.
TrainingEndTime (datetime) --
Specifies the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.
TrainingJobStatus (string) --
The status of the training job.
TunedHyperParameters (dict) --
A list of the hyperparameters for which you specified ranges to search.
(string) --
(string) --
FailureReason (string) --
The reason that the training job failed.
FinalHyperParameterTuningJobObjectiveMetric (dict) --
The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.
Type (string) --
Whether to minimize or maximize the objective metric. Valid values are Minimize and Maximize.
MetricName (string) --
The name of the objective metric.
Value (float) --
The value of the objective metric.
ObjectiveStatus (string) --
The status of the objective metric for the training job:
Succeeded: The final objective metric for the training job was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.
Pending: The training job is in progress and evaluation of its final objective metric is pending.
Failed: The final objective metric for the training job was not evaluated, and was not used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.
OverallBestTrainingJob (dict) --
If the hyperparameter tuning job is an warm start tuning job with a WarmStartType of IDENTICAL_DATA_AND_ALGORITHM , this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.
TrainingJobDefinitionName (string) --
The training job definition name.
TrainingJobName (string) --
The name of the training job.
TrainingJobArn (string) --
The Amazon Resource Name (ARN) of the training job.
TuningJobName (string) --
The HyperParameter tuning job that launched the training job.
CreationTime (datetime) --
The date and time that the training job was created.
TrainingStartTime (datetime) --
The date and time that the training job started.
TrainingEndTime (datetime) --
Specifies the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.
TrainingJobStatus (string) --
The status of the training job.
TunedHyperParameters (dict) --
A list of the hyperparameters for which you specified ranges to search.
(string) --
(string) --
FailureReason (string) --
The reason that the training job failed.
FinalHyperParameterTuningJobObjectiveMetric (dict) --
The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.
Type (string) --
Whether to minimize or maximize the objective metric. Valid values are Minimize and Maximize.
MetricName (string) --
The name of the objective metric.
Value (float) --
The value of the objective metric.
ObjectiveStatus (string) --
The status of the objective metric for the training job:
Succeeded: The final objective metric for the training job was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.
Pending: The training job is in progress and evaluation of its final objective metric is pending.
Failed: The final objective metric for the training job was not evaluated, and was not used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.
WarmStartConfig (dict) --
The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.
ParentHyperParameterTuningJobs (list) --
An array of hyperparameter tuning jobs that are used as the starting point for the new hyperparameter tuning job. For more information about warm starting a hyperparameter tuning job, see Using a Previous Hyperparameter Tuning Job as a Starting Point.
Hyperparameter tuning jobs created before October 1, 2018 cannot be used as parent jobs for warm start tuning jobs.
(dict) --
A previously completed or stopped hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.
HyperParameterTuningJobName (string) --
The name of the hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.
WarmStartType (string) --
Specifies one of the following:
IDENTICAL_DATA_AND_ALGORITHM
The new hyperparameter tuning job uses the same input data and training image as the parent tuning jobs. You can change the hyperparameter ranges to search and the maximum number of training jobs that the hyperparameter tuning job launches. You cannot use a new version of the training algorithm, unless the changes in the new version do not affect the algorithm itself. For example, changes that improve logging or adding support for a different data format are allowed. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.
TRANSFER_LEARNING
The new hyperparameter tuning job can include input data, hyperparameter ranges, maximum number of concurrent training jobs, and maximum number of training jobs that are different than those of its parent hyperparameter tuning jobs. The training image can also be a different version from the version used in the parent hyperparameter tuning job. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.
FailureReason (string) --
If the tuning job failed, the reason it failed.
{'ResourceConfig': {'InstanceType': {'ml.p4d.24xlarge'}}}
Returns information about a training job.
See also: AWS API Documentation
Request Syntax
client.describe_training_job( TrainingJobName='string' )
string
[REQUIRED]
The name of the training job.
dict
Response Syntax
{ 'TrainingJobName': 'string', 'TrainingJobArn': 'string', 'TuningJobArn': 'string', 'LabelingJobArn': 'string', 'AutoMLJobArn': 'string', 'ModelArtifacts': { 'S3ModelArtifacts': 'string' }, 'TrainingJobStatus': 'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped', 'SecondaryStatus': 'Starting'|'LaunchingMLInstances'|'PreparingTrainingStack'|'Downloading'|'DownloadingTrainingImage'|'Training'|'Uploading'|'Stopping'|'Stopped'|'MaxRuntimeExceeded'|'Completed'|'Failed'|'Interrupted'|'MaxWaitTimeExceeded', 'FailureReason': 'string', 'HyperParameters': { 'string': 'string' }, 'AlgorithmSpecification': { 'TrainingImage': 'string', 'AlgorithmName': 'string', 'TrainingInputMode': 'Pipe'|'File', 'MetricDefinitions': [ { 'Name': 'string', 'Regex': 'string' }, ], 'EnableSageMakerMetricsTimeSeries': True|False }, 'RoleArn': 'string', 'InputDataConfig': [ { 'ChannelName': 'string', 'DataSource': { 'S3DataSource': { 'S3DataType': 'ManifestFile'|'S3Prefix'|'AugmentedManifestFile', 'S3Uri': 'string', 'S3DataDistributionType': 'FullyReplicated'|'ShardedByS3Key', 'AttributeNames': [ 'string', ] }, 'FileSystemDataSource': { 'FileSystemId': 'string', 'FileSystemAccessMode': 'rw'|'ro', 'FileSystemType': 'EFS'|'FSxLustre', 'DirectoryPath': 'string' } }, 'ContentType': 'string', 'CompressionType': 'None'|'Gzip', 'RecordWrapperType': 'None'|'RecordIO', 'InputMode': 'Pipe'|'File', 'ShuffleConfig': { 'Seed': 123 } }, ], 'OutputDataConfig': { 'KmsKeyId': 'string', 'S3OutputPath': 'string' }, 'ResourceConfig': { '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.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.p4d.24xlarge'|'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', 'InstanceCount': 123, 'VolumeSizeInGB': 123, 'VolumeKmsKeyId': 'string' }, 'VpcConfig': { 'SecurityGroupIds': [ 'string', ], 'Subnets': [ 'string', ] }, 'StoppingCondition': { 'MaxRuntimeInSeconds': 123, 'MaxWaitTimeInSeconds': 123 }, 'CreationTime': datetime(2015, 1, 1), 'TrainingStartTime': datetime(2015, 1, 1), 'TrainingEndTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'SecondaryStatusTransitions': [ { 'Status': 'Starting'|'LaunchingMLInstances'|'PreparingTrainingStack'|'Downloading'|'DownloadingTrainingImage'|'Training'|'Uploading'|'Stopping'|'Stopped'|'MaxRuntimeExceeded'|'Completed'|'Failed'|'Interrupted'|'MaxWaitTimeExceeded', 'StartTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1), 'StatusMessage': 'string' }, ], 'FinalMetricDataList': [ { 'MetricName': 'string', 'Value': ..., 'Timestamp': datetime(2015, 1, 1) }, ], 'EnableNetworkIsolation': True|False, 'EnableInterContainerTrafficEncryption': True|False, 'EnableManagedSpotTraining': True|False, 'CheckpointConfig': { 'S3Uri': 'string', 'LocalPath': 'string' }, 'TrainingTimeInSeconds': 123, 'BillableTimeInSeconds': 123, 'DebugHookConfig': { 'LocalPath': 'string', 'S3OutputPath': 'string', 'HookParameters': { 'string': 'string' }, 'CollectionConfigurations': [ { 'CollectionName': 'string', 'CollectionParameters': { 'string': 'string' } }, ] }, 'ExperimentConfig': { 'ExperimentName': 'string', 'TrialName': 'string', 'TrialComponentDisplayName': 'string' }, 'DebugRuleConfigurations': [ { 'RuleConfigurationName': 'string', 'LocalPath': 'string', 'S3OutputPath': 'string', 'RuleEvaluatorImage': 'string', 'InstanceType': 'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m4.xlarge'|'ml.m4.2xlarge'|'ml.m4.4xlarge'|'ml.m4.10xlarge'|'ml.m4.16xlarge'|'ml.c4.xlarge'|'ml.c4.2xlarge'|'ml.c4.4xlarge'|'ml.c4.8xlarge'|'ml.p2.xlarge'|'ml.p2.8xlarge'|'ml.p2.16xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.12xlarge'|'ml.m5.24xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge', 'VolumeSizeInGB': 123, 'RuleParameters': { 'string': 'string' } }, ], 'TensorBoardOutputConfig': { 'LocalPath': 'string', 'S3OutputPath': 'string' }, 'DebugRuleEvaluationStatuses': [ { 'RuleConfigurationName': 'string', 'RuleEvaluationJobArn': 'string', 'RuleEvaluationStatus': 'InProgress'|'NoIssuesFound'|'IssuesFound'|'Error'|'Stopping'|'Stopped', 'StatusDetails': 'string', 'LastModifiedTime': datetime(2015, 1, 1) }, ] }
Response Structure
(dict) --
TrainingJobName (string) --
Name of the model training job.
TrainingJobArn (string) --
The Amazon Resource Name (ARN) of the training job.
TuningJobArn (string) --
The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.
LabelingJobArn (string) --
The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.
AutoMLJobArn (string) --
The Amazon Resource Name (ARN) of an AutoML job.
ModelArtifacts (dict) --
Information about the Amazon S3 location that is configured for storing model artifacts.
S3ModelArtifacts (string) --
The path of the S3 object that contains the model artifacts. For example, s3://bucket-name/keynameprefix/model.tar.gz .
TrainingJobStatus (string) --
The status of the training job.
Amazon SageMaker provides the following training job statuses:
InProgress - The training is in progress.
Completed - The training job has completed.
Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.
Stopping - The training job is stopping.
Stopped - The training job has stopped.
For more detailed information, see SecondaryStatus .
SecondaryStatus (string) --
Provides detailed information about the state of the training job. For detailed information on the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.
Amazon SageMaker provides primary statuses and secondary statuses that apply to each of them:
InProgress
Starting - Starting the training job.
Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.
Training - Training is in progress.
Interrupted - The job stopped because the managed spot training instances were interrupted.
Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.
Completed
Completed - The training job has completed.
Failed
Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse .
Stopped
MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.
MaxWaitTimeExceeded - The job stopped because it exceeded the maximum allowed wait time.
Stopped - The training job has stopped.
Stopping
Stopping - Stopping the training job.
Warning
Valid values for SecondaryStatus are subject to change.
We no longer support the following secondary statuses:
LaunchingMLInstances
PreparingTrainingStack
DownloadingTrainingImage
FailureReason (string) --
If the training job failed, the reason it failed.
HyperParameters (dict) --
Algorithm-specific parameters.
(string) --
(string) --
AlgorithmSpecification (dict) --
Information about the algorithm used for training, and algorithm metadata.
TrainingImage (string) --
The registry path of the Docker image that contains the training algorithm. For information about docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.
AlgorithmName (string) --
The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on AWS Marketplace. If you specify a value for this parameter, you can't specify a value for TrainingImage .
TrainingInputMode (string) --
The input mode that the algorithm supports. For the input modes that Amazon SageMaker algorithms support, see Algorithms. If an algorithm supports the File input mode, Amazon SageMaker downloads the training data from S3 to the provisioned ML storage Volume, and mounts the directory to docker volume for training container. If an algorithm supports the Pipe input mode, Amazon SageMaker streams data directly from S3 to the container.
In File mode, make sure you provision ML storage volume with sufficient capacity to accommodate the data download from S3. In addition to the training data, the ML storage volume also stores the output model. The algorithm container use ML storage volume to also store intermediate information, if any.
For distributed algorithms using File mode, training data is distributed uniformly, and your training duration is predictable if the input data objects size is approximately same. Amazon SageMaker does not split the files any further for model training. If the object sizes are skewed, training won't be optimal as the data distribution is also skewed where one host in a training cluster is overloaded, thus becoming bottleneck in training.
MetricDefinitions (list) --
A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. Amazon SageMaker publishes each metric to Amazon CloudWatch.
(dict) --
Specifies a metric that the training algorithm writes to stderr or stdout . Amazon SageMakerhyperparameter tuning captures all defined metrics. You specify one metric that a hyperparameter tuning job uses as its objective metric to choose the best training job.
Name (string) --
The name of the metric.
Regex (string) --
A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining Objective Metrics.
EnableSageMakerMetricsTimeSeries (boolean) --
To generate and save time-series metrics during training, set to true . The default is false and time-series metrics aren't generated except in the following cases:
You use one of the Amazon SageMaker built-in algorithms
You use one of the following Prebuilt Amazon SageMaker Docker Images:
Tensorflow (version >= 1.15)
MXNet (version >= 1.6)
PyTorch (version >= 1.3)
You specify at least one MetricDefinition
RoleArn (string) --
The AWS Identity and Access Management (IAM) role configured for the training job.
InputDataConfig (list) --
An array of Channel objects that describes each data input channel.
(dict) --
A channel is a named input source that training algorithms can consume.
ChannelName (string) --
The name of the channel.
DataSource (dict) --
The location of the channel data.
S3DataSource (dict) --
The S3 location of the data source that is associated with a channel.
S3DataType (string) --
If you choose S3Prefix , S3Uri identifies a key name prefix. Amazon SageMaker uses all objects that match the specified key name prefix for model training.
If you choose ManifestFile , S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for model training.
If you choose AugmentedManifestFile , S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel's input mode is Pipe .
S3Uri (string) --
Depending on the value specified for the S3DataType , identifies either a key name prefix or a manifest. For example:
A key name prefix might look like this: s3://bucketname/exampleprefix
A manifest might look like this: s3://bucketname/example.manifest A manifest is an S3 object which is a JSON file consisting of an array of elements. The first element is a prefix which is followed by one or more suffixes. SageMaker appends the suffix elements to the prefix to get a full set of S3Uri . Note that the prefix must be a valid non-empty S3Uri that precludes users from specifying a manifest whose individual S3Uri is sourced from different S3 buckets. The following code example shows a valid manifest format: [ {"prefix": "s3://customer_bucket/some/prefix/"}, "relative/path/to/custdata-1", "relative/path/custdata-2", ... "relative/path/custdata-N" ] This JSON is equivalent to the following S3Uri list: s3://customer_bucket/some/prefix/relative/path/to/custdata-1 s3://customer_bucket/some/prefix/relative/path/custdata-2 ... s3://customer_bucket/some/prefix/relative/path/custdata-N The complete set of S3Uri in this manifest is the input data for the channel for this data source. The object that each S3Uri points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.
S3DataDistributionType (string) --
If you want Amazon SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated .
If you want Amazon SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key . If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data.
Don't choose more ML compute instances for training than available S3 objects. If you do, some nodes won't get any data and you will pay for nodes that aren't getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms.
In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key . If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File ), this copies 1/n of the number of objects.
AttributeNames (list) --
A list of one or more attribute names to use that are found in a specified augmented manifest file.
(string) --
FileSystemDataSource (dict) --
The file system that is associated with a channel.
FileSystemId (string) --
The file system id.
FileSystemAccessMode (string) --
The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write) mode.
FileSystemType (string) --
The file system type.
DirectoryPath (string) --
The full path to the directory to associate with the channel.
ContentType (string) --
The MIME type of the data.
CompressionType (string) --
If training data is compressed, the compression type. The default value is None . CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None.
RecordWrapperType (string) --
Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, Amazon SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.
In File mode, leave this field unset or set it to None.
InputMode (string) --
(Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode , Amazon SageMaker uses the value set for TrainingInputMode . Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.
To use a model for incremental training, choose File input model.
ShuffleConfig (dict) --
A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType , this shuffles the results of the S3 key prefix matches. If you use ManifestFile , the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile , the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.
For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key , the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.
Seed (integer) --
Determines the shuffling order in ShuffleConfig value.
OutputDataConfig (dict) --
The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.
KmsKeyId (string) --
The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:
// KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab"
// Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
// KMS Key Alias "alias/ExampleAlias"
// Amazon Resource Name (ARN) of a KMS Key Alias "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt . If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig . If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms" . For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob , CreateTransformJob , or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide .
S3OutputPath (string) --
Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix .
ResourceConfig (dict) --
Resources, including ML compute instances and ML storage volumes, that are configured for model training.
InstanceType (string) --
The ML compute instance type.
InstanceCount (integer) --
The number of ML compute instances to use. For distributed training, provide a value greater than 1.
VolumeSizeInGB (integer) --
The size of the ML storage volume that you want to provision.
ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.
You must specify sufficient ML storage for your scenario.
Note
Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.
Note
Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for training, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a VolumeSizeInGB greater than the total size of the local instance storage.
For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.
VolumeKmsKeyId (string) --
The AWS KMS key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job.
Note
Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
For more information about local instance storage encryption, see SSD Instance Store Volumes.
The VolumeKmsKeyId can be in any of the following formats:
// KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab"
// Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
VpcConfig (dict) --
A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.
SecurityGroupIds (list) --
The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
(string) --
Subnets (list) --
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.
(string) --
StoppingCondition (dict) --
Specifies a limit to how long a model training job can run. It also specifies the maximum time to wait for a spot instance. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.
To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.
MaxRuntimeInSeconds (integer) --
The maximum length of time, in seconds, that the training or compilation job can run. If job does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. The maximum value is 28 days.
MaxWaitTimeInSeconds (integer) --
The maximum length of time, in seconds, how long you are willing to wait for a managed spot training job to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the training job runs. It must be equal to or greater than MaxRuntimeInSeconds .
CreationTime (datetime) --
A timestamp that indicates when the training job was created.
TrainingStartTime (datetime) --
Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime . The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.
TrainingEndTime (datetime) --
Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.
LastModifiedTime (datetime) --
A timestamp that indicates when the status of the training job was last modified.
SecondaryStatusTransitions (list) --
A history of all of the secondary statuses that the training job has transitioned through.
(dict) --
An array element of DescribeTrainingJobResponse$SecondaryStatusTransitions. It provides additional details about a status that the training job has transitioned through. A training job can be in one of several states, for example, starting, downloading, training, or uploading. Within each state, there are a number of intermediate states. For example, within the starting state, Amazon SageMaker could be starting the training job or launching the ML instances. These transitional states are referred to as the job's secondary status.
Status (string) --
Contains a secondary status information from a training job.
Status might be one of the following secondary statuses:
InProgress
Starting - Starting the training job.
Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.
Training - Training is in progress.
Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.
Completed
Completed - The training job has completed.
Failed
Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse .
Stopped
MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.
Stopped - The training job has stopped.
Stopping
Stopping - Stopping the training job.
We no longer support the following secondary statuses:
LaunchingMLInstances
PreparingTrainingStack
DownloadingTrainingImage
StartTime (datetime) --
A timestamp that shows when the training job transitioned to the current secondary status state.
EndTime (datetime) --
A timestamp that shows when the training job transitioned out of this secondary status state into another secondary status state or when the training job has ended.
StatusMessage (string) --
A detailed description of the progress within a secondary status.
Amazon SageMaker provides secondary statuses and status messages that apply to each of them:
Starting
Starting the training job.
Launching requested ML instances.
Insufficient capacity error from EC2 while launching instances, retrying!
Launched instance was unhealthy, replacing it!
Preparing the instances for training.
Training
Downloading the training image.
Training image download completed. Training in progress.
Warning
Status messages are subject to change. Therefore, we recommend not including them in code that programmatically initiates actions. For examples, don't use status messages in if statements.
To have an overview of your training job's progress, view TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example, at the start of a training job, you might see the following:
TrainingJobStatus - InProgress
SecondaryStatus - Training
StatusMessage - Downloading the training image
FinalMetricDataList (list) --
A collection of MetricData objects that specify the names, values, and dates and times that the training algorithm emitted to Amazon CloudWatch.
(dict) --
The name, value, and date and time of a metric that was emitted to Amazon CloudWatch.
MetricName (string) --
The name of the metric.
Value (float) --
The value of the metric.
Timestamp (datetime) --
The date and time that the algorithm emitted the metric.
EnableNetworkIsolation (boolean) --
If you want to allow inbound or outbound network calls, except for calls between peers within a training cluster for distributed training, choose True . If you enable network isolation for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.
EnableInterContainerTrafficEncryption (boolean) --
To encrypt all communications between ML compute instances in distributed training, choose True . Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithms in distributed training.
EnableManagedSpotTraining (boolean) --
A Boolean indicating whether managed spot training is enabled ( True ) or not ( False ).
CheckpointConfig (dict) --
Contains information about the output location for managed spot training checkpoint data.
S3Uri (string) --
Identifies the S3 path where you want Amazon SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix .
LocalPath (string) --
(Optional) The local directory where checkpoints are written. The default directory is /opt/ml/checkpoints/ .
TrainingTimeInSeconds (integer) --
The training time in seconds.
BillableTimeInSeconds (integer) --
The billable time in seconds.
You can calculate the savings from using managed spot training using the formula (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100 . For example, if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is 500, the savings is 80%.
DebugHookConfig (dict) --
Configuration information for the debug hook parameters, collection configuration, and storage paths.
LocalPath (string) --
Path to local storage location for tensors. Defaults to /opt/ml/output/tensors/ .
S3OutputPath (string) --
Path to Amazon S3 storage location for tensors.
HookParameters (dict) --
Configuration information for the debug hook parameters.
(string) --
(string) --
CollectionConfigurations (list) --
Configuration information for tensor collections.
(dict) --
Configuration information for tensor collections.
CollectionName (string) --
The name of the tensor collection. The name must be unique relative to other rule configuration names.
CollectionParameters (dict) --
Parameter values for the tensor collection. The allowed parameters are "name" , "include_regex" , "reduction_config" , "save_config" , "tensor_names" , and "save_histogram" .
(string) --
(string) --
ExperimentConfig (dict) --
Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:
CreateProcessingJob
CreateTrainingJob
CreateTransformJob
ExperimentName (string) --
The name of an existing experiment to associate the trial component with.
TrialName (string) --
The name of an existing trial to associate the trial component with. If not specified, a new trial is created.
TrialComponentDisplayName (string) --
The display name for the trial component. If this key isn't specified, the display name is the trial component name.
DebugRuleConfigurations (list) --
Configuration information for debugging rules.
(dict) --
Configuration information for debugging rules.
RuleConfigurationName (string) --
The name of the rule configuration. It must be unique relative to other rule configuration names.
LocalPath (string) --
Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/ .
S3OutputPath (string) --
Path to Amazon S3 storage location for rules.
RuleEvaluatorImage (string) --
The Amazon Elastic Container (ECR) Image for the managed rule evaluation.
InstanceType (string) --
The instance type to deploy for a training job.
VolumeSizeInGB (integer) --
The size, in GB, of the ML storage volume attached to the processing instance.
RuleParameters (dict) --
Runtime configuration for rule container.
(string) --
(string) --
TensorBoardOutputConfig (dict) --
Configuration of storage locations for TensorBoard output.
LocalPath (string) --
Path to local storage location for tensorBoard output. Defaults to /opt/ml/output/tensorboard .
S3OutputPath (string) --
Path to Amazon S3 storage location for TensorBoard output.
DebugRuleEvaluationStatuses (list) --
Status about the debug rule evaluation.
(dict) --
Information about the status of the rule evaluation.
RuleConfigurationName (string) --
The name of the rule configuration
RuleEvaluationJobArn (string) --
The Amazon Resource Name (ARN) of the rule evaluation job.
RuleEvaluationStatus (string) --
Status of the rule evaluation.
StatusDetails (string) --
Details from the rule evaluation.
LastModifiedTime (datetime) --
Timestamp when the rule evaluation status was last modified.
{'Status': {'Updating', 'Delete_Failed', 'Update_Failed'}, 'UserSettings': {'JupyterServerAppSettings': {'DefaultResourceSpec': {'SageMakerImageVersionArn': 'string'}}, 'KernelGatewayAppSettings': {'CustomImages': [{'AppImageConfigName': 'string', 'ImageName': 'string', 'ImageVersionNumber': 'integer'}], 'DefaultResourceSpec': {'SageMakerImageVersionArn': 'string'}}, 'TensorBoardAppSettings': {'DefaultResourceSpec': {'SageMakerImageVersionArn': 'string'}}}}
Describes a user profile. For more information, see CreateUserProfile .
See also: AWS API Documentation
Request Syntax
client.describe_user_profile( DomainId='string', UserProfileName='string' )
string
[REQUIRED]
The domain ID.
string
[REQUIRED]
The user profile name.
dict
Response Syntax
{ 'DomainId': 'string', 'UserProfileArn': 'string', 'UserProfileName': 'string', 'HomeEfsFileSystemUid': 'string', 'Status': 'Deleting'|'Failed'|'InService'|'Pending'|'Updating'|'Update_Failed'|'Delete_Failed', 'LastModifiedTime': datetime(2015, 1, 1), 'CreationTime': datetime(2015, 1, 1), 'FailureReason': 'string', 'SingleSignOnUserIdentifier': 'string', 'SingleSignOnUserValue': 'string', 'UserSettings': { 'ExecutionRole': 'string', 'SecurityGroups': [ 'string', ], 'SharingSettings': { 'NotebookOutputOption': 'Allowed'|'Disabled', 'S3OutputPath': 'string', 'S3KmsKeyId': 'string' }, 'JupyterServerAppSettings': { 'DefaultResourceSpec': { 'SageMakerImageArn': 'string', 'SageMakerImageVersionArn': 'string', 'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge' } }, 'KernelGatewayAppSettings': { 'DefaultResourceSpec': { 'SageMakerImageArn': 'string', 'SageMakerImageVersionArn': 'string', 'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge' }, 'CustomImages': [ { 'ImageName': 'string', 'ImageVersionNumber': 123, 'AppImageConfigName': 'string' }, ] }, 'TensorBoardAppSettings': { 'DefaultResourceSpec': { 'SageMakerImageArn': 'string', 'SageMakerImageVersionArn': 'string', 'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge' } } } }
Response Structure
(dict) --
DomainId (string) --
The ID of the domain that contains the profile.
UserProfileArn (string) --
The user profile Amazon Resource Name (ARN).
UserProfileName (string) --
The user profile name.
HomeEfsFileSystemUid (string) --
The ID of the user's profile in the Amazon Elastic File System (EFS) volume.
Status (string) --
The status.
LastModifiedTime (datetime) --
The last modified time.
CreationTime (datetime) --
The creation time.
FailureReason (string) --
The failure reason.
SingleSignOnUserIdentifier (string) --
The SSO user identifier.
SingleSignOnUserValue (string) --
The SSO user value.
UserSettings (dict) --
A collection of settings.
ExecutionRole (string) --
The execution role for the user.
SecurityGroups (list) --
The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly .
Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly .
(string) --
SharingSettings (dict) --
The sharing settings.
NotebookOutputOption (string) --
Whether to include the notebook cell output when sharing the notebook. The default is Disabled .
S3OutputPath (string) --
When NotebookOutputOption is Allowed , the Amazon S3 bucket used to save the notebook cell output.
S3KmsKeyId (string) --
When NotebookOutputOption is Allowed , the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.
JupyterServerAppSettings (dict) --
The Jupyter server's app settings.
DefaultResourceSpec (dict) --
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
SageMakerImageArn (string) --
The ARN of the SageMaker image that the image version belongs to.
SageMakerImageVersionArn (string) --
The ARN of the image version created on the instance.
InstanceType (string) --
The instance type that the image version runs on.
KernelGatewayAppSettings (dict) --
The kernel gateway app settings.
DefaultResourceSpec (dict) --
The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.
SageMakerImageArn (string) --
The ARN of the SageMaker image that the image version belongs to.
SageMakerImageVersionArn (string) --
The ARN of the image version created on the instance.
InstanceType (string) --
The instance type that the image version runs on.
CustomImages (list) --
A list of custom images that are configured to run as a KernelGateway app.
(dict) --
A custom image.
ImageName (string) --
The name of the CustomImage. Must be unique to your account.
ImageVersionNumber (integer) --
The version number of the CustomImage.
AppImageConfigName (string) --
The name of the AppImageConfig.
TensorBoardAppSettings (dict) --
The TensorBoard app settings.
DefaultResourceSpec (dict) --
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
SageMakerImageArn (string) --
The ARN of the SageMaker image that the image version belongs to.
SageMakerImageVersionArn (string) --
The ARN of the image version created on the instance.
InstanceType (string) --
The instance type that the image version runs on.
{'Domains': {'Status': {'Updating', 'Delete_Failed', 'Update_Failed'}}}
Lists the domains.
See also: AWS API Documentation
Request Syntax
client.list_domains( NextToken='string', MaxResults=123 )
string
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
integer
Returns a list up to a specified limit.
dict
Response Syntax
{ 'Domains': [ { 'DomainArn': 'string', 'DomainId': 'string', 'DomainName': 'string', 'Status': 'Deleting'|'Failed'|'InService'|'Pending'|'Updating'|'Update_Failed'|'Delete_Failed', 'CreationTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'Url': 'string' }, ], 'NextToken': 'string' }
Response Structure
(dict) --
Domains (list) --
The list of domains.
(dict) --
The domain's details.
DomainArn (string) --
The domain's Amazon Resource Name (ARN).
DomainId (string) --
The domain ID.
DomainName (string) --
The domain name.
Status (string) --
The status.
CreationTime (datetime) --
The creation time.
LastModifiedTime (datetime) --
The last modified time.
Url (string) --
The domain's URL.
NextToken (string) --
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
{'UserProfiles': {'Status': {'Updating', 'Delete_Failed', 'Update_Failed'}}}
Lists user profiles.
See also: AWS API Documentation
Request Syntax
client.list_user_profiles( NextToken='string', MaxResults=123, SortOrder='Ascending'|'Descending', SortBy='CreationTime'|'LastModifiedTime', DomainIdEquals='string', UserProfileNameContains='string' )
string
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
integer
Returns a list up to a specified limit.
string
The sort order for the results. The default is Ascending.
string
The parameter by which to sort the results. The default is CreationTime.
string
A parameter by which to filter the results.
string
A parameter by which to filter the results.
dict
Response Syntax
{ 'UserProfiles': [ { 'DomainId': 'string', 'UserProfileName': 'string', 'Status': 'Deleting'|'Failed'|'InService'|'Pending'|'Updating'|'Update_Failed'|'Delete_Failed', 'CreationTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' }
Response Structure
(dict) --
UserProfiles (list) --
The list of user profiles.
(dict) --
The user profile details.
DomainId (string) --
The domain ID.
UserProfileName (string) --
The user profile name.
Status (string) --
The status.
CreationTime (datetime) --
The creation time.
LastModifiedTime (datetime) --
The last modified time.
NextToken (string) --
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
{'Results': {'TrainingJob': {'ResourceConfig': {'InstanceType': {'ml.p4d.24xlarge'}}}, 'TrialComponent': {'SourceDetail': {'TrainingJob': {'ResourceConfig': {'InstanceType': {'ml.p4d.24xlarge'}}}}}}}
Finds Amazon SageMaker resources that match a search query. Matching resources are returned as a list of SearchRecord objects in the response. You can sort the search results by any resource property in a ascending or descending order.
You can query against the following value types: numeric, text, Boolean, and timestamp.
See also: AWS API Documentation
Request Syntax
client.search( Resource='TrainingJob'|'Experiment'|'ExperimentTrial'|'ExperimentTrialComponent', SearchExpression={ 'Filters': [ { 'Name': 'string', 'Operator': 'Equals'|'NotEquals'|'GreaterThan'|'GreaterThanOrEqualTo'|'LessThan'|'LessThanOrEqualTo'|'Contains'|'Exists'|'NotExists'|'In', 'Value': 'string' }, ], 'NestedFilters': [ { 'NestedPropertyName': 'string', 'Filters': [ { 'Name': 'string', 'Operator': 'Equals'|'NotEquals'|'GreaterThan'|'GreaterThanOrEqualTo'|'LessThan'|'LessThanOrEqualTo'|'Contains'|'Exists'|'NotExists'|'In', 'Value': 'string' }, ] }, ], 'SubExpressions': [ {'... recursive ...'}, ], 'Operator': 'And'|'Or' }, SortBy='string', SortOrder='Ascending'|'Descending', NextToken='string', MaxResults=123 )
string
[REQUIRED]
The name of the Amazon SageMaker resource to search for.
dict
A Boolean conditional statement. Resources must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive SubExpressions , NestedFilters , and Filters that can be included in a SearchExpression object is 50.
Filters (list) --
A list of filter objects.
(dict) --
A conditional statement for a search expression that includes a resource property, a Boolean operator, and a value. Resources that match the statement are returned in the results from the Search API.
If you specify a Value , but not an Operator , Amazon SageMaker uses the equals operator.
In search, there are several property types:
Metrics
To define a metric filter, enter a value using the form "Metrics.<name>" , where <name> is a metric name. For example, the following filter searches for training jobs with an "accuracy" metric greater than "0.9" :
{
"Name": "Metrics.accuracy",
"Operator": "GreaterThan",
"Value": "0.9"
}
HyperParameters
To define a hyperparameter filter, enter a value with the form "HyperParameters.<name>" . Decimal hyperparameter values are treated as a decimal in a comparison if the specified Value is also a decimal value. If the specified Value is an integer, the decimal hyperparameter values are treated as integers. For example, the following filter is satisfied by training jobs with a "learning_rate" hyperparameter that is less than "0.5" :
{
"Name": "HyperParameters.learning_rate",
"Operator": "LessThan",
"Value": "0.5"
}
Tags
To define a tag filter, enter a value with the form Tags.<key> .
Name (string) -- [REQUIRED]
A resource property name. For example, TrainingJobName . For valid property names, see SearchRecord. You must specify a valid property for the resource.
Operator (string) --
A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:
Equals
The value of Name equals Value .
NotEquals
The value of Name doesn't equal Value .
Exists
The Name property exists.
NotExists
The Name property does not exist.
GreaterThan
The value of Name is greater than Value . Not supported for text properties.
GreaterThanOrEqualTo
The value of Name is greater than or equal to Value . Not supported for text properties.
LessThan
The value of Name is less than Value . Not supported for text properties.
LessThanOrEqualTo
The value of Name is less than or equal to Value . Not supported for text properties.
In
The value of Name is one of the comma delimited strings in Value . Only supported for text properties.
Contains
The value of Name contains the string Value . Only supported for text properties.
A SearchExpression can include the Contains operator multiple times when the value of Name is one of the following:
Experiment.DisplayName
Experiment.ExperimentName
Experiment.Tags
Trial.DisplayName
Trial.TrialName
Trial.Tags
TrialComponent.DisplayName
TrialComponent.TrialComponentName
TrialComponent.Tags
TrialComponent.InputArtifacts
TrialComponent.OutputArtifacts
A SearchExpression can include only one Contains operator for all other values of Name . In these cases, if you include multiple Contains operators in the SearchExpression , the result is the following error message: " 'CONTAINS' operator usage limit of 1 exceeded. "
Value (string) --
A value used with Name and Operator to determine which resources satisfy the filter's condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS .
NestedFilters (list) --
A list of nested filter objects.
(dict) --
A list of nested Filter objects. A resource must satisfy the conditions of all filters to be included in the results returned from the Search API.
For example, to filter on a training job's InputDataConfig property with a specific channel name and S3Uri prefix, define the following filters:
'{Name:"InputDataConfig.ChannelName", "Operator":"Equals", "Value":"train"}',
'{Name:"InputDataConfig.DataSource.S3DataSource.S3Uri", "Operator":"Contains", "Value":"mybucket/catdata"}'
NestedPropertyName (string) -- [REQUIRED]
The name of the property to use in the nested filters. The value must match a listed property name, such as InputDataConfig .
Filters (list) -- [REQUIRED]
A list of filters. Each filter acts on a property. Filters must contain at least one Filters value. For example, a NestedFilters call might include a filter on the PropertyName parameter of the InputDataConfig property: InputDataConfig.DataSource.S3DataSource.S3Uri .
(dict) --
A conditional statement for a search expression that includes a resource property, a Boolean operator, and a value. Resources that match the statement are returned in the results from the Search API.
If you specify a Value , but not an Operator , Amazon SageMaker uses the equals operator.
In search, there are several property types:
Metrics
To define a metric filter, enter a value using the form "Metrics.<name>" , where <name> is a metric name. For example, the following filter searches for training jobs with an "accuracy" metric greater than "0.9" :
{
"Name": "Metrics.accuracy",
"Operator": "GreaterThan",
"Value": "0.9"
}
HyperParameters
To define a hyperparameter filter, enter a value with the form "HyperParameters.<name>" . Decimal hyperparameter values are treated as a decimal in a comparison if the specified Value is also a decimal value. If the specified Value is an integer, the decimal hyperparameter values are treated as integers. For example, the following filter is satisfied by training jobs with a "learning_rate" hyperparameter that is less than "0.5" :
{
"Name": "HyperParameters.learning_rate",
"Operator": "LessThan",
"Value": "0.5"
}
Tags
To define a tag filter, enter a value with the form Tags.<key> .
Name (string) -- [REQUIRED]
A resource property name. For example, TrainingJobName . For valid property names, see SearchRecord. You must specify a valid property for the resource.
Operator (string) --
A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:
Equals
The value of Name equals Value .
NotEquals
The value of Name doesn't equal Value .
Exists
The Name property exists.
NotExists
The Name property does not exist.
GreaterThan
The value of Name is greater than Value . Not supported for text properties.
GreaterThanOrEqualTo
The value of Name is greater than or equal to Value . Not supported for text properties.
LessThan
The value of Name is less than Value . Not supported for text properties.
LessThanOrEqualTo
The value of Name is less than or equal to Value . Not supported for text properties.
In
The value of Name is one of the comma delimited strings in Value . Only supported for text properties.
Contains
The value of Name contains the string Value . Only supported for text properties.
A SearchExpression can include the Contains operator multiple times when the value of Name is one of the following:
Experiment.DisplayName
Experiment.ExperimentName
Experiment.Tags
Trial.DisplayName
Trial.TrialName
Trial.Tags
TrialComponent.DisplayName
TrialComponent.TrialComponentName
TrialComponent.Tags
TrialComponent.InputArtifacts
TrialComponent.OutputArtifacts
A SearchExpression can include only one Contains operator for all other values of Name . In these cases, if you include multiple Contains operators in the SearchExpression , the result is the following error message: " 'CONTAINS' operator usage limit of 1 exceeded. "
Value (string) --
A value used with Name and Operator to determine which resources satisfy the filter's condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS .
SubExpressions (list) --
A list of search expression objects.
(dict) --
A multi-expression that searches for the specified resource or resources in a search. All resource objects that satisfy the expression's condition are included in the search results. You must specify at least one subexpression, filter, or nested filter. A SearchExpression can contain up to twenty elements.
A SearchExpression contains the following components:
A list of Filter objects. Each filter defines a simple Boolean expression comprised of a resource property name, Boolean operator, and value.
A list of NestedFilter objects. Each nested filter defines a list of Boolean expressions using a list of resource properties. A nested filter is satisfied if a single object in the list satisfies all Boolean expressions.
A list of SearchExpression objects. A search expression object can be nested in a list of search expression objects.
A Boolean operator: And or Or .
Operator (string) --
A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists to be satisfied for the entire search expression to be true, specify And . If only a single conditional statement needs to be true for the entire search expression to be true, specify Or . The default value is And .
string
The name of the resource property used to sort the SearchResults . The default is LastModifiedTime .
string
How SearchResults are ordered. Valid values are Ascending or Descending . The default is Descending .
string
If more than MaxResults resources match the specified SearchExpression , the response includes a NextToken . The NextToken can be passed to the next SearchRequest to continue retrieving results.
integer
The maximum number of results to return.
dict
Response Syntax
{ 'Results': [ { 'TrainingJob': { 'TrainingJobName': 'string', 'TrainingJobArn': 'string', 'TuningJobArn': 'string', 'LabelingJobArn': 'string', 'AutoMLJobArn': 'string', 'ModelArtifacts': { 'S3ModelArtifacts': 'string' }, 'TrainingJobStatus': 'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped', 'SecondaryStatus': 'Starting'|'LaunchingMLInstances'|'PreparingTrainingStack'|'Downloading'|'DownloadingTrainingImage'|'Training'|'Uploading'|'Stopping'|'Stopped'|'MaxRuntimeExceeded'|'Completed'|'Failed'|'Interrupted'|'MaxWaitTimeExceeded', 'FailureReason': 'string', 'HyperParameters': { 'string': 'string' }, 'AlgorithmSpecification': { 'TrainingImage': 'string', 'AlgorithmName': 'string', 'TrainingInputMode': 'Pipe'|'File', 'MetricDefinitions': [ { 'Name': 'string', 'Regex': 'string' }, ], 'EnableSageMakerMetricsTimeSeries': True|False }, 'RoleArn': 'string', 'InputDataConfig': [ { 'ChannelName': 'string', 'DataSource': { 'S3DataSource': { 'S3DataType': 'ManifestFile'|'S3Prefix'|'AugmentedManifestFile', 'S3Uri': 'string', 'S3DataDistributionType': 'FullyReplicated'|'ShardedByS3Key', 'AttributeNames': [ 'string', ] }, 'FileSystemDataSource': { 'FileSystemId': 'string', 'FileSystemAccessMode': 'rw'|'ro', 'FileSystemType': 'EFS'|'FSxLustre', 'DirectoryPath': 'string' } }, 'ContentType': 'string', 'CompressionType': 'None'|'Gzip', 'RecordWrapperType': 'None'|'RecordIO', 'InputMode': 'Pipe'|'File', 'ShuffleConfig': { 'Seed': 123 } }, ], 'OutputDataConfig': { 'KmsKeyId': 'string', 'S3OutputPath': 'string' }, 'ResourceConfig': { '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.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.p4d.24xlarge'|'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', 'InstanceCount': 123, 'VolumeSizeInGB': 123, 'VolumeKmsKeyId': 'string' }, 'VpcConfig': { 'SecurityGroupIds': [ 'string', ], 'Subnets': [ 'string', ] }, 'StoppingCondition': { 'MaxRuntimeInSeconds': 123, 'MaxWaitTimeInSeconds': 123 }, 'CreationTime': datetime(2015, 1, 1), 'TrainingStartTime': datetime(2015, 1, 1), 'TrainingEndTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'SecondaryStatusTransitions': [ { 'Status': 'Starting'|'LaunchingMLInstances'|'PreparingTrainingStack'|'Downloading'|'DownloadingTrainingImage'|'Training'|'Uploading'|'Stopping'|'Stopped'|'MaxRuntimeExceeded'|'Completed'|'Failed'|'Interrupted'|'MaxWaitTimeExceeded', 'StartTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1), 'StatusMessage': 'string' }, ], 'FinalMetricDataList': [ { 'MetricName': 'string', 'Value': ..., 'Timestamp': datetime(2015, 1, 1) }, ], 'EnableNetworkIsolation': True|False, 'EnableInterContainerTrafficEncryption': True|False, 'EnableManagedSpotTraining': True|False, 'CheckpointConfig': { 'S3Uri': 'string', 'LocalPath': 'string' }, 'TrainingTimeInSeconds': 123, 'BillableTimeInSeconds': 123, 'DebugHookConfig': { 'LocalPath': 'string', 'S3OutputPath': 'string', 'HookParameters': { 'string': 'string' }, 'CollectionConfigurations': [ { 'CollectionName': 'string', 'CollectionParameters': { 'string': 'string' } }, ] }, 'ExperimentConfig': { 'ExperimentName': 'string', 'TrialName': 'string', 'TrialComponentDisplayName': 'string' }, 'DebugRuleConfigurations': [ { 'RuleConfigurationName': 'string', 'LocalPath': 'string', 'S3OutputPath': 'string', 'RuleEvaluatorImage': 'string', 'InstanceType': 'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m4.xlarge'|'ml.m4.2xlarge'|'ml.m4.4xlarge'|'ml.m4.10xlarge'|'ml.m4.16xlarge'|'ml.c4.xlarge'|'ml.c4.2xlarge'|'ml.c4.4xlarge'|'ml.c4.8xlarge'|'ml.p2.xlarge'|'ml.p2.8xlarge'|'ml.p2.16xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.12xlarge'|'ml.m5.24xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge', 'VolumeSizeInGB': 123, 'RuleParameters': { 'string': 'string' } }, ], 'TensorBoardOutputConfig': { 'LocalPath': 'string', 'S3OutputPath': 'string' }, 'DebugRuleEvaluationStatuses': [ { 'RuleConfigurationName': 'string', 'RuleEvaluationJobArn': 'string', 'RuleEvaluationStatus': 'InProgress'|'NoIssuesFound'|'IssuesFound'|'Error'|'Stopping'|'Stopped', 'StatusDetails': 'string', 'LastModifiedTime': datetime(2015, 1, 1) }, ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, 'Experiment': { 'ExperimentName': 'string', 'ExperimentArn': 'string', 'DisplayName': 'string', 'Source': { 'SourceArn': 'string', 'SourceType': 'string' }, 'Description': 'string', 'CreationTime': datetime(2015, 1, 1), 'CreatedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string' }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, 'Trial': { 'TrialName': 'string', 'TrialArn': 'string', 'DisplayName': 'string', 'ExperimentName': 'string', 'Source': { 'SourceArn': 'string', 'SourceType': 'string' }, 'CreationTime': datetime(2015, 1, 1), 'CreatedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string' }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'TrialComponentSummaries': [ { 'TrialComponentName': 'string', 'TrialComponentArn': 'string', 'TrialComponentSource': { 'SourceArn': 'string', 'SourceType': 'string' }, 'CreationTime': datetime(2015, 1, 1), 'CreatedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string' } }, ] }, 'TrialComponent': { 'TrialComponentName': 'string', 'DisplayName': 'string', 'TrialComponentArn': 'string', 'Source': { 'SourceArn': 'string', 'SourceType': 'string' }, 'Status': { 'PrimaryStatus': 'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped', 'Message': 'string' }, 'StartTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1), 'CreationTime': datetime(2015, 1, 1), 'CreatedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string' }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedBy': { 'UserProfileArn': 'string', 'UserProfileName': 'string', 'DomainId': 'string' }, 'Parameters': { 'string': { 'StringValue': 'string', 'NumberValue': 123.0 } }, 'InputArtifacts': { 'string': { 'MediaType': 'string', 'Value': 'string' } }, 'OutputArtifacts': { 'string': { 'MediaType': 'string', 'Value': 'string' } }, 'Metrics': [ { 'MetricName': 'string', 'SourceArn': 'string', 'TimeStamp': datetime(2015, 1, 1), 'Max': 123.0, 'Min': 123.0, 'Last': 123.0, 'Count': 123, 'Avg': 123.0, 'StdDev': 123.0 }, ], 'SourceDetail': { 'SourceArn': 'string', 'TrainingJob': { 'TrainingJobName': 'string', 'TrainingJobArn': 'string', 'TuningJobArn': 'string', 'LabelingJobArn': 'string', 'AutoMLJobArn': 'string', 'ModelArtifacts': { 'S3ModelArtifacts': 'string' }, 'TrainingJobStatus': 'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped', 'SecondaryStatus': 'Starting'|'LaunchingMLInstances'|'PreparingTrainingStack'|'Downloading'|'DownloadingTrainingImage'|'Training'|'Uploading'|'Stopping'|'Stopped'|'MaxRuntimeExceeded'|'Completed'|'Failed'|'Interrupted'|'MaxWaitTimeExceeded', 'FailureReason': 'string', 'HyperParameters': { 'string': 'string' }, 'AlgorithmSpecification': { 'TrainingImage': 'string', 'AlgorithmName': 'string', 'TrainingInputMode': 'Pipe'|'File', 'MetricDefinitions': [ { 'Name': 'string', 'Regex': 'string' }, ], 'EnableSageMakerMetricsTimeSeries': True|False }, 'RoleArn': 'string', 'InputDataConfig': [ { 'ChannelName': 'string', 'DataSource': { 'S3DataSource': { 'S3DataType': 'ManifestFile'|'S3Prefix'|'AugmentedManifestFile', 'S3Uri': 'string', 'S3DataDistributionType': 'FullyReplicated'|'ShardedByS3Key', 'AttributeNames': [ 'string', ] }, 'FileSystemDataSource': { 'FileSystemId': 'string', 'FileSystemAccessMode': 'rw'|'ro', 'FileSystemType': 'EFS'|'FSxLustre', 'DirectoryPath': 'string' } }, 'ContentType': 'string', 'CompressionType': 'None'|'Gzip', 'RecordWrapperType': 'None'|'RecordIO', 'InputMode': 'Pipe'|'File', 'ShuffleConfig': { 'Seed': 123 } }, ], 'OutputDataConfig': { 'KmsKeyId': 'string', 'S3OutputPath': 'string' }, 'ResourceConfig': { '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.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.p4d.24xlarge'|'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', 'InstanceCount': 123, 'VolumeSizeInGB': 123, 'VolumeKmsKeyId': 'string' }, 'VpcConfig': { 'SecurityGroupIds': [ 'string', ], 'Subnets': [ 'string', ] }, 'StoppingCondition': { 'MaxRuntimeInSeconds': 123, 'MaxWaitTimeInSeconds': 123 }, 'CreationTime': datetime(2015, 1, 1), 'TrainingStartTime': datetime(2015, 1, 1), 'TrainingEndTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'SecondaryStatusTransitions': [ { 'Status': 'Starting'|'LaunchingMLInstances'|'PreparingTrainingStack'|'Downloading'|'DownloadingTrainingImage'|'Training'|'Uploading'|'Stopping'|'Stopped'|'MaxRuntimeExceeded'|'Completed'|'Failed'|'Interrupted'|'MaxWaitTimeExceeded', 'StartTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1), 'StatusMessage': 'string' }, ], 'FinalMetricDataList': [ { 'MetricName': 'string', 'Value': ..., 'Timestamp': datetime(2015, 1, 1) }, ], 'EnableNetworkIsolation': True|False, 'EnableInterContainerTrafficEncryption': True|False, 'EnableManagedSpotTraining': True|False, 'CheckpointConfig': { 'S3Uri': 'string', 'LocalPath': 'string' }, 'TrainingTimeInSeconds': 123, 'BillableTimeInSeconds': 123, 'DebugHookConfig': { 'LocalPath': 'string', 'S3OutputPath': 'string', 'HookParameters': { 'string': 'string' }, 'CollectionConfigurations': [ { 'CollectionName': 'string', 'CollectionParameters': { 'string': 'string' } }, ] }, 'ExperimentConfig': { 'ExperimentName': 'string', 'TrialName': 'string', 'TrialComponentDisplayName': 'string' }, 'DebugRuleConfigurations': [ { 'RuleConfigurationName': 'string', 'LocalPath': 'string', 'S3OutputPath': 'string', 'RuleEvaluatorImage': 'string', 'InstanceType': 'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m4.xlarge'|'ml.m4.2xlarge'|'ml.m4.4xlarge'|'ml.m4.10xlarge'|'ml.m4.16xlarge'|'ml.c4.xlarge'|'ml.c4.2xlarge'|'ml.c4.4xlarge'|'ml.c4.8xlarge'|'ml.p2.xlarge'|'ml.p2.8xlarge'|'ml.p2.16xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.12xlarge'|'ml.m5.24xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge', 'VolumeSizeInGB': 123, 'RuleParameters': { 'string': 'string' } }, ], 'TensorBoardOutputConfig': { 'LocalPath': 'string', 'S3OutputPath': 'string' }, 'DebugRuleEvaluationStatuses': [ { 'RuleConfigurationName': 'string', 'RuleEvaluationJobArn': 'string', 'RuleEvaluationStatus': 'InProgress'|'NoIssuesFound'|'IssuesFound'|'Error'|'Stopping'|'Stopped', 'StatusDetails': 'string', 'LastModifiedTime': datetime(2015, 1, 1) }, ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, 'ProcessingJob': { 'ProcessingInputs': [ { 'InputName': 'string', 'S3Input': { 'S3Uri': 'string', 'LocalPath': 'string', 'S3DataType': 'ManifestFile'|'S3Prefix', 'S3InputMode': 'Pipe'|'File', 'S3DataDistributionType': 'FullyReplicated'|'ShardedByS3Key', 'S3CompressionType': 'None'|'Gzip' } }, ], 'ProcessingOutputConfig': { 'Outputs': [ { 'OutputName': 'string', 'S3Output': { 'S3Uri': 'string', 'LocalPath': 'string', 'S3UploadMode': 'Continuous'|'EndOfJob' } }, ], 'KmsKeyId': 'string' }, 'ProcessingJobName': 'string', 'ProcessingResources': { 'ClusterConfig': { 'InstanceCount': 123, 'InstanceType': 'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m4.xlarge'|'ml.m4.2xlarge'|'ml.m4.4xlarge'|'ml.m4.10xlarge'|'ml.m4.16xlarge'|'ml.c4.xlarge'|'ml.c4.2xlarge'|'ml.c4.4xlarge'|'ml.c4.8xlarge'|'ml.p2.xlarge'|'ml.p2.8xlarge'|'ml.p2.16xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.12xlarge'|'ml.m5.24xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge', 'VolumeSizeInGB': 123, 'VolumeKmsKeyId': 'string' } }, 'StoppingCondition': { 'MaxRuntimeInSeconds': 123 }, 'AppSpecification': { 'ImageUri': 'string', 'ContainerEntrypoint': [ 'string', ], 'ContainerArguments': [ 'string', ] }, 'Environment': { 'string': 'string' }, 'NetworkConfig': { 'EnableInterContainerTrafficEncryption': True|False, 'EnableNetworkIsolation': True|False, 'VpcConfig': { 'SecurityGroupIds': [ 'string', ], 'Subnets': [ 'string', ] } }, 'RoleArn': 'string', 'ExperimentConfig': { 'ExperimentName': 'string', 'TrialName': 'string', 'TrialComponentDisplayName': 'string' }, 'ProcessingJobArn': 'string', 'ProcessingJobStatus': 'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped', 'ExitMessage': 'string', 'FailureReason': 'string', 'ProcessingEndTime': datetime(2015, 1, 1), 'ProcessingStartTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'CreationTime': datetime(2015, 1, 1), 'MonitoringScheduleArn': 'string', 'AutoMLJobArn': 'string', 'TrainingJobArn': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, 'TransformJob': { 'TransformJobName': 'string', 'TransformJobArn': 'string', 'TransformJobStatus': 'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped', 'FailureReason': 'string', 'ModelName': 'string', 'MaxConcurrentTransforms': 123, 'ModelClientConfig': { 'InvocationsTimeoutInSeconds': 123, 'InvocationsMaxRetries': 123 }, 'MaxPayloadInMB': 123, 'BatchStrategy': 'MultiRecord'|'SingleRecord', 'Environment': { 'string': 'string' }, 'TransformInput': { 'DataSource': { 'S3DataSource': { 'S3DataType': 'ManifestFile'|'S3Prefix'|'AugmentedManifestFile', 'S3Uri': 'string' } }, 'ContentType': 'string', 'CompressionType': 'None'|'Gzip', 'SplitType': 'None'|'Line'|'RecordIO'|'TFRecord' }, 'TransformOutput': { 'S3OutputPath': 'string', 'Accept': 'string', 'AssembleWith': 'None'|'Line', 'KmsKeyId': 'string' }, 'TransformResources': { 'InstanceType': 'ml.m4.xlarge'|'ml.m4.2xlarge'|'ml.m4.4xlarge'|'ml.m4.10xlarge'|'ml.m4.16xlarge'|'ml.c4.xlarge'|'ml.c4.2xlarge'|'ml.c4.4xlarge'|'ml.c4.8xlarge'|'ml.p2.xlarge'|'ml.p2.8xlarge'|'ml.p2.16xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.12xlarge'|'ml.m5.24xlarge', 'InstanceCount': 123, 'VolumeKmsKeyId': 'string' }, 'CreationTime': datetime(2015, 1, 1), 'TransformStartTime': datetime(2015, 1, 1), 'TransformEndTime': datetime(2015, 1, 1), 'LabelingJobArn': 'string', 'AutoMLJobArn': 'string', 'DataProcessing': { 'InputFilter': 'string', 'OutputFilter': 'string', 'JoinSource': 'Input'|'None' }, 'ExperimentConfig': { 'ExperimentName': 'string', 'TrialName': 'string', 'TrialComponentDisplayName': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'Parents': [ { 'TrialName': 'string', 'ExperimentName': 'string' }, ] } }, ], 'NextToken': 'string' }
Response Structure
(dict) --
Results (list) --
A list of SearchRecord objects.
(dict) --
A single resource returned as part of the Search API response.
TrainingJob (dict) --
The properties of a training job.
TrainingJobName (string) --
The name of the training job.
TrainingJobArn (string) --
The Amazon Resource Name (ARN) of the training job.
TuningJobArn (string) --
The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.
LabelingJobArn (string) --
The Amazon Resource Name (ARN) of the labeling job.
AutoMLJobArn (string) --
The Amazon Resource Name (ARN) of the job.
ModelArtifacts (dict) --
Information about the Amazon S3 location that is configured for storing model artifacts.
S3ModelArtifacts (string) --
The path of the S3 object that contains the model artifacts. For example, s3://bucket-name/keynameprefix/model.tar.gz .
TrainingJobStatus (string) --
The status of the training job.
Training job statuses are:
InProgress - The training is in progress.
Completed - The training job has completed.
Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.
Stopping - The training job is stopping.
Stopped - The training job has stopped.
For more detailed information, see SecondaryStatus .
SecondaryStatus (string) --
Provides detailed information about the state of the training job. For detailed information about the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.
Amazon SageMaker provides primary statuses and secondary statuses that apply to each of them:
InProgress
Starting - Starting the training job.
Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.
Training - Training is in progress.
Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.
Completed
Completed - The training job has completed.
Failed
Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse .
Stopped
MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.
Stopped - The training job has stopped.
Stopping
Stopping - Stopping the training job.
Warning
Valid values for SecondaryStatus are subject to change.
We no longer support the following secondary statuses:
LaunchingMLInstances
PreparingTrainingStack
DownloadingTrainingImage
FailureReason (string) --
If the training job failed, the reason it failed.
HyperParameters (dict) --
Algorithm-specific parameters.
(string) --
(string) --
AlgorithmSpecification (dict) --
Information about the algorithm used for training, and algorithm metadata.
TrainingImage (string) --
The registry path of the Docker image that contains the training algorithm. For information about docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.
AlgorithmName (string) --
The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on AWS Marketplace. If you specify a value for this parameter, you can't specify a value for TrainingImage .
TrainingInputMode (string) --
The input mode that the algorithm supports. For the input modes that Amazon SageMaker algorithms support, see Algorithms. If an algorithm supports the File input mode, Amazon SageMaker downloads the training data from S3 to the provisioned ML storage Volume, and mounts the directory to docker volume for training container. If an algorithm supports the Pipe input mode, Amazon SageMaker streams data directly from S3 to the container.
In File mode, make sure you provision ML storage volume with sufficient capacity to accommodate the data download from S3. In addition to the training data, the ML storage volume also stores the output model. The algorithm container use ML storage volume to also store intermediate information, if any.
For distributed algorithms using File mode, training data is distributed uniformly, and your training duration is predictable if the input data objects size is approximately same. Amazon SageMaker does not split the files any further for model training. If the object sizes are skewed, training won't be optimal as the data distribution is also skewed where one host in a training cluster is overloaded, thus becoming bottleneck in training.
MetricDefinitions (list) --
A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. Amazon SageMaker publishes each metric to Amazon CloudWatch.
(dict) --
Specifies a metric that the training algorithm writes to stderr or stdout . Amazon SageMakerhyperparameter tuning captures all defined metrics. You specify one metric that a hyperparameter tuning job uses as its objective metric to choose the best training job.
Name (string) --
The name of the metric.
Regex (string) --
A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining Objective Metrics.
EnableSageMakerMetricsTimeSeries (boolean) --
To generate and save time-series metrics during training, set to true . The default is false and time-series metrics aren't generated except in the following cases:
You use one of the Amazon SageMaker built-in algorithms
You use one of the following Prebuilt Amazon SageMaker Docker Images:
Tensorflow (version >= 1.15)
MXNet (version >= 1.6)
PyTorch (version >= 1.3)
You specify at least one MetricDefinition
RoleArn (string) --
The AWS Identity and Access Management (IAM) role configured for the training job.
InputDataConfig (list) --
An array of Channel objects that describes each data input channel.
(dict) --
A channel is a named input source that training algorithms can consume.
ChannelName (string) --
The name of the channel.
DataSource (dict) --
The location of the channel data.
S3DataSource (dict) --
The S3 location of the data source that is associated with a channel.
S3DataType (string) --
If you choose S3Prefix , S3Uri identifies a key name prefix. Amazon SageMaker uses all objects that match the specified key name prefix for model training.
If you choose ManifestFile , S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for model training.
If you choose AugmentedManifestFile , S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel's input mode is Pipe .
S3Uri (string) --
Depending on the value specified for the S3DataType , identifies either a key name prefix or a manifest. For example:
A key name prefix might look like this: s3://bucketname/exampleprefix
A manifest might look like this: s3://bucketname/example.manifest A manifest is an S3 object which is a JSON file consisting of an array of elements. The first element is a prefix which is followed by one or more suffixes. SageMaker appends the suffix elements to the prefix to get a full set of S3Uri . Note that the prefix must be a valid non-empty S3Uri that precludes users from specifying a manifest whose individual S3Uri is sourced from different S3 buckets. The following code example shows a valid manifest format: [ {"prefix": "s3://customer_bucket/some/prefix/"}, "relative/path/to/custdata-1", "relative/path/custdata-2", ... "relative/path/custdata-N" ] This JSON is equivalent to the following S3Uri list: s3://customer_bucket/some/prefix/relative/path/to/custdata-1 s3://customer_bucket/some/prefix/relative/path/custdata-2 ... s3://customer_bucket/some/prefix/relative/path/custdata-N The complete set of S3Uri in this manifest is the input data for the channel for this data source. The object that each S3Uri points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.
S3DataDistributionType (string) --
If you want Amazon SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated .
If you want Amazon SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key . If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data.
Don't choose more ML compute instances for training than available S3 objects. If you do, some nodes won't get any data and you will pay for nodes that aren't getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms.
In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key . If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File ), this copies 1/n of the number of objects.
AttributeNames (list) --
A list of one or more attribute names to use that are found in a specified augmented manifest file.
(string) --
FileSystemDataSource (dict) --
The file system that is associated with a channel.
FileSystemId (string) --
The file system id.
FileSystemAccessMode (string) --
The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write) mode.
FileSystemType (string) --
The file system type.
DirectoryPath (string) --
The full path to the directory to associate with the channel.
ContentType (string) --
The MIME type of the data.
CompressionType (string) --
If training data is compressed, the compression type. The default value is None . CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None.
RecordWrapperType (string) --
Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, Amazon SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.
In File mode, leave this field unset or set it to None.
InputMode (string) --
(Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode , Amazon SageMaker uses the value set for TrainingInputMode . Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.
To use a model for incremental training, choose File input model.
ShuffleConfig (dict) --
A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType , this shuffles the results of the S3 key prefix matches. If you use ManifestFile , the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile , the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.
For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key , the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.
Seed (integer) --
Determines the shuffling order in ShuffleConfig value.
OutputDataConfig (dict) --
The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.
KmsKeyId (string) --
The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:
// KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab"
// Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
// KMS Key Alias "alias/ExampleAlias"
// Amazon Resource Name (ARN) of a KMS Key Alias "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt . If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig . If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms" . For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob , CreateTransformJob , or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide .
S3OutputPath (string) --
Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix .
ResourceConfig (dict) --
Resources, including ML compute instances and ML storage volumes, that are configured for model training.
InstanceType (string) --
The ML compute instance type.
InstanceCount (integer) --
The number of ML compute instances to use. For distributed training, provide a value greater than 1.
VolumeSizeInGB (integer) --
The size of the ML storage volume that you want to provision.
ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.
You must specify sufficient ML storage for your scenario.
Note
Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.
Note
Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for training, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a VolumeSizeInGB greater than the total size of the local instance storage.
For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.
VolumeKmsKeyId (string) --
The AWS KMS key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job.
Note
Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
For more information about local instance storage encryption, see SSD Instance Store Volumes.
The VolumeKmsKeyId can be in any of the following formats:
// KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab"
// Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
VpcConfig (dict) --
A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.
SecurityGroupIds (list) --
The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
(string) --
Subnets (list) --
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.
(string) --
StoppingCondition (dict) --
Specifies a limit to how long a model training job can run. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.
To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.
MaxRuntimeInSeconds (integer) --
The maximum length of time, in seconds, that the training or compilation job can run. If job does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. The maximum value is 28 days.
MaxWaitTimeInSeconds (integer) --
The maximum length of time, in seconds, how long you are willing to wait for a managed spot training job to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the training job runs. It must be equal to or greater than MaxRuntimeInSeconds .
CreationTime (datetime) --
A timestamp that indicates when the training job was created.
TrainingStartTime (datetime) --
Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime . The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.
TrainingEndTime (datetime) --
Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.
LastModifiedTime (datetime) --
A timestamp that indicates when the status of the training job was last modified.
SecondaryStatusTransitions (list) --
A history of all of the secondary statuses that the training job has transitioned through.
(dict) --
An array element of DescribeTrainingJobResponse$SecondaryStatusTransitions. It provides additional details about a status that the training job has transitioned through. A training job can be in one of several states, for example, starting, downloading, training, or uploading. Within each state, there are a number of intermediate states. For example, within the starting state, Amazon SageMaker could be starting the training job or launching the ML instances. These transitional states are referred to as the job's secondary status.
Status (string) --
Contains a secondary status information from a training job.
Status might be one of the following secondary statuses:
InProgress
Starting - Starting the training job.
Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.
Training - Training is in progress.
Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.
Completed
Completed - The training job has completed.
Failed
Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse .
Stopped
MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.
Stopped - The training job has stopped.
Stopping
Stopping - Stopping the training job.
We no longer support the following secondary statuses:
LaunchingMLInstances
PreparingTrainingStack
DownloadingTrainingImage
StartTime (datetime) --
A timestamp that shows when the training job transitioned to the current secondary status state.
EndTime (datetime) --
A timestamp that shows when the training job transitioned out of this secondary status state into another secondary status state or when the training job has ended.
StatusMessage (string) --
A detailed description of the progress within a secondary status.
Amazon SageMaker provides secondary statuses and status messages that apply to each of them:
Starting
Starting the training job.
Launching requested ML instances.
Insufficient capacity error from EC2 while launching instances, retrying!
Launched instance was unhealthy, replacing it!
Preparing the instances for training.
Training
Downloading the training image.
Training image download completed. Training in progress.
Warning
Status messages are subject to change. Therefore, we recommend not including them in code that programmatically initiates actions. For examples, don't use status messages in if statements.
To have an overview of your training job's progress, view TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example, at the start of a training job, you might see the following:
TrainingJobStatus - InProgress
SecondaryStatus - Training
StatusMessage - Downloading the training image
FinalMetricDataList (list) --
A list of final metric values that are set when the training job completes. Used only if the training job was configured to use metrics.
(dict) --
The name, value, and date and time of a metric that was emitted to Amazon CloudWatch.
MetricName (string) --
The name of the metric.
Value (float) --
The value of the metric.
Timestamp (datetime) --
The date and time that the algorithm emitted the metric.
EnableNetworkIsolation (boolean) --
If the TrainingJob was created with network isolation, the value is set to true . If network isolation is enabled, nodes can't communicate beyond the VPC they run in.
EnableInterContainerTrafficEncryption (boolean) --
To encrypt all communications between ML compute instances in distributed training, choose True . Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.
EnableManagedSpotTraining (boolean) --
When true, enables managed spot training using Amazon EC2 Spot instances to run training jobs instead of on-demand instances. For more information, see Managed Spot Training.
CheckpointConfig (dict) --
Contains information about the output location for managed spot training checkpoint data.
S3Uri (string) --
Identifies the S3 path where you want Amazon SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix .
LocalPath (string) --
(Optional) The local directory where checkpoints are written. The default directory is /opt/ml/checkpoints/ .
TrainingTimeInSeconds (integer) --
The training time in seconds.
BillableTimeInSeconds (integer) --
The billable time in seconds.
DebugHookConfig (dict) --
Configuration information for the debug hook parameters, collection configuration, and storage paths.
LocalPath (string) --
Path to local storage location for tensors. Defaults to /opt/ml/output/tensors/ .
S3OutputPath (string) --
Path to Amazon S3 storage location for tensors.
HookParameters (dict) --
Configuration information for the debug hook parameters.
(string) --
(string) --
CollectionConfigurations (list) --
Configuration information for tensor collections.
(dict) --
Configuration information for tensor collections.
CollectionName (string) --
The name of the tensor collection. The name must be unique relative to other rule configuration names.
CollectionParameters (dict) --
Parameter values for the tensor collection. The allowed parameters are "name" , "include_regex" , "reduction_config" , "save_config" , "tensor_names" , and "save_histogram" .
(string) --
(string) --
ExperimentConfig (dict) --
Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:
CreateProcessingJob
CreateTrainingJob
CreateTransformJob
ExperimentName (string) --
The name of an existing experiment to associate the trial component with.
TrialName (string) --
The name of an existing trial to associate the trial component with. If not specified, a new trial is created.
TrialComponentDisplayName (string) --
The display name for the trial component. If this key isn't specified, the display name is the trial component name.
DebugRuleConfigurations (list) --
Information about the debug rule configuration.
(dict) --
Configuration information for debugging rules.
RuleConfigurationName (string) --
The name of the rule configuration. It must be unique relative to other rule configuration names.
LocalPath (string) --
Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/ .
S3OutputPath (string) --
Path to Amazon S3 storage location for rules.
RuleEvaluatorImage (string) --
The Amazon Elastic Container (ECR) Image for the managed rule evaluation.
InstanceType (string) --
The instance type to deploy for a training job.
VolumeSizeInGB (integer) --
The size, in GB, of the ML storage volume attached to the processing instance.
RuleParameters (dict) --
Runtime configuration for rule container.
(string) --
(string) --
TensorBoardOutputConfig (dict) --
Configuration of storage locations for TensorBoard output.
LocalPath (string) --
Path to local storage location for tensorBoard output. Defaults to /opt/ml/output/tensorboard .
S3OutputPath (string) --
Path to Amazon S3 storage location for TensorBoard output.
DebugRuleEvaluationStatuses (list) --
Information about the evaluation status of the rules for the training job.
(dict) --
Information about the status of the rule evaluation.
RuleConfigurationName (string) --
The name of the rule configuration
RuleEvaluationJobArn (string) --
The Amazon Resource Name (ARN) of the rule evaluation job.
RuleEvaluationStatus (string) --
Status of the rule evaluation.
StatusDetails (string) --
Details from the rule evaluation.
LastModifiedTime (datetime) --
Timestamp when the rule evaluation status was last modified.
Tags (list) --
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide .
(dict) --
Describes a tag.
Key (string) --
The tag key.
Value (string) --
The tag value.
Experiment (dict) --
The properties of an experiment.
ExperimentName (string) --
The name of the experiment.
ExperimentArn (string) --
The Amazon Resource Name (ARN) of the experiment.
DisplayName (string) --
The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed.
Source (dict) --
The source of the experiment.
SourceArn (string) --
The Amazon Resource Name (ARN) of the source.
SourceType (string) --
The source type.
Description (string) --
The description of the experiment.
CreationTime (datetime) --
When the experiment was created.
CreatedBy (dict) --
Information about the user who created or modified an experiment, trial, or trial component.
UserProfileArn (string) --
The Amazon Resource Name (ARN) of the user's profile.
UserProfileName (string) --
The name of the user's profile.
DomainId (string) --
The domain associated with the user.
LastModifiedTime (datetime) --
When the experiment was last modified.
LastModifiedBy (dict) --
Information about the user who created or modified an experiment, trial, or trial component.
UserProfileArn (string) --
The Amazon Resource Name (ARN) of the user's profile.
UserProfileName (string) --
The name of the user's profile.
DomainId (string) --
The domain associated with the user.
Tags (list) --
The list of tags that are associated with the experiment. You can use Search API to search on the tags.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Value (string) --
The tag value.
Trial (dict) --
The properties of a trial.
TrialName (string) --
The name of the trial.
TrialArn (string) --
The Amazon Resource Name (ARN) of the trial.
DisplayName (string) --
The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.
ExperimentName (string) --
The name of the experiment the trial is part of.
Source (dict) --
The source of the trial.
SourceArn (string) --
The Amazon Resource Name (ARN) of the source.
SourceType (string) --
The source job type.
CreationTime (datetime) --
When the trial was created.
CreatedBy (dict) --
Information about the user who created or modified an experiment, trial, or trial component.
UserProfileArn (string) --
The Amazon Resource Name (ARN) of the user's profile.
UserProfileName (string) --
The name of the user's profile.
DomainId (string) --
The domain associated with the user.
LastModifiedTime (datetime) --
Who last modified the trial.
LastModifiedBy (dict) --
Information about the user who created or modified an experiment, trial, or trial component.
UserProfileArn (string) --
The Amazon Resource Name (ARN) of the user's profile.
UserProfileName (string) --
The name of the user's profile.
DomainId (string) --
The domain associated with the user.
Tags (list) --
The list of tags that are associated with the trial. You can use Search API to search on the tags.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Value (string) --
The tag value.
TrialComponentSummaries (list) --
A list of the components associated with the trial. For each component, a summary of the component's properties is included.
(dict) --
A short summary of a trial component.
TrialComponentName (string) --
The name of the trial component.
TrialComponentArn (string) --
The Amazon Resource Name (ARN) of the trial component.
TrialComponentSource (dict) --
The Amazon Resource Name (ARN) and job type of the source of a trial component.
SourceArn (string) --
The source ARN.
SourceType (string) --
The source job type.
CreationTime (datetime) --
When the component was created.
CreatedBy (dict) --
Information about the user who created or modified an experiment, trial, or trial component.
UserProfileArn (string) --
The Amazon Resource Name (ARN) of the user's profile.
UserProfileName (string) --
The name of the user's profile.
DomainId (string) --
The domain associated with the user.
TrialComponent (dict) --
The properties of a trial component.
TrialComponentName (string) --
The name of the trial component.
DisplayName (string) --
The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.
TrialComponentArn (string) --
The Amazon Resource Name (ARN) of the trial component.
Source (dict) --
The Amazon Resource Name (ARN) and job type of the source of the component.
SourceArn (string) --
The source ARN.
SourceType (string) --
The source job type.
Status (dict) --
The status of the trial component.
PrimaryStatus (string) --
The status of the trial component.
Message (string) --
If the component failed, a message describing why.
StartTime (datetime) --
When the component started.
EndTime (datetime) --
When the component ended.
CreationTime (datetime) --
When the component was created.
CreatedBy (dict) --
Information about the user who created or modified an experiment, trial, or trial component.
UserProfileArn (string) --
The Amazon Resource Name (ARN) of the user's profile.
UserProfileName (string) --
The name of the user's profile.
DomainId (string) --
The domain associated with the user.
LastModifiedTime (datetime) --
When the component was last modified.
LastModifiedBy (dict) --
Information about the user who created or modified an experiment, trial, or trial component.
UserProfileArn (string) --
The Amazon Resource Name (ARN) of the user's profile.
UserProfileName (string) --
The name of the user's profile.
DomainId (string) --
The domain associated with the user.
Parameters (dict) --
The hyperparameters of the component.
(string) --
(dict) --
The value of a hyperparameter. Only one of NumberValue or StringValue can be specified.
This object is specified in the CreateTrialComponent request.
StringValue (string) --
The string value of a categorical hyperparameter. If you specify a value for this parameter, you can't specify the NumberValue parameter.
NumberValue (float) --
The numeric value of a numeric hyperparameter. If you specify a value for this parameter, you can't specify the StringValue parameter.
InputArtifacts (dict) --
The input artifacts of the component.
(string) --
(dict) --
Represents an input or output artifact of a trial component. You specify TrialComponentArtifact as part of the InputArtifacts and OutputArtifacts parameters in the CreateTrialComponent request.
Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types. Examples of output artifacts are metrics, snapshots, logs, and images.
MediaType (string) --
The media type of the artifact, which indicates the type of data in the artifact file. The media type consists of a type and a subtype concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The type specifies the category of the media. The subtype specifies the kind of data.
Value (string) --
The location of the artifact.
OutputArtifacts (dict) --
The output artifacts of the component.
(string) --
(dict) --
Represents an input or output artifact of a trial component. You specify TrialComponentArtifact as part of the InputArtifacts and OutputArtifacts parameters in the CreateTrialComponent request.
Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types. Examples of output artifacts are metrics, snapshots, logs, and images.
MediaType (string) --
The media type of the artifact, which indicates the type of data in the artifact file. The media type consists of a type and a subtype concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The type specifies the category of the media. The subtype specifies the kind of data.
Value (string) --
The location of the artifact.
Metrics (list) --
The metrics for the component.
(dict) --
A summary of the metrics of a trial component.
MetricName (string) --
The name of the metric.
SourceArn (string) --
The Amazon Resource Name (ARN) of the source.
TimeStamp (datetime) --
When the metric was last updated.
Max (float) --
The maximum value of the metric.
Min (float) --
The minimum value of the metric.
Last (float) --
The most recent value of the metric.
Count (integer) --
The number of samples used to generate the metric.
Avg (float) --
The average value of the metric.
StdDev (float) --
The standard deviation of the metric.
SourceDetail (dict) --
Details of the source of the component.
SourceArn (string) --
The Amazon Resource Name (ARN) of the source.
TrainingJob (dict) --
Information about a training job that's the source of a trial component.
TrainingJobName (string) --
The name of the training job.
TrainingJobArn (string) --
The Amazon Resource Name (ARN) of the training job.
TuningJobArn (string) --
The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.
LabelingJobArn (string) --
The Amazon Resource Name (ARN) of the labeling job.
AutoMLJobArn (string) --
The Amazon Resource Name (ARN) of the job.
ModelArtifacts (dict) --
Information about the Amazon S3 location that is configured for storing model artifacts.
S3ModelArtifacts (string) --
The path of the S3 object that contains the model artifacts. For example, s3://bucket-name/keynameprefix/model.tar.gz .
TrainingJobStatus (string) --
The status of the training job.
Training job statuses are:
InProgress - The training is in progress.
Completed - The training job has completed.
Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.
Stopping - The training job is stopping.
Stopped - The training job has stopped.
For more detailed information, see SecondaryStatus .
SecondaryStatus (string) --
Provides detailed information about the state of the training job. For detailed information about the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.
Amazon SageMaker provides primary statuses and secondary statuses that apply to each of them:
InProgress
Starting - Starting the training job.
Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.
Training - Training is in progress.
Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.
Completed
Completed - The training job has completed.
Failed
Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse .
Stopped
MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.
Stopped - The training job has stopped.
Stopping
Stopping - Stopping the training job.
Warning
Valid values for SecondaryStatus are subject to change.
We no longer support the following secondary statuses:
LaunchingMLInstances
PreparingTrainingStack
DownloadingTrainingImage
FailureReason (string) --
If the training job failed, the reason it failed.
HyperParameters (dict) --
Algorithm-specific parameters.
(string) --
(string) --
AlgorithmSpecification (dict) --
Information about the algorithm used for training, and algorithm metadata.
TrainingImage (string) --
The registry path of the Docker image that contains the training algorithm. For information about docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.
AlgorithmName (string) --
The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on AWS Marketplace. If you specify a value for this parameter, you can't specify a value for TrainingImage .
TrainingInputMode (string) --
The input mode that the algorithm supports. For the input modes that Amazon SageMaker algorithms support, see Algorithms. If an algorithm supports the File input mode, Amazon SageMaker downloads the training data from S3 to the provisioned ML storage Volume, and mounts the directory to docker volume for training container. If an algorithm supports the Pipe input mode, Amazon SageMaker streams data directly from S3 to the container.
In File mode, make sure you provision ML storage volume with sufficient capacity to accommodate the data download from S3. In addition to the training data, the ML storage volume also stores the output model. The algorithm container use ML storage volume to also store intermediate information, if any.
For distributed algorithms using File mode, training data is distributed uniformly, and your training duration is predictable if the input data objects size is approximately same. Amazon SageMaker does not split the files any further for model training. If the object sizes are skewed, training won't be optimal as the data distribution is also skewed where one host in a training cluster is overloaded, thus becoming bottleneck in training.
MetricDefinitions (list) --
A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. Amazon SageMaker publishes each metric to Amazon CloudWatch.
(dict) --
Specifies a metric that the training algorithm writes to stderr or stdout . Amazon SageMakerhyperparameter tuning captures all defined metrics. You specify one metric that a hyperparameter tuning job uses as its objective metric to choose the best training job.
Name (string) --
The name of the metric.
Regex (string) --
A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining Objective Metrics.
EnableSageMakerMetricsTimeSeries (boolean) --
To generate and save time-series metrics during training, set to true . The default is false and time-series metrics aren't generated except in the following cases:
You use one of the Amazon SageMaker built-in algorithms
You use one of the following Prebuilt Amazon SageMaker Docker Images:
Tensorflow (version >= 1.15)
MXNet (version >= 1.6)
PyTorch (version >= 1.3)
You specify at least one MetricDefinition
RoleArn (string) --
The AWS Identity and Access Management (IAM) role configured for the training job.
InputDataConfig (list) --
An array of Channel objects that describes each data input channel.
(dict) --
A channel is a named input source that training algorithms can consume.
ChannelName (string) --
The name of the channel.
DataSource (dict) --
The location of the channel data.
S3DataSource (dict) --
The S3 location of the data source that is associated with a channel.
S3DataType (string) --
If you choose S3Prefix , S3Uri identifies a key name prefix. Amazon SageMaker uses all objects that match the specified key name prefix for model training.
If you choose ManifestFile , S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for model training.
If you choose AugmentedManifestFile , S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel's input mode is Pipe .
S3Uri (string) --
Depending on the value specified for the S3DataType , identifies either a key name prefix or a manifest. For example:
A key name prefix might look like this: s3://bucketname/exampleprefix
A manifest might look like this: s3://bucketname/example.manifest A manifest is an S3 object which is a JSON file consisting of an array of elements. The first element is a prefix which is followed by one or more suffixes. SageMaker appends the suffix elements to the prefix to get a full set of S3Uri . Note that the prefix must be a valid non-empty S3Uri that precludes users from specifying a manifest whose individual S3Uri is sourced from different S3 buckets. The following code example shows a valid manifest format: [ {"prefix": "s3://customer_bucket/some/prefix/"}, "relative/path/to/custdata-1", "relative/path/custdata-2", ... "relative/path/custdata-N" ] This JSON is equivalent to the following S3Uri list: s3://customer_bucket/some/prefix/relative/path/to/custdata-1 s3://customer_bucket/some/prefix/relative/path/custdata-2 ... s3://customer_bucket/some/prefix/relative/path/custdata-N The complete set of S3Uri in this manifest is the input data for the channel for this data source. The object that each S3Uri points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.
S3DataDistributionType (string) --
If you want Amazon SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated .
If you want Amazon SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key . If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data.
Don't choose more ML compute instances for training than available S3 objects. If you do, some nodes won't get any data and you will pay for nodes that aren't getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms.
In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key . If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File ), this copies 1/n of the number of objects.
AttributeNames (list) --
A list of one or more attribute names to use that are found in a specified augmented manifest file.
(string) --
FileSystemDataSource (dict) --
The file system that is associated with a channel.
FileSystemId (string) --
The file system id.
FileSystemAccessMode (string) --
The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write) mode.
FileSystemType (string) --
The file system type.
DirectoryPath (string) --
The full path to the directory to associate with the channel.
ContentType (string) --
The MIME type of the data.
CompressionType (string) --
If training data is compressed, the compression type. The default value is None . CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None.
RecordWrapperType (string) --
Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, Amazon SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.
In File mode, leave this field unset or set it to None.
InputMode (string) --
(Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode , Amazon SageMaker uses the value set for TrainingInputMode . Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.
To use a model for incremental training, choose File input model.
ShuffleConfig (dict) --
A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType , this shuffles the results of the S3 key prefix matches. If you use ManifestFile , the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile , the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.
For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key , the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.
Seed (integer) --
Determines the shuffling order in ShuffleConfig value.
OutputDataConfig (dict) --
The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.
KmsKeyId (string) --
The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:
// KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab"
// Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
// KMS Key Alias "alias/ExampleAlias"
// Amazon Resource Name (ARN) of a KMS Key Alias "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt . If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig . If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms" . For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob , CreateTransformJob , or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide .
S3OutputPath (string) --
Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix .
ResourceConfig (dict) --
Resources, including ML compute instances and ML storage volumes, that are configured for model training.
InstanceType (string) --
The ML compute instance type.
InstanceCount (integer) --
The number of ML compute instances to use. For distributed training, provide a value greater than 1.
VolumeSizeInGB (integer) --
The size of the ML storage volume that you want to provision.
ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.
You must specify sufficient ML storage for your scenario.
Note
Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.
Note
Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for training, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a VolumeSizeInGB greater than the total size of the local instance storage.
For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.
VolumeKmsKeyId (string) --
The AWS KMS key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job.
Note
Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
For more information about local instance storage encryption, see SSD Instance Store Volumes.
The VolumeKmsKeyId can be in any of the following formats:
// KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab"
// Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
VpcConfig (dict) --
A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.
SecurityGroupIds (list) --
The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
(string) --
Subnets (list) --
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.
(string) --
StoppingCondition (dict) --
Specifies a limit to how long a model training job can run. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.
To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.
MaxRuntimeInSeconds (integer) --
The maximum length of time, in seconds, that the training or compilation job can run. If job does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. The maximum value is 28 days.
MaxWaitTimeInSeconds (integer) --
The maximum length of time, in seconds, how long you are willing to wait for a managed spot training job to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the training job runs. It must be equal to or greater than MaxRuntimeInSeconds .
CreationTime (datetime) --
A timestamp that indicates when the training job was created.
TrainingStartTime (datetime) --
Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime . The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.
TrainingEndTime (datetime) --
Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.
LastModifiedTime (datetime) --
A timestamp that indicates when the status of the training job was last modified.
SecondaryStatusTransitions (list) --
A history of all of the secondary statuses that the training job has transitioned through.
(dict) --
An array element of DescribeTrainingJobResponse$SecondaryStatusTransitions. It provides additional details about a status that the training job has transitioned through. A training job can be in one of several states, for example, starting, downloading, training, or uploading. Within each state, there are a number of intermediate states. For example, within the starting state, Amazon SageMaker could be starting the training job or launching the ML instances. These transitional states are referred to as the job's secondary status.
Status (string) --
Contains a secondary status information from a training job.
Status might be one of the following secondary statuses:
InProgress
Starting - Starting the training job.
Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.
Training - Training is in progress.
Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.
Completed
Completed - The training job has completed.
Failed
Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse .
Stopped
MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.
Stopped - The training job has stopped.
Stopping
Stopping - Stopping the training job.
We no longer support the following secondary statuses:
LaunchingMLInstances
PreparingTrainingStack
DownloadingTrainingImage
StartTime (datetime) --
A timestamp that shows when the training job transitioned to the current secondary status state.
EndTime (datetime) --
A timestamp that shows when the training job transitioned out of this secondary status state into another secondary status state or when the training job has ended.
StatusMessage (string) --
A detailed description of the progress within a secondary status.
Amazon SageMaker provides secondary statuses and status messages that apply to each of them:
Starting
Starting the training job.
Launching requested ML instances.
Insufficient capacity error from EC2 while launching instances, retrying!
Launched instance was unhealthy, replacing it!
Preparing the instances for training.
Training
Downloading the training image.
Training image download completed. Training in progress.
Warning
Status messages are subject to change. Therefore, we recommend not including them in code that programmatically initiates actions. For examples, don't use status messages in if statements.
To have an overview of your training job's progress, view TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example, at the start of a training job, you might see the following:
TrainingJobStatus - InProgress
SecondaryStatus - Training
StatusMessage - Downloading the training image
FinalMetricDataList (list) --
A list of final metric values that are set when the training job completes. Used only if the training job was configured to use metrics.
(dict) --
The name, value, and date and time of a metric that was emitted to Amazon CloudWatch.
MetricName (string) --
The name of the metric.
Value (float) --
The value of the metric.
Timestamp (datetime) --
The date and time that the algorithm emitted the metric.
EnableNetworkIsolation (boolean) --
If the TrainingJob was created with network isolation, the value is set to true . If network isolation is enabled, nodes can't communicate beyond the VPC they run in.
EnableInterContainerTrafficEncryption (boolean) --
To encrypt all communications between ML compute instances in distributed training, choose True . Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.
EnableManagedSpotTraining (boolean) --
When true, enables managed spot training using Amazon EC2 Spot instances to run training jobs instead of on-demand instances. For more information, see Managed Spot Training.
CheckpointConfig (dict) --
Contains information about the output location for managed spot training checkpoint data.
S3Uri (string) --
Identifies the S3 path where you want Amazon SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix .
LocalPath (string) --
(Optional) The local directory where checkpoints are written. The default directory is /opt/ml/checkpoints/ .
TrainingTimeInSeconds (integer) --
The training time in seconds.
BillableTimeInSeconds (integer) --
The billable time in seconds.
DebugHookConfig (dict) --
Configuration information for the debug hook parameters, collection configuration, and storage paths.
LocalPath (string) --
Path to local storage location for tensors. Defaults to /opt/ml/output/tensors/ .
S3OutputPath (string) --
Path to Amazon S3 storage location for tensors.
HookParameters (dict) --
Configuration information for the debug hook parameters.
(string) --
(string) --
CollectionConfigurations (list) --
Configuration information for tensor collections.
(dict) --
Configuration information for tensor collections.
CollectionName (string) --
The name of the tensor collection. The name must be unique relative to other rule configuration names.
CollectionParameters (dict) --
Parameter values for the tensor collection. The allowed parameters are "name" , "include_regex" , "reduction_config" , "save_config" , "tensor_names" , and "save_histogram" .
(string) --
(string) --
ExperimentConfig (dict) --
Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:
CreateProcessingJob
CreateTrainingJob
CreateTransformJob
ExperimentName (string) --
The name of an existing experiment to associate the trial component with.
TrialName (string) --
The name of an existing trial to associate the trial component with. If not specified, a new trial is created.
TrialComponentDisplayName (string) --
The display name for the trial component. If this key isn't specified, the display name is the trial component name.
DebugRuleConfigurations (list) --
Information about the debug rule configuration.
(dict) --
Configuration information for debugging rules.
RuleConfigurationName (string) --
The name of the rule configuration. It must be unique relative to other rule configuration names.
LocalPath (string) --
Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/ .
S3OutputPath (string) --
Path to Amazon S3 storage location for rules.
RuleEvaluatorImage (string) --
The Amazon Elastic Container (ECR) Image for the managed rule evaluation.
InstanceType (string) --
The instance type to deploy for a training job.
VolumeSizeInGB (integer) --
The size, in GB, of the ML storage volume attached to the processing instance.
RuleParameters (dict) --
Runtime configuration for rule container.
(string) --
(string) --
TensorBoardOutputConfig (dict) --
Configuration of storage locations for TensorBoard output.
LocalPath (string) --
Path to local storage location for tensorBoard output. Defaults to /opt/ml/output/tensorboard .
S3OutputPath (string) --
Path to Amazon S3 storage location for TensorBoard output.
DebugRuleEvaluationStatuses (list) --
Information about the evaluation status of the rules for the training job.
(dict) --
Information about the status of the rule evaluation.
RuleConfigurationName (string) --
The name of the rule configuration
RuleEvaluationJobArn (string) --
The Amazon Resource Name (ARN) of the rule evaluation job.
RuleEvaluationStatus (string) --
Status of the rule evaluation.
StatusDetails (string) --
Details from the rule evaluation.
LastModifiedTime (datetime) --
Timestamp when the rule evaluation status was last modified.
Tags (list) --
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide .
(dict) --
Describes a tag.
Key (string) --
The tag key.
Value (string) --
The tag value.
ProcessingJob (dict) --
Information about a processing job that's the source of a trial component.
ProcessingInputs (list) --
For each input, data is downloaded from S3 into the processing container before the processing job begins running if "S3InputMode" is set to File .
(dict) --
The inputs for a processing job.
InputName (string) --
The name of the inputs for the processing job.
S3Input (dict) --
The S3 inputs for the processing job.
S3Uri (string) --
The URI for the Amazon S3 storage where you want Amazon SageMaker to download the artifacts needed to run a processing job.
LocalPath (string) --
The local path to the Amazon S3 bucket where you want Amazon SageMaker to download the inputs to run a processing job. LocalPath is an absolute path to the input data.
S3DataType (string) --
Whether you use an S3Prefix or a ManifestFile for the data type. If you choose S3Prefix , S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing job. If you choose ManifestFile , S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for the processing job.
S3InputMode (string) --
Whether to use File or Pipe input mode. In File mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.
S3DataDistributionType (string) --
Whether the data stored in Amazon S3 is FullyReplicated or ShardedByS3Key .
S3CompressionType (string) --
Whether to use Gzip compression for Amazon S3 storage.
ProcessingOutputConfig (dict) --
The output configuration for the processing job.
Outputs (list) --
Output configuration information for a processing job.
(dict) --
Describes the results of a processing job.
OutputName (string) --
The name for the processing job output.
S3Output (dict) --
Configuration for processing job outputs in Amazon S3.
S3Uri (string) --
A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of a processing job.
LocalPath (string) --
The local path to the Amazon S3 bucket where you want Amazon SageMaker to save the results of an processing job. LocalPath is an absolute path to the input data.
S3UploadMode (string) --
Whether to upload the results of the processing job continuously or after the job completes.
KmsKeyId (string) --
The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the processing job output. KmsKeyId can be an ID of a KMS key, ARN of a KMS key, alias of a KMS key, or alias of a KMS key. The KmsKeyId is applied to all outputs.
ProcessingJobName (string) --
The name of the processing job.
ProcessingResources (dict) --
Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.
ClusterConfig (dict) --
The configuration for the resources in a cluster used to run the processing job.
InstanceCount (integer) --
The number of ML compute instances to use in the processing job. For distributed processing jobs, specify a value greater than 1. The default value is 1.
InstanceType (string) --
The ML compute instance type for the processing job.
VolumeSizeInGB (integer) --
The size of the ML storage volume in gigabytes that you want to provision. You must specify sufficient ML storage for your scenario.
VolumeKmsKeyId (string) --
The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the processing job.
StoppingCondition (dict) --
Specifies a time limit for how long the processing job is allowed to run.
MaxRuntimeInSeconds (integer) --
Specifies the maximum runtime in seconds.
AppSpecification (dict) --
Configuration to run a processing job in a specified container image.
ImageUri (string) --
The container image to be run by the processing job.
ContainerEntrypoint (list) --
The entrypoint for a container used to run a processing job.
(string) --
ContainerArguments (list) --
The arguments for a container used to run a processing job.
(string) --
Environment (dict) --
Sets the environment variables in the Docker container.
(string) --
(string) --
NetworkConfig (dict) --
Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.
EnableInterContainerTrafficEncryption (boolean) --
Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.
EnableNetworkIsolation (boolean) --
Whether to allow inbound and outbound network calls to and from the containers used for the processing job.
VpcConfig (dict) --
Specifies a VPC that your training jobs and hosted models have access to. Control access to and from your training and model containers by configuring the VPC. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Training Jobs by Using an Amazon Virtual Private Cloud.
SecurityGroupIds (list) --
The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
(string) --
Subnets (list) --
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.
(string) --
RoleArn (string) --
The ARN of the role used to create the processing job.
ExperimentConfig (dict) --
Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:
CreateProcessingJob
CreateTrainingJob
CreateTransformJob
ExperimentName (string) --
The name of an existing experiment to associate the trial component with.
TrialName (string) --
The name of an existing trial to associate the trial component with. If not specified, a new trial is created.
TrialComponentDisplayName (string) --
The display name for the trial component. If this key isn't specified, the display name is the trial component name.
ProcessingJobArn (string) --
The ARN of the processing job.
ProcessingJobStatus (string) --
The status of the processing job.
ExitMessage (string) --
A string, up to one KB in size, that contains metadata from the processing container when the processing job exits.
FailureReason (string) --
A string, up to one KB in size, that contains the reason a processing job failed, if it failed.
ProcessingEndTime (datetime) --
The time that the processing job ended.
ProcessingStartTime (datetime) --
The time that the processing job started.
LastModifiedTime (datetime) --
The time the processing job was last modified.
CreationTime (datetime) --
The time the processing job was created.
MonitoringScheduleArn (string) --
The ARN of a monitoring schedule for an endpoint associated with this processing job.
AutoMLJobArn (string) --
The Amazon Resource Name (ARN) of the AutoML job associated with this processing job.
TrainingJobArn (string) --
The ARN of the training job associated with this processing job.
Tags (list) --
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide .
(dict) --
Describes a tag.
Key (string) --
The tag key.
Value (string) --
The tag value.
TransformJob (dict) --
Information about a transform job that's the source of a trial component.
TransformJobName (string) --
The name of the transform job.
TransformJobArn (string) --
The Amazon Resource Name (ARN) of the transform job.
TransformJobStatus (string) --
The status of the transform job.
Transform job statuses are:
InProgress - The job is in progress.
Completed - The job has completed.
Failed - The transform job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTransformJob call.
Stopping - The transform job is stopping.
Stopped - The transform job has stopped.
FailureReason (string) --
If the transform job failed, the reason it failed.
ModelName (string) --
The name of the model associated with the transform job.
MaxConcurrentTransforms (integer) --
The maximum number of parallel requests that can be sent to each instance in a transform job. If MaxConcurrentTransforms is set to 0 or left unset, SageMaker checks the optional execution-parameters to determine the settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is 1. For built-in algorithms, you don't need to set a value for MaxConcurrentTransforms .
ModelClientConfig (dict) --
Configures the timeout and maximum number of retries for processing a transform job invocation.
InvocationsTimeoutInSeconds (integer) --
The timeout value in seconds for an invocation request.
InvocationsMaxRetries (integer) --
The maximum number of retries when invocation requests are failing.
MaxPayloadInMB (integer) --
The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB. For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, SageMaker built-in algorithms do not support HTTP chunked encoding.
BatchStrategy (string) --
Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.
Environment (dict) --
The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.
(string) --
(string) --
TransformInput (dict) --
Describes the input source of a transform job and the way the transform job consumes it.
DataSource (dict) --
Describes the location of the channel data, which is, the S3 location of the input data that the model can consume.
S3DataSource (dict) --
The S3 location of the data source that is associated with a channel.
S3DataType (string) --
If you choose S3Prefix , S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for batch transform.
If you choose ManifestFile , S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for batch transform.
The following values are compatible: ManifestFile , S3Prefix
The following value is not compatible: AugmentedManifestFile
S3Uri (string) --
Depending on the value specified for the S3DataType , identifies either a key name prefix or a manifest. For example:
A key name prefix might look like this: s3://bucketname/exampleprefix .
A manifest might look like this: s3://bucketname/example.manifest The manifest is an S3 object which is a JSON file with the following format: [ {"prefix": "s3://customer_bucket/some/prefix/"}, "relative/path/to/custdata-1", "relative/path/custdata-2", ... "relative/path/custdata-N" ] The preceding JSON matches the following S3Uris : s3://customer_bucket/some/prefix/relative/path/to/custdata-1 s3://customer_bucket/some/prefix/relative/path/custdata-2 ... s3://customer_bucket/some/prefix/relative/path/custdata-N The complete set of S3Uris in this manifest constitutes the input data for the channel for this datasource. The object that each S3Uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.
ContentType (string) --
The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job.
CompressionType (string) --
If your transform data is compressed, specify the compression type. Amazon SageMaker automatically decompresses the data for the transform job accordingly. The default value is None .
SplitType (string) --
The method to use to split the transform job's data files into smaller batches. Splitting is necessary when the total size of each object is too large to fit in a single request. You can also use data splitting to improve performance by processing multiple concurrent mini-batches. The default value for SplitType is None , which indicates that input data files are not split, and request payloads contain the entire contents of an input object. Set the value of this parameter to Line to split records on a newline character boundary. SplitType also supports a number of record-oriented binary data formats. Currently, the supported record formats are:
RecordIO
TFRecord
When splitting is enabled, the size of a mini-batch depends on the values of the BatchStrategy and MaxPayloadInMB parameters. When the value of BatchStrategy is MultiRecord , Amazon SageMaker sends the maximum number of records in each request, up to the MaxPayloadInMB limit. If the value of BatchStrategy is SingleRecord , Amazon SageMaker sends individual records in each request.
Note
Some data formats represent a record as a binary payload wrapped with extra padding bytes. When splitting is applied to a binary data format, padding is removed if the value of BatchStrategy is set to SingleRecord . Padding is not removed if the value of BatchStrategy is set to MultiRecord .
For more information about RecordIO , see Create a Dataset Using RecordIO in the MXNet documentation. For more information about TFRecord , see Consuming TFRecord data in the TensorFlow documentation.
TransformOutput (dict) --
Describes the results of a transform job.
S3OutputPath (string) --
The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For example, s3://bucket-name/key-name-prefix .
For every S3 object used as input for the transform job, batch transform stores the transformed data with an . out suffix in a corresponding subfolder in the location in the output prefix. For example, for the input data stored at s3://bucket-name/input-name-prefix/dataset01/data.csv , batch transform stores the transformed data at s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out . Batch transform doesn't upload partially processed objects. For an input S3 object that contains multiple records, it creates an . out file only if the transform job succeeds on the entire file. When the input contains multiple S3 objects, the batch transform job processes the listed S3 objects and uploads only the output for successfully processed objects. If any object fails in the transform job batch transform marks the job as failed to prompt investigation.
Accept (string) --
The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job.
AssembleWith (string) --
Defines how to assemble the results of the transform job as a single S3 object. Choose a format that is most convenient to you. To concatenate the results in binary format, specify None . To add a newline character at the end of every transformed record, specify Line .
KmsKeyId (string) --
The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
The KMS key policy must grant permission to the IAM role that you specify in your CreateModel request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide .
TransformResources (dict) --
Describes the resources, including ML instance types and ML instance count, to use for transform job.
InstanceType (string) --
The ML compute instance type for the transform job. If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or ml.m5.large instance types.
InstanceCount (integer) --
The number of ML compute instances to use in the transform job. For distributed transform jobs, specify a value greater than 1. The default value is 1 .
VolumeKmsKeyId (string) --
The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform job. The VolumeKmsKeyId can be any of the following formats:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
CreationTime (datetime) --
A timestamp that shows when the transform Job was created.
TransformStartTime (datetime) --
Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of TransformEndTime .
TransformEndTime (datetime) --
Indicates when the transform job has been completed, or has stopped or failed. You are billed for the time interval between this time and the value of TransformStartTime .
LabelingJobArn (string) --
The Amazon Resource Name (ARN) of the labeling job that created the transform job.
AutoMLJobArn (string) --
The Amazon Resource Name (ARN) of the AutoML job that created the transform job.
DataProcessing (dict) --
The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see Associate Prediction Results with their Corresponding Input Records.
InputFilter (string) --
A JSONPath expression used to select a portion of the input data to pass to the algorithm. Use the InputFilter parameter to exclude fields, such as an ID column, from the input. If you want Amazon SageMaker to pass the entire input dataset to the algorithm, accept the default value $ .
Examples: "$" , "$[1:]" , "$.features"
OutputFilter (string) --
A JSONPath expression used to select a portion of the joined dataset to save in the output file for a batch transform job. If you want Amazon SageMaker to store the entire input dataset in the output file, leave the default value, $ . If you specify indexes that aren't within the dimension size of the joined dataset, you get an error.
Examples: "$" , "$[0,5:]" , "$['id','SageMakerOutput']"
JoinSource (string) --
Specifies the source of the data to join with the transformed data. The valid values are None and Input . The default value is None , which specifies not to join the input with the transformed data. If you want the batch transform job to join the original input data with the transformed data, set JoinSource to Input .
For JSON or JSONLines objects, such as a JSON array, Amazon SageMaker adds the transformed data to the input JSON object in an attribute called SageMakerOutput . The joined result for JSON must be a key-value pair object. If the input is not a key-value pair object, Amazon SageMaker creates a new JSON file. In the new JSON file, and the input data is stored under the SageMakerInput key and the results are stored in SageMakerOutput .
For CSV files, Amazon SageMaker combines the transformed data with the input data at the end of the input data and stores it in the output file. The joined data has the joined input data followed by the transformed data and the output is a CSV file.
ExperimentConfig (dict) --
Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:
CreateProcessingJob
CreateTrainingJob
CreateTransformJob
ExperimentName (string) --
The name of an existing experiment to associate the trial component with.
TrialName (string) --
The name of an existing trial to associate the trial component with. If not specified, a new trial is created.
TrialComponentDisplayName (string) --
The display name for the trial component. If this key isn't specified, the display name is the trial component name.
Tags (list) --
A list of tags associated with the transform job.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Value (string) --
The tag value.
Tags (list) --
The list of tags that are associated with the component. You can use Search API to search on the tags.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Value (string) --
The tag value.
Parents (list) --
An array of the parents of the component. A parent is a trial the component is associated with and the experiment the trial is part of. A component might not have any parents.
(dict) --
The trial that a trial component is associated with and the experiment the trial is part of. A component might not be associated with a trial. A component can be associated with multiple trials.
TrialName (string) --
The name of the trial.
ExperimentName (string) --
The name of the experiment.
NextToken (string) --
If the result of the previous Search request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request.
{'DefaultUserSettings': {'JupyterServerAppSettings': {'DefaultResourceSpec': {'SageMakerImageVersionArn': 'string'}}, 'KernelGatewayAppSettings': {'CustomImages': [{'AppImageConfigName': 'string', 'ImageName': 'string', 'ImageVersionNumber': 'integer'}], 'DefaultResourceSpec': {'SageMakerImageVersionArn': 'string'}}, 'TensorBoardAppSettings': {'DefaultResourceSpec': {'SageMakerImageVersionArn': 'string'}}}}
Updates the default settings for new user profiles in the domain.
See also: AWS API Documentation
Request Syntax
client.update_domain( DomainId='string', DefaultUserSettings={ 'ExecutionRole': 'string', 'SecurityGroups': [ 'string', ], 'SharingSettings': { 'NotebookOutputOption': 'Allowed'|'Disabled', 'S3OutputPath': 'string', 'S3KmsKeyId': 'string' }, 'JupyterServerAppSettings': { 'DefaultResourceSpec': { 'SageMakerImageArn': 'string', 'SageMakerImageVersionArn': 'string', 'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge' } }, 'KernelGatewayAppSettings': { 'DefaultResourceSpec': { 'SageMakerImageArn': 'string', 'SageMakerImageVersionArn': 'string', 'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge' }, 'CustomImages': [ { 'ImageName': 'string', 'ImageVersionNumber': 123, 'AppImageConfigName': 'string' }, ] }, 'TensorBoardAppSettings': { 'DefaultResourceSpec': { 'SageMakerImageArn': 'string', 'SageMakerImageVersionArn': 'string', 'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge' } } } )
string
[REQUIRED]
The ID of the domain to be updated.
dict
A collection of settings.
ExecutionRole (string) --
The execution role for the user.
SecurityGroups (list) --
The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly .
Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly .
(string) --
SharingSettings (dict) --
The sharing settings.
NotebookOutputOption (string) --
Whether to include the notebook cell output when sharing the notebook. The default is Disabled .
S3OutputPath (string) --
When NotebookOutputOption is Allowed , the Amazon S3 bucket used to save the notebook cell output.
S3KmsKeyId (string) --
When NotebookOutputOption is Allowed , the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.
JupyterServerAppSettings (dict) --
The Jupyter server's app settings.
DefaultResourceSpec (dict) --
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
SageMakerImageArn (string) --
The ARN of the SageMaker image that the image version belongs to.
SageMakerImageVersionArn (string) --
The ARN of the image version created on the instance.
InstanceType (string) --
The instance type that the image version runs on.
KernelGatewayAppSettings (dict) --
The kernel gateway app settings.
DefaultResourceSpec (dict) --
The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.
SageMakerImageArn (string) --
The ARN of the SageMaker image that the image version belongs to.
SageMakerImageVersionArn (string) --
The ARN of the image version created on the instance.
InstanceType (string) --
The instance type that the image version runs on.
CustomImages (list) --
A list of custom images that are configured to run as a KernelGateway app.
(dict) --
A custom image.
ImageName (string) -- [REQUIRED]
The name of the CustomImage. Must be unique to your account.
ImageVersionNumber (integer) --
The version number of the CustomImage.
AppImageConfigName (string) -- [REQUIRED]
The name of the AppImageConfig.
TensorBoardAppSettings (dict) --
The TensorBoard app settings.
DefaultResourceSpec (dict) --
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
SageMakerImageArn (string) --
The ARN of the SageMaker image that the image version belongs to.
SageMakerImageVersionArn (string) --
The ARN of the image version created on the instance.
InstanceType (string) --
The instance type that the image version runs on.
dict
Response Syntax
{ 'DomainArn': 'string' }
Response Structure
(dict) --
DomainArn (string) --
The Amazon Resource Name (ARN) of the domain.
{'UserSettings': {'JupyterServerAppSettings': {'DefaultResourceSpec': {'SageMakerImageVersionArn': 'string'}}, 'KernelGatewayAppSettings': {'CustomImages': [{'AppImageConfigName': 'string', 'ImageName': 'string', 'ImageVersionNumber': 'integer'}], 'DefaultResourceSpec': {'SageMakerImageVersionArn': 'string'}}, 'TensorBoardAppSettings': {'DefaultResourceSpec': {'SageMakerImageVersionArn': 'string'}}}}
Updates a user profile.
See also: AWS API Documentation
Request Syntax
client.update_user_profile( DomainId='string', UserProfileName='string', UserSettings={ 'ExecutionRole': 'string', 'SecurityGroups': [ 'string', ], 'SharingSettings': { 'NotebookOutputOption': 'Allowed'|'Disabled', 'S3OutputPath': 'string', 'S3KmsKeyId': 'string' }, 'JupyterServerAppSettings': { 'DefaultResourceSpec': { 'SageMakerImageArn': 'string', 'SageMakerImageVersionArn': 'string', 'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge' } }, 'KernelGatewayAppSettings': { 'DefaultResourceSpec': { 'SageMakerImageArn': 'string', 'SageMakerImageVersionArn': 'string', 'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge' }, 'CustomImages': [ { 'ImageName': 'string', 'ImageVersionNumber': 123, 'AppImageConfigName': 'string' }, ] }, 'TensorBoardAppSettings': { 'DefaultResourceSpec': { 'SageMakerImageArn': 'string', 'SageMakerImageVersionArn': 'string', 'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge' } } } )
string
[REQUIRED]
The domain ID.
string
[REQUIRED]
The user profile name.
dict
A collection of settings.
ExecutionRole (string) --
The execution role for the user.
SecurityGroups (list) --
The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly .
Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly .
(string) --
SharingSettings (dict) --
The sharing settings.
NotebookOutputOption (string) --
Whether to include the notebook cell output when sharing the notebook. The default is Disabled .
S3OutputPath (string) --
When NotebookOutputOption is Allowed , the Amazon S3 bucket used to save the notebook cell output.
S3KmsKeyId (string) --
When NotebookOutputOption is Allowed , the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.
JupyterServerAppSettings (dict) --
The Jupyter server's app settings.
DefaultResourceSpec (dict) --
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
SageMakerImageArn (string) --
The ARN of the SageMaker image that the image version belongs to.
SageMakerImageVersionArn (string) --
The ARN of the image version created on the instance.
InstanceType (string) --
The instance type that the image version runs on.
KernelGatewayAppSettings (dict) --
The kernel gateway app settings.
DefaultResourceSpec (dict) --
The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.
SageMakerImageArn (string) --
The ARN of the SageMaker image that the image version belongs to.
SageMakerImageVersionArn (string) --
The ARN of the image version created on the instance.
InstanceType (string) --
The instance type that the image version runs on.
CustomImages (list) --
A list of custom images that are configured to run as a KernelGateway app.
(dict) --
A custom image.
ImageName (string) -- [REQUIRED]
The name of the CustomImage. Must be unique to your account.
ImageVersionNumber (integer) --
The version number of the CustomImage.
AppImageConfigName (string) -- [REQUIRED]
The name of the AppImageConfig.
TensorBoardAppSettings (dict) --
The TensorBoard app settings.
DefaultResourceSpec (dict) --
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
SageMakerImageArn (string) --
The ARN of the SageMaker image that the image version belongs to.
SageMakerImageVersionArn (string) --
The ARN of the image version created on the instance.
InstanceType (string) --
The instance type that the image version runs on.
dict
Response Syntax
{ 'UserProfileArn': 'string' }
Response Structure
(dict) --
UserProfileArn (string) --
The user profile Amazon Resource Name (ARN).