SageMaker / Client / describe_algorithm
describe_algorithm#
- SageMaker.Client.describe_algorithm(**kwargs)#
Returns a description of the specified algorithm that is in your account.
See also: AWS API Documentation
Request Syntax
response = client.describe_algorithm( AlgorithmName='string' )
- Parameters:
AlgorithmName (string) –
[REQUIRED]
The name of the algorithm to describe.
- Return type:
dict
- Returns:
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'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge', ], 'SupportsDistributedTraining': True|False, 'MetricDefinitions': [ { 'Name': 'string', 'Regex': 'string' }, ], 'TrainingChannels': [ { 'Name': 'string', 'Description': 'string', 'IsRequired': True|False, 'SupportedContentTypes': [ 'string', ], 'SupportedCompressionTypes': [ 'None'|'Gzip', ], 'SupportedInputModes': [ 'Pipe'|'File'|'FastFile', ] }, ], 'SupportedTuningJobObjectiveMetrics': [ { 'Type': 'Maximize'|'Minimize', 'MetricName': 'string' }, ] }, 'InferenceSpecification': { 'Containers': [ { 'ContainerHostname': 'string', 'Image': 'string', 'ImageDigest': 'string', 'ModelDataUrl': 'string', 'ProductId': 'string', 'Environment': { 'string': 'string' }, 'ModelInput': { 'DataInputConfig': 'string' }, 'Framework': 'string', 'FrameworkVersion': 'string', 'NearestModelName': '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'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge', ], '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'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.12xlarge'|'ml.g5.16xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.p4d.24xlarge'|'ml.c7g.large'|'ml.c7g.xlarge'|'ml.c7g.2xlarge'|'ml.c7g.4xlarge'|'ml.c7g.8xlarge'|'ml.c7g.12xlarge'|'ml.c7g.16xlarge'|'ml.m6g.large'|'ml.m6g.xlarge'|'ml.m6g.2xlarge'|'ml.m6g.4xlarge'|'ml.m6g.8xlarge'|'ml.m6g.12xlarge'|'ml.m6g.16xlarge'|'ml.m6gd.large'|'ml.m6gd.xlarge'|'ml.m6gd.2xlarge'|'ml.m6gd.4xlarge'|'ml.m6gd.8xlarge'|'ml.m6gd.12xlarge'|'ml.m6gd.16xlarge'|'ml.c6g.large'|'ml.c6g.xlarge'|'ml.c6g.2xlarge'|'ml.c6g.4xlarge'|'ml.c6g.8xlarge'|'ml.c6g.12xlarge'|'ml.c6g.16xlarge'|'ml.c6gd.large'|'ml.c6gd.xlarge'|'ml.c6gd.2xlarge'|'ml.c6gd.4xlarge'|'ml.c6gd.8xlarge'|'ml.c6gd.12xlarge'|'ml.c6gd.16xlarge'|'ml.c6gn.large'|'ml.c6gn.xlarge'|'ml.c6gn.2xlarge'|'ml.c6gn.4xlarge'|'ml.c6gn.8xlarge'|'ml.c6gn.12xlarge'|'ml.c6gn.16xlarge'|'ml.r6g.large'|'ml.r6g.xlarge'|'ml.r6g.2xlarge'|'ml.r6g.4xlarge'|'ml.r6g.8xlarge'|'ml.r6g.12xlarge'|'ml.r6g.16xlarge'|'ml.r6gd.large'|'ml.r6gd.xlarge'|'ml.r6gd.2xlarge'|'ml.r6gd.4xlarge'|'ml.r6gd.8xlarge'|'ml.r6gd.12xlarge'|'ml.r6gd.16xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.inf2.xlarge'|'ml.inf2.8xlarge'|'ml.inf2.24xlarge'|'ml.inf2.48xlarge', ], 'SupportedContentTypes': [ 'string', ], 'SupportedResponseMIMETypes': [ 'string', ] }, 'ValidationSpecification': { 'ValidationRole': 'string', 'ValidationProfiles': [ { 'ProfileName': 'string', 'TrainingJobDefinition': { 'TrainingInputMode': 'Pipe'|'File'|'FastFile', 'HyperParameters': { 'string': 'string' }, 'InputDataConfig': [ { 'ChannelName': 'string', 'DataSource': { 'S3DataSource': { 'S3DataType': 'ManifestFile'|'S3Prefix'|'AugmentedManifestFile', 'S3Uri': 'string', 'S3DataDistributionType': 'FullyReplicated'|'ShardedByS3Key', 'AttributeNames': [ 'string', ], 'InstanceGroupNames': [ 'string', ] }, 'FileSystemDataSource': { 'FileSystemId': 'string', 'FileSystemAccessMode': 'rw'|'ro', 'FileSystemType': 'EFS'|'FSxLustre', 'DirectoryPath': 'string' } }, 'ContentType': 'string', 'CompressionType': 'None'|'Gzip', 'RecordWrapperType': 'None'|'RecordIO', 'InputMode': 'Pipe'|'File'|'FastFile', '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'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge', 'InstanceCount': 123, 'VolumeSizeInGB': 123, 'VolumeKmsKeyId': 'string', 'InstanceGroups': [ { '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'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge', 'InstanceCount': 123, 'InstanceGroupName': 'string' }, ], 'KeepAlivePeriodInSeconds': 123 }, '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'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge', '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
HyperParameterSpecificationobjects, 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, andFreeText.Range (dict) –
The allowed range for this hyperparameter.
IntegerParameterRangeSpecification (dict) –
A
IntegerParameterRangeSpecificationobject 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
ContinuousParameterRangeSpecificationobject 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
CategoricalParameterRangeSpecificationobject 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
MetricDefinitionobjects, which are used for parsing metrics generated by the algorithm.(dict) –
Specifies a metric that the training algorithm writes to
stderrorstdout. You can view these logs to understand how your training job performs and check for any errors encountered during training. SageMaker hyperparameter tuning captures all defined metrics. Specify one of the defined metrics to use as an objective metric using the TuningObjective parameter in theHyperParameterTrainingJobDefinitionAPI to evaluate job performance during hyperparameter tuning.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 metrics and environment variables.
TrainingChannels (list) –
A list of
ChannelSpecificationobjects, 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) –
The training input mode that the algorithm supports. For more information about input modes, see Algorithms.
Pipe mode
If an algorithm supports
Pipemode, Amazon SageMaker streams data directly from Amazon S3 to the container.File mode
If an algorithm supports
Filemode, SageMaker downloads the training data from S3 to the provisioned ML storage volume, and mounts the directory to the Docker volume for the training container.You must provision the ML storage volume with sufficient capacity to accommodate the data downloaded from S3. In addition to the training data, the ML storage volume also stores the output model. The algorithm container uses the ML storage volume to also store intermediate information, if any.
For distributed algorithms, training data is distributed uniformly. Your training duration is predictable if the input data objects sizes are approximately the same. 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 when one host in a training cluster is overloaded, thus becoming a bottleneck in training.
FastFile mode
If an algorithm supports
FastFilemode, SageMaker streams data directly from S3 to the container with no code changes, and provides file system access to the data. Users can author their training script to interact with these files as if they were stored on disk.FastFilemode works best when the data is read sequentially. Augmented manifest files aren’t supported. The startup time is lower when there are fewer files in the S3 bucket provided.
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
Typeparameter.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 SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both
registry/repository[:tag]andregistry/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
gzipcompressed tar archive (.tar.gzsuffix).Note
The model artifacts must be in an S3 bucket that is in the same region as the model package.
ProductId (string) –
The Amazon Web Services Marketplace product ID of the model package.
Environment (dict) –
The environment variables to set in the Docker container. Each key and value in the
Environmentstring to string map can have length of up to 1024. We support up to 16 entries in the map.(string) –
(string) –
ModelInput (dict) –
A structure with Model Input details.
DataInputConfig (string) –
The input configuration object for the model.
Framework (string) –
The machine learning framework of the model package container image.
FrameworkVersion (string) –
The framework version of the Model Package Container Image.
NearestModelName (string) –
The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model. You can find a list of benchmarked models by calling
ListModelMetadata.
SupportedTransformInstanceTypes (list) –
A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.
This parameter is required for unversioned models, and optional for versioned models.
(string) –
SupportedRealtimeInferenceInstanceTypes (list) –
A list of the instance types that are used to generate inferences in real-time.
This parameter is required for unversioned models, and optional for versioned models.
(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 SageMaker runs to test the algorithm.
ValidationRole (string) –
The IAM roles that SageMaker uses to run the training jobs.
ValidationProfiles (list) –
An array of
AlgorithmValidationProfileobjects, each of which specifies a training job and batch transform job that SageMaker runs to validate your algorithm.(dict) –
Defines a training job and a batch transform job that SageMaker runs to validate your algorithm.
The data provided in the validation profile is made available to your buyers on Amazon Web Services 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
TrainingJobDefinitionobject that describes the training job that SageMaker runs to validate your algorithm.TrainingInputMode (string) –
The training input mode that the algorithm supports. For more information about input modes, see Algorithms.
Pipe mode
If an algorithm supports
Pipemode, Amazon SageMaker streams data directly from Amazon S3 to the container.File mode
If an algorithm supports
Filemode, SageMaker downloads the training data from S3 to the provisioned ML storage volume, and mounts the directory to the Docker volume for the training container.You must provision the ML storage volume with sufficient capacity to accommodate the data downloaded from S3. In addition to the training data, the ML storage volume also stores the output model. The algorithm container uses the ML storage volume to also store intermediate information, if any.
For distributed algorithms, training data is distributed uniformly. Your training duration is predictable if the input data objects sizes are approximately the same. 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 when one host in a training cluster is overloaded, thus becoming a bottleneck in training.
FastFile mode
If an algorithm supports
FastFilemode, SageMaker streams data directly from S3 to the container with no code changes, and provides file system access to the data. Users can author their training script to interact with these files as if they were stored on disk.FastFilemode works best when the data is read sequentially. Augmented manifest files aren’t supported. The startup time is lower when there are fewer files in the S3 bucket provided.HyperParameters (dict) –
The hyperparameters used for the training job.
(string) –
(string) –
InputDataConfig (list) –
An array of
Channelobjects, 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,S3Uriidentifies a key name prefix. SageMaker uses all objects that match the specified key name prefix for model training.If you choose
ManifestFile,S3Uriidentifies an object that is a manifest file containing a list of object keys that you want 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.AugmentedManifestFilecan only be used if the Channel’s input mode isPipe.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/exampleprefixA manifest might look like this:
s3://bucketname/example.manifestA 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 ofS3Uri. Note that the prefix must be a valid non-emptyS3Urithat precludes users from specifying a manifest whose individualS3Uriis 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 followingS3Urilist:s3://customer_bucket/some/prefix/relative/path/to/custdata-1s3://customer_bucket/some/prefix/relative/path/custdata-2...s3://customer_bucket/some/prefix/relative/path/custdata-NThe complete set ofS3Uriin this manifest is the input data for the channel for this data source. The object that eachS3Uripoints to must be readable by the IAM role that SageMaker uses to perform tasks on your behalf.
Your input bucket must be located in same Amazon Web Services region as your training job.
S3DataDistributionType (string) –
If you want SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify
FullyReplicated.If you want 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 (whenTrainingInputModeis set toFile), 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) –
InstanceGroupNames (list) –
A list of names of instance groups that get data from the S3 data source.
(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) orrw(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.CompressionTypeis 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, 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, SageMaker uses the value set forTrainingInputMode. Use this parameter to override theTrainingInputModesetting 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, useFileinput mode. To stream data directly from Amazon S3 to the container, choosePipeinput mode.To use a model for incremental training, choose
Fileinput model.ShuffleConfig (dict) –
A configuration for a shuffle option for input data in a channel. If you use
S3PrefixforS3DataType, this shuffles the results of the S3 key prefix matches. If you useManifestFile, the order of the S3 object references in theManifestFileis shuffled. If you useAugmentedManifestFile, the order of the JSON lines in theAugmentedManifestFileis shuffled. The shuffling order is determined using theSeedvalue.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
S3DataDistributionTypeofShardedByS3Key, 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
ShuffleConfigvalue.
OutputDataConfig (dict) –
the path to the S3 bucket where you want to store model artifacts. SageMaker creates subfolders for the artifacts.
KmsKeyId (string) –
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The
KmsKeyIdcan 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 KMS key, the SageMaker execution role must include permissions to call
kms:Encrypt. If you don’t provide a KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role’s account. SageMaker uses server-side encryption with KMS-managed keys forOutputDataConfig. If you use a bucket policy with ans3:PutObjectpermission that only allows objects with server-side encryption, set the condition key ofs3:x-amz-server-side-encryptionto"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, orCreateHyperParameterTuningJobrequests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.S3OutputPath (string) –
Identifies the S3 path where you want 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.
Note
SageMaker Training on Amazon Elastic Compute Cloud (EC2) P4de instances is in preview release starting December 9th, 2022.
Amazon EC2 P4de instances (currently in preview) are powered by 8 NVIDIA A100 GPUs with 80GB high-performance HBM2e GPU memory, which accelerate the speed of training ML models that need to be trained on large datasets of high-resolution data. In this preview release, Amazon SageMaker supports ML training jobs on P4de instances (
ml.p4de.24xlarge) to reduce model training time. Theml.p4de.24xlargeinstances are available in the following Amazon Web Services Regions.US East (N. Virginia) (us-east-1)
US West (Oregon) (us-west-2)
To request quota limit increase and start using P4de instances, contact the SageMaker Training service team through your account team.
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
Fileas theTrainingInputModein the algorithm specification.When using an ML instance with NVMe SSD volumes, SageMaker doesn’t provision Amazon EBS General Purpose SSD (gp2) storage. Available storage is fixed to the NVMe-type instance’s storage capacity. SageMaker configures storage paths for training datasets, checkpoints, model artifacts, and outputs to use the entire capacity of the instance storage. For example, ML instance families with the NVMe-type instance storage include
ml.p4d,ml.g4dn, andml.g5.When using an ML instance with the EBS-only storage option and without instance storage, you must define the size of EBS volume through
VolumeSizeInGBin theResourceConfigAPI. For example, ML instance families that use EBS volumes includeml.c5andml.p2.To look up instance types and their instance storage types and volumes, see Amazon EC2 Instance Types.
To find the default local paths defined by the SageMaker training platform, see Amazon SageMaker Training Storage Folders for Training Datasets, Checkpoints, Model Artifacts, and Outputs.
VolumeKmsKeyId (string) –
The Amazon Web Services KMS key that 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
VolumeKmsKeyIdwhen 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
VolumeKmsKeyIdcan 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"
InstanceGroups (list) –
The configuration of a heterogeneous cluster in JSON format.
(dict) –
Defines an instance group for heterogeneous cluster training. When requesting a training job using the CreateTrainingJob API, you can configure multiple instance groups .
InstanceType (string) –
Specifies the instance type of the instance group.
InstanceCount (integer) –
Specifies the number of instances of the instance group.
InstanceGroupName (string) –
Specifies the name of the instance group.
KeepAlivePeriodInSeconds (integer) –
The duration of time in seconds to retain configured resources in a warm pool for subsequent training jobs.
StoppingCondition (dict) –
Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.
To stop a job, 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 a training or compilation job can run before it is stopped.
For compilation jobs, if the job does not complete during this time, a
TimeOuterror is generated. We recommend starting with 900 seconds and increasing as necessary based on your model.For all other jobs, if the job does not complete during this time, SageMaker ends the job. When
RetryStrategyis specified in the job request,MaxRuntimeInSecondsspecifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.The maximum time that a
TrainingJobcan run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 days.MaxWaitTimeInSeconds (integer) –
The maximum length of time, in seconds, that a managed Spot training job has to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the job can run. It must be equal to or greater than
MaxRuntimeInSeconds. If the job does not complete during this time, SageMaker ends the job.When
RetryStrategyis specified in the job request,MaxWaitTimeInSecondsspecifies the maximum time for all of the attempts in total, not each individual attempt.
TransformJobDefinition (dict) –
The
TransformJobDefinitionobject that describes the transform job that 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.
SingleRecordmeans only one record is used per mini-batch.MultiRecordmeans a mini-batch is set to contain as many records that can fit within theMaxPayloadInMBlimit.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,S3Uriidentifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for batch transform.If you choose
ManifestFile,S3Uriidentifies 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,S3PrefixThe following value is not compatible:
AugmentedManifestFileS3Uri (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.manifestThe 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 followingS3Uris:s3://customer_bucket/some/prefix/relative/path/to/custdata-1s3://customer_bucket/some/prefix/relative/path/custdata-2...s3://customer_bucket/some/prefix/relative/path/custdata-NThe complete set ofS3Urisin this manifest constitutes the input data for the channel for this datasource. The object that eachS3Urispoints 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
SplitTypeisNone, 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 toLineto split records on a newline character boundary.SplitTypealso 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
BatchStrategyandMaxPayloadInMBparameters. When the value ofBatchStrategyisMultiRecord, Amazon SageMaker sends the maximum number of records in each request, up to theMaxPayloadInMBlimit. If the value ofBatchStrategyisSingleRecord, 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
BatchStrategyis set toSingleRecord. Padding is not removed if the value ofBatchStrategyis set toMultiRecord.For more information about
RecordIO, see Create a Dataset Using RecordIO in the MXNet documentation. For more information aboutTFRecord, 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 .
outsuffix in a corresponding subfolder in the location in the output prefix. For example, for the input data stored ats3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform stores the transformed data ats3://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 .outfile 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, specifyLine.KmsKeyId (string) –
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The
KmsKeyIdcan be any of the following formats:Key ID:
1234abcd-12ab-34cd-56ef-1234567890abKey ARN:
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890abAlias name:
alias/ExampleAliasAlias 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 Amazon Web Services KMS in the Amazon Web Services 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. The default value is
1, and the maximum is100. For distributed transform jobs, specify a value greater than1.VolumeKmsKeyId (string) –
The Amazon Web Services Key Management Service (Amazon Web Services 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.
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
VolumeKmsKeyIdwhen 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
VolumeKmsKeyIdcan be any of the following formats:Key ID:
1234abcd-12ab-34cd-56ef-1234567890abKey ARN:
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890abAlias name:
alias/ExampleAliasAlias 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 Amazon Web Services Marketplace.