SageMaker / Client / describe_auto_ml_job_v2
describe_auto_ml_job_v2#
- SageMaker.Client.describe_auto_ml_job_v2(**kwargs)#
Returns information about an AutoML job created by calling CreateAutoMLJobV2 or CreateAutoMLJob.
See also: AWS API Documentation
Request Syntax
response = client.describe_auto_ml_job_v2( AutoMLJobName='string' )
- Parameters:
AutoMLJobName (string) –
[REQUIRED]
Requests information about an AutoML job V2 using its unique name.
- Return type:
dict
- Returns:
Response Syntax
{ 'AutoMLJobName': 'string', 'AutoMLJobArn': 'string', 'AutoMLJobInputDataConfig': [ { 'ChannelType': 'training'|'validation', 'ContentType': 'string', 'CompressionType': 'None'|'Gzip', 'DataSource': { 'S3DataSource': { 'S3DataType': 'ManifestFile'|'S3Prefix'|'AugmentedManifestFile', 'S3Uri': 'string' } } }, ], 'OutputDataConfig': { 'KmsKeyId': 'string', 'S3OutputPath': 'string' }, 'RoleArn': 'string', 'AutoMLJobObjective': { 'MetricName': 'Accuracy'|'MSE'|'F1'|'F1macro'|'AUC'|'RMSE'|'BalancedAccuracy'|'R2'|'Recall'|'RecallMacro'|'Precision'|'PrecisionMacro'|'MAE'|'MAPE'|'MASE'|'WAPE'|'AverageWeightedQuantileLoss' }, 'AutoMLProblemTypeConfig': { 'ImageClassificationJobConfig': { 'CompletionCriteria': { 'MaxCandidates': 123, 'MaxRuntimePerTrainingJobInSeconds': 123, 'MaxAutoMLJobRuntimeInSeconds': 123 } }, 'TextClassificationJobConfig': { 'CompletionCriteria': { 'MaxCandidates': 123, 'MaxRuntimePerTrainingJobInSeconds': 123, 'MaxAutoMLJobRuntimeInSeconds': 123 }, 'ContentColumn': 'string', 'TargetLabelColumn': 'string' }, 'TimeSeriesForecastingJobConfig': { 'FeatureSpecificationS3Uri': 'string', 'CompletionCriteria': { 'MaxCandidates': 123, 'MaxRuntimePerTrainingJobInSeconds': 123, 'MaxAutoMLJobRuntimeInSeconds': 123 }, 'ForecastFrequency': 'string', 'ForecastHorizon': 123, 'ForecastQuantiles': [ 'string', ], 'Transformations': { 'Filling': { 'string': { 'string': 'string' } }, 'Aggregation': { 'string': 'sum'|'avg'|'first'|'min'|'max' } }, 'TimeSeriesConfig': { 'TargetAttributeName': 'string', 'TimestampAttributeName': 'string', 'ItemIdentifierAttributeName': 'string', 'GroupingAttributeNames': [ 'string', ] }, 'HolidayConfig': [ { 'CountryCode': 'string' }, ] }, 'TabularJobConfig': { 'CandidateGenerationConfig': { 'AlgorithmsConfig': [ { 'AutoMLAlgorithms': [ 'xgboost'|'linear-learner'|'mlp'|'lightgbm'|'catboost'|'randomforest'|'extra-trees'|'nn-torch'|'fastai', ] }, ] }, 'CompletionCriteria': { 'MaxCandidates': 123, 'MaxRuntimePerTrainingJobInSeconds': 123, 'MaxAutoMLJobRuntimeInSeconds': 123 }, 'FeatureSpecificationS3Uri': 'string', 'Mode': 'AUTO'|'ENSEMBLING'|'HYPERPARAMETER_TUNING', 'GenerateCandidateDefinitionsOnly': True|False, 'ProblemType': 'BinaryClassification'|'MulticlassClassification'|'Regression', 'TargetAttributeName': 'string', 'SampleWeightAttributeName': 'string' }, 'TextGenerationJobConfig': { 'CompletionCriteria': { 'MaxCandidates': 123, 'MaxRuntimePerTrainingJobInSeconds': 123, 'MaxAutoMLJobRuntimeInSeconds': 123 }, 'BaseModelName': 'string', 'TextGenerationHyperParameters': { 'string': 'string' }, 'ModelAccessConfig': { 'AcceptEula': True|False } } }, 'AutoMLProblemTypeConfigName': 'ImageClassification'|'TextClassification'|'TimeSeriesForecasting'|'Tabular'|'TextGeneration', 'CreationTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'FailureReason': 'string', 'PartialFailureReasons': [ { 'PartialFailureMessage': 'string' }, ], 'BestCandidate': { 'CandidateName': 'string', 'FinalAutoMLJobObjectiveMetric': { 'Type': 'Maximize'|'Minimize', 'MetricName': 'Accuracy'|'MSE'|'F1'|'F1macro'|'AUC'|'RMSE'|'BalancedAccuracy'|'R2'|'Recall'|'RecallMacro'|'Precision'|'PrecisionMacro'|'MAE'|'MAPE'|'MASE'|'WAPE'|'AverageWeightedQuantileLoss', 'Value': ..., 'StandardMetricName': 'Accuracy'|'MSE'|'F1'|'F1macro'|'AUC'|'RMSE'|'BalancedAccuracy'|'R2'|'Recall'|'RecallMacro'|'Precision'|'PrecisionMacro'|'MAE'|'MAPE'|'MASE'|'WAPE'|'AverageWeightedQuantileLoss' }, 'ObjectiveStatus': 'Succeeded'|'Pending'|'Failed', 'CandidateSteps': [ { 'CandidateStepType': 'AWS::SageMaker::TrainingJob'|'AWS::SageMaker::TransformJob'|'AWS::SageMaker::ProcessingJob', 'CandidateStepArn': 'string', 'CandidateStepName': 'string' }, ], 'CandidateStatus': 'Completed'|'InProgress'|'Failed'|'Stopped'|'Stopping', 'InferenceContainers': [ { 'Image': 'string', 'ModelDataUrl': 'string', 'Environment': { 'string': 'string' } }, ], 'CreationTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'FailureReason': 'string', 'CandidateProperties': { 'CandidateArtifactLocations': { 'Explainability': 'string', 'ModelInsights': 'string', 'BacktestResults': 'string' }, 'CandidateMetrics': [ { 'MetricName': 'Accuracy'|'MSE'|'F1'|'F1macro'|'AUC'|'RMSE'|'BalancedAccuracy'|'R2'|'Recall'|'RecallMacro'|'Precision'|'PrecisionMacro'|'MAE'|'MAPE'|'MASE'|'WAPE'|'AverageWeightedQuantileLoss', 'Value': ..., 'Set': 'Train'|'Validation'|'Test', 'StandardMetricName': 'Accuracy'|'MSE'|'F1'|'F1macro'|'AUC'|'RMSE'|'MAE'|'R2'|'BalancedAccuracy'|'Precision'|'PrecisionMacro'|'Recall'|'RecallMacro'|'LogLoss'|'InferenceLatency'|'MAPE'|'MASE'|'WAPE'|'AverageWeightedQuantileLoss'|'Rouge1'|'Rouge2'|'RougeL'|'RougeLSum'|'Perplexity'|'ValidationLoss'|'TrainingLoss' }, ] }, 'InferenceContainerDefinitions': { 'string': [ { 'Image': 'string', 'ModelDataUrl': 'string', 'Environment': { 'string': 'string' } }, ] } }, 'AutoMLJobStatus': 'Completed'|'InProgress'|'Failed'|'Stopped'|'Stopping', 'AutoMLJobSecondaryStatus': 'Starting'|'MaxCandidatesReached'|'Failed'|'Stopped'|'MaxAutoMLJobRuntimeReached'|'Stopping'|'CandidateDefinitionsGenerated'|'Completed'|'ExplainabilityError'|'DeployingModel'|'ModelDeploymentError'|'GeneratingModelInsightsReport'|'ModelInsightsError'|'AnalyzingData'|'FeatureEngineering'|'ModelTuning'|'GeneratingExplainabilityReport'|'TrainingModels'|'PreTraining', 'AutoMLJobArtifacts': { 'CandidateDefinitionNotebookLocation': 'string', 'DataExplorationNotebookLocation': 'string' }, 'ResolvedAttributes': { 'AutoMLJobObjective': { 'MetricName': 'Accuracy'|'MSE'|'F1'|'F1macro'|'AUC'|'RMSE'|'BalancedAccuracy'|'R2'|'Recall'|'RecallMacro'|'Precision'|'PrecisionMacro'|'MAE'|'MAPE'|'MASE'|'WAPE'|'AverageWeightedQuantileLoss' }, 'CompletionCriteria': { 'MaxCandidates': 123, 'MaxRuntimePerTrainingJobInSeconds': 123, 'MaxAutoMLJobRuntimeInSeconds': 123 }, 'AutoMLProblemTypeResolvedAttributes': { 'TabularResolvedAttributes': { 'ProblemType': 'BinaryClassification'|'MulticlassClassification'|'Regression' }, 'TextGenerationResolvedAttributes': { 'BaseModelName': 'string' } } }, 'ModelDeployConfig': { 'AutoGenerateEndpointName': True|False, 'EndpointName': 'string' }, 'ModelDeployResult': { 'EndpointName': 'string' }, 'DataSplitConfig': { 'ValidationFraction': ... }, 'SecurityConfig': { 'VolumeKmsKeyId': 'string', 'EnableInterContainerTrafficEncryption': True|False, 'VpcConfig': { 'SecurityGroupIds': [ 'string', ], 'Subnets': [ 'string', ] } } }
Response Structure
(dict) –
AutoMLJobName (string) –
Returns the name of the AutoML job V2.
AutoMLJobArn (string) –
Returns the Amazon Resource Name (ARN) of the AutoML job V2.
AutoMLJobInputDataConfig (list) –
Returns an array of channel objects describing the input data and their location.
(dict) –
A channel is a named input source that training algorithms can consume. This channel is used for AutoML jobs V2 (jobs created by calling CreateAutoMLJobV2).
ChannelType (string) –
The type of channel. Defines whether the data are used for training or validation. The default value is
training. Channels fortrainingandvalidationmust share the sameContentTypeNote
The type of channel defaults to
trainingfor the time-series forecasting problem type.ContentType (string) –
The content type of the data from the input source. The following are the allowed content types for different problems:
For tabular problem types:
text/csv;header=presentorx-application/vnd.amazon+parquet. The default value istext/csv;header=present.For image classification:
image/png,image/jpeg, orimage/*. The default value isimage/*.For text classification:
text/csv;header=presentorx-application/vnd.amazon+parquet. The default value istext/csv;header=present.For time-series forecasting:
text/csv;header=presentorx-application/vnd.amazon+parquet. The default value istext/csv;header=present.For text generation (LLMs fine-tuning):
text/csv;header=presentorx-application/vnd.amazon+parquet. The default value istext/csv;header=present.
CompressionType (string) –
The allowed compression types depend on the input format and problem type. We allow the compression type
GzipforS3Prefixinputs on tabular data only. For all other inputs, the compression type should beNone. If no compression type is provided, we default toNone.DataSource (dict) –
The data source for an AutoML channel (Required).
S3DataSource (dict) –
The Amazon S3 location of the input data.
S3DataType (string) –
The data type.
If you choose
S3Prefix,S3Uriidentifies a key name prefix. SageMaker uses all objects that match the specified key name prefix for model training. TheS3Prefixshould have the following format:s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER-OR-FILEIf 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. AManifestFileshould have the format shown below:[ {"prefix": "s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/DOC-EXAMPLE-PREFIX/"},"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-1","DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-2",... "DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-N" ]If you choose
AugmentedManifestFile,S3Uriidentifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training.AugmentedManifestFileis available for V2 API jobs only (for example, for jobs created by callingCreateAutoMLJobV2). Here is a minimal, single-record example of anAugmentedManifestFile:{"source-ref": "s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/cats/cat.jpg","label-metadata": {"class-name": "cat"} For more information onAugmentedManifestFile, see Provide Dataset Metadata to Training Jobs with an Augmented Manifest File.
S3Uri (string) –
The URL to the Amazon S3 data source. The Uri refers to the Amazon S3 prefix or ManifestFile depending on the data type.
OutputDataConfig (dict) –
Returns the job’s output data config.
KmsKeyId (string) –
The Key Management Service (KMS) encryption key ID.
S3OutputPath (string) –
The Amazon S3 output path. Must be 128 characters or less.
RoleArn (string) –
The ARN of the Identity and Access Management role that has read permission to the input data location and write permission to the output data location in Amazon S3.
AutoMLJobObjective (dict) –
Returns the job’s objective.
MetricName (string) –
The name of the objective metric used to measure the predictive quality of a machine learning system. During training, the model’s parameters are updated iteratively to optimize its performance based on the feedback provided by the objective metric when evaluating the model on the validation dataset.
The list of available metrics supported by Autopilot and the default metric applied when you do not specify a metric name explicitly depend on the problem type.
For tabular problem types:
List of available metrics:
Regression:
InferenceLatency,MAE,MSE,R2,RMSEBinary classification:
Accuracy,AUC,BalancedAccuracy,F1,InferenceLatency,LogLoss,Precision,RecallMulticlass classification:
Accuracy,BalancedAccuracy,F1macro,InferenceLatency,LogLoss,PrecisionMacro,RecallMacro
For a description of each metric, see Autopilot metrics for classification and regression.
Default objective metrics:
Regression:
MSE.Binary classification:
F1.Multiclass classification:
Accuracy.
For image or text classification problem types:
List of available metrics:
AccuracyFor a description of each metric, see Autopilot metrics for text and image classification.Default objective metrics:
Accuracy
For time-series forecasting problem types:
List of available metrics:
RMSE,wQL,Average wQL,MASE,MAPE,WAPEFor a description of each metric, see Autopilot metrics for time-series forecasting.Default objective metrics:
AverageWeightedQuantileLoss
For text generation problem types (LLMs fine-tuning): Fine-tuning language models in Autopilot does not require setting the
AutoMLJobObjectivefield. Autopilot fine-tunes LLMs without requiring multiple candidates to be trained and evaluated. Instead, using your dataset, Autopilot directly fine-tunes your target model to enhance a default objective metric, the cross-entropy loss. After fine-tuning a language model, you can evaluate the quality of its generated text using different metrics. For a list of the available metrics, see Metrics for fine-tuning LLMs in Autopilot.
AutoMLProblemTypeConfig (dict) –
Returns the configuration settings of the problem type set for the AutoML job V2.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
ImageClassificationJobConfig,TextClassificationJobConfig,TimeSeriesForecastingJobConfig,TabularJobConfig,TextGenerationJobConfig. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBERas the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBERis as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
ImageClassificationJobConfig (dict) –
Settings used to configure an AutoML job V2 for the image classification problem type.
CompletionCriteria (dict) –
How long a job is allowed to run, or how many candidates a job is allowed to generate.
MaxCandidates (integer) –
The maximum number of times a training job is allowed to run.
For text and image classification, time-series forecasting, as well as text generation (LLMs fine-tuning) problem types, the supported value is 1. For tabular problem types, the maximum value is 750.
MaxRuntimePerTrainingJobInSeconds (integer) –
The maximum time, in seconds, that each training job executed inside hyperparameter tuning is allowed to run as part of a hyperparameter tuning job. For more information, see the StoppingCondition used by the CreateHyperParameterTuningJob action.
For job V2s (jobs created by calling
CreateAutoMLJobV2), this field controls the runtime of the job candidate.For TextGenerationJobConfig problem types, the maximum time defaults to 72 hours (259200 seconds).
MaxAutoMLJobRuntimeInSeconds (integer) –
The maximum runtime, in seconds, an AutoML job has to complete.
If an AutoML job exceeds the maximum runtime, the job is stopped automatically and its processing is ended gracefully. The AutoML job identifies the best model whose training was completed and marks it as the best-performing model. Any unfinished steps of the job, such as automatic one-click Autopilot model deployment, are not completed.
TextClassificationJobConfig (dict) –
Settings used to configure an AutoML job V2 for the text classification problem type.
CompletionCriteria (dict) –
How long a job is allowed to run, or how many candidates a job is allowed to generate.
MaxCandidates (integer) –
The maximum number of times a training job is allowed to run.
For text and image classification, time-series forecasting, as well as text generation (LLMs fine-tuning) problem types, the supported value is 1. For tabular problem types, the maximum value is 750.
MaxRuntimePerTrainingJobInSeconds (integer) –
The maximum time, in seconds, that each training job executed inside hyperparameter tuning is allowed to run as part of a hyperparameter tuning job. For more information, see the StoppingCondition used by the CreateHyperParameterTuningJob action.
For job V2s (jobs created by calling
CreateAutoMLJobV2), this field controls the runtime of the job candidate.For TextGenerationJobConfig problem types, the maximum time defaults to 72 hours (259200 seconds).
MaxAutoMLJobRuntimeInSeconds (integer) –
The maximum runtime, in seconds, an AutoML job has to complete.
If an AutoML job exceeds the maximum runtime, the job is stopped automatically and its processing is ended gracefully. The AutoML job identifies the best model whose training was completed and marks it as the best-performing model. Any unfinished steps of the job, such as automatic one-click Autopilot model deployment, are not completed.
ContentColumn (string) –
The name of the column used to provide the sentences to be classified. It should not be the same as the target column.
TargetLabelColumn (string) –
The name of the column used to provide the class labels. It should not be same as the content column.
TimeSeriesForecastingJobConfig (dict) –
Settings used to configure an AutoML job V2 for the time-series forecasting problem type.
FeatureSpecificationS3Uri (string) –
A URL to the Amazon S3 data source containing additional selected features that complement the target, itemID, timestamp, and grouped columns set in
TimeSeriesConfig. When not provided, the AutoML job V2 includes all the columns from the original dataset that are not already declared inTimeSeriesConfig. If provided, the AutoML job V2 only considers these additional columns as a complement to the ones declared inTimeSeriesConfig.You can input
FeatureAttributeNames(optional) in JSON format as shown below:{ "FeatureAttributeNames":["col1", "col2", ...] }.You can also specify the data type of the feature (optional) in the format shown below:
{ "FeatureDataTypes":{"col1":"numeric", "col2":"categorical" ... } }Autopilot supports the following data types:
numeric,categorical,text, anddatetime.Note
These column keys must not include any column set in
TimeSeriesConfig.CompletionCriteria (dict) –
How long a job is allowed to run, or how many candidates a job is allowed to generate.
MaxCandidates (integer) –
The maximum number of times a training job is allowed to run.
For text and image classification, time-series forecasting, as well as text generation (LLMs fine-tuning) problem types, the supported value is 1. For tabular problem types, the maximum value is 750.
MaxRuntimePerTrainingJobInSeconds (integer) –
The maximum time, in seconds, that each training job executed inside hyperparameter tuning is allowed to run as part of a hyperparameter tuning job. For more information, see the StoppingCondition used by the CreateHyperParameterTuningJob action.
For job V2s (jobs created by calling
CreateAutoMLJobV2), this field controls the runtime of the job candidate.For TextGenerationJobConfig problem types, the maximum time defaults to 72 hours (259200 seconds).
MaxAutoMLJobRuntimeInSeconds (integer) –
The maximum runtime, in seconds, an AutoML job has to complete.
If an AutoML job exceeds the maximum runtime, the job is stopped automatically and its processing is ended gracefully. The AutoML job identifies the best model whose training was completed and marks it as the best-performing model. Any unfinished steps of the job, such as automatic one-click Autopilot model deployment, are not completed.
ForecastFrequency (string) –
The frequency of predictions in a forecast.
Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example,
1Dindicates every day and15minindicates every 15 minutes. The value of a frequency must not overlap with the next larger frequency. For example, you must use a frequency of1Hinstead of60min.The valid values for each frequency are the following:
Minute - 1-59
Hour - 1-23
Day - 1-6
Week - 1-4
Month - 1-11
Year - 1
ForecastHorizon (integer) –
The number of time-steps that the model predicts. The forecast horizon is also called the prediction length. The maximum forecast horizon is the lesser of 500 time-steps or 1/4 of the time-steps in the dataset.
ForecastQuantiles (list) –
The quantiles used to train the model for forecasts at a specified quantile. You can specify quantiles from
0.01(p1) to0.99(p99), by increments of 0.01 or higher. Up to five forecast quantiles can be specified. WhenForecastQuantilesis not provided, the AutoML job uses the quantiles p10, p50, and p90 as default.(string) –
Transformations (dict) –
The transformations modifying specific attributes of the time-series, such as filling strategies for missing values.
Filling (dict) –
A key value pair defining the filling method for a column, where the key is the column name and the value is an object which defines the filling logic. You can specify multiple filling methods for a single column.
The supported filling methods and their corresponding options are:
frontfill:none(Supported only for target column)middlefill:zero,value,median,mean,min,maxbackfill:zero,value,median,mean,min,maxfuturefill:zero,value,median,mean,min,max
To set a filling method to a specific value, set the fill parameter to the chosen filling method value (for example
"backfill" : "value"), and define the filling value in an additional parameter prefixed with “_value”. For example, to setbackfillto a value of2, you must include two parameters:"backfill": "value"and"backfill_value":"2".(string) –
(dict) –
(string) –
(string) –
Aggregation (dict) –
A key value pair defining the aggregation method for a column, where the key is the column name and the value is the aggregation method.
The supported aggregation methods are
sum(default),avg,first,min,max.Note
Aggregation is only supported for the target column.
(string) –
(string) –
TimeSeriesConfig (dict) –
The collection of components that defines the time-series.
TargetAttributeName (string) –
The name of the column representing the target variable that you want to predict for each item in your dataset. The data type of the target variable must be numerical.
TimestampAttributeName (string) –
The name of the column indicating a point in time at which the target value of a given item is recorded.
ItemIdentifierAttributeName (string) –
The name of the column that represents the set of item identifiers for which you want to predict the target value.
GroupingAttributeNames (list) –
A set of columns names that can be grouped with the item identifier column to create a composite key for which a target value is predicted.
(string) –
HolidayConfig (list) –
The collection of holiday featurization attributes used to incorporate national holiday information into your forecasting model.
(dict) –
Stores the holiday featurization attributes applicable to each item of time-series datasets during the training of a forecasting model. This allows the model to identify patterns associated with specific holidays.
CountryCode (string) –
The country code for the holiday calendar.
For the list of public holiday calendars supported by AutoML job V2, see Country Codes. Use the country code corresponding to the country of your choice.
TabularJobConfig (dict) –
Settings used to configure an AutoML job V2 for the tabular problem type (regression, classification).
CandidateGenerationConfig (dict) –
The configuration information of how model candidates are generated.
AlgorithmsConfig (list) –
Stores the configuration information for the selection of algorithms used to train model candidates on tabular data.
The list of available algorithms to choose from depends on the training mode set in TabularJobConfig.Mode.
AlgorithmsConfigshould not be set inAUTOtraining mode.When
AlgorithmsConfigis provided, oneAutoMLAlgorithmsattribute must be set and one only. If the list of algorithms provided as values forAutoMLAlgorithmsis empty,CandidateGenerationConfiguses the full set of algorithms for the given training mode.When
AlgorithmsConfigis not provided,CandidateGenerationConfiguses the full set of algorithms for the given training mode.
For the list of all algorithms per problem type and training mode, see AutoMLAlgorithmConfig.
For more information on each algorithm, see the Algorithm support section in Autopilot developer guide.
(dict) –
The collection of algorithms run on a dataset for training the model candidates of an Autopilot job.
AutoMLAlgorithms (list) –
The selection of algorithms run on a dataset to train the model candidates of an Autopilot job.
Note
Selected algorithms must belong to the list corresponding to the training mode set in AutoMLJobConfig.Mode (
ENSEMBLINGorHYPERPARAMETER_TUNING). Choose a minimum of 1 algorithm.In
ENSEMBLINGmode:”catboost”
”extra-trees”
”fastai”
”lightgbm”
”linear-learner”
”nn-torch”
”randomforest”
”xgboost”
In
HYPERPARAMETER_TUNINGmode:”linear-learner”
”mlp”
”xgboost”
(string) –
CompletionCriteria (dict) –
How long a job is allowed to run, or how many candidates a job is allowed to generate.
MaxCandidates (integer) –
The maximum number of times a training job is allowed to run.
For text and image classification, time-series forecasting, as well as text generation (LLMs fine-tuning) problem types, the supported value is 1. For tabular problem types, the maximum value is 750.
MaxRuntimePerTrainingJobInSeconds (integer) –
The maximum time, in seconds, that each training job executed inside hyperparameter tuning is allowed to run as part of a hyperparameter tuning job. For more information, see the StoppingCondition used by the CreateHyperParameterTuningJob action.
For job V2s (jobs created by calling
CreateAutoMLJobV2), this field controls the runtime of the job candidate.For TextGenerationJobConfig problem types, the maximum time defaults to 72 hours (259200 seconds).
MaxAutoMLJobRuntimeInSeconds (integer) –
The maximum runtime, in seconds, an AutoML job has to complete.
If an AutoML job exceeds the maximum runtime, the job is stopped automatically and its processing is ended gracefully. The AutoML job identifies the best model whose training was completed and marks it as the best-performing model. Any unfinished steps of the job, such as automatic one-click Autopilot model deployment, are not completed.
FeatureSpecificationS3Uri (string) –
A URL to the Amazon S3 data source containing selected features from the input data source to run an Autopilot job V2. You can input
FeatureAttributeNames(optional) in JSON format as shown below:{ "FeatureAttributeNames":["col1", "col2", ...] }.You can also specify the data type of the feature (optional) in the format shown below:
{ "FeatureDataTypes":{"col1":"numeric", "col2":"categorical" ... } }Note
These column keys may not include the target column.
In ensembling mode, Autopilot only supports the following data types:
numeric,categorical,text, anddatetime. In HPO mode, Autopilot can supportnumeric,categorical,text,datetime, andsequence.If only
FeatureDataTypesis provided, the column keys (col1,col2,..) should be a subset of the column names in the input data.If both
FeatureDataTypesandFeatureAttributeNamesare provided, then the column keys should be a subset of the column names provided inFeatureAttributeNames.The key name
FeatureAttributeNamesis fixed. The values listed in["col1", "col2", ...]are case sensitive and should be a list of strings containing unique values that are a subset of the column names in the input data. The list of columns provided must not include the target column.Mode (string) –
The method that Autopilot uses to train the data. You can either specify the mode manually or let Autopilot choose for you based on the dataset size by selecting
AUTO. InAUTOmode, Autopilot choosesENSEMBLINGfor datasets smaller than 100 MB, andHYPERPARAMETER_TUNINGfor larger ones.The
ENSEMBLINGmode uses a multi-stack ensemble model to predict classification and regression tasks directly from your dataset. This machine learning mode combines several base models to produce an optimal predictive model. It then uses a stacking ensemble method to combine predictions from contributing members. A multi-stack ensemble model can provide better performance over a single model by combining the predictive capabilities of multiple models. See Autopilot algorithm support for a list of algorithms supported byENSEMBLINGmode.The
HYPERPARAMETER_TUNING(HPO) mode uses the best hyperparameters to train the best version of a model. HPO automatically selects an algorithm for the type of problem you want to solve. Then HPO finds the best hyperparameters according to your objective metric. See Autopilot algorithm support for a list of algorithms supported byHYPERPARAMETER_TUNINGmode.GenerateCandidateDefinitionsOnly (boolean) –
Generates possible candidates without training the models. A model candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.
ProblemType (string) –
The type of supervised learning problem available for the model candidates of the AutoML job V2. For more information, see Amazon SageMaker Autopilot problem types.
Note
You must either specify the type of supervised learning problem in
ProblemTypeand provide the AutoMLJobObjective metric, or none at all.TargetAttributeName (string) –
The name of the target variable in supervised learning, usually represented by ‘y’.
SampleWeightAttributeName (string) –
If specified, this column name indicates which column of the dataset should be treated as sample weights for use by the objective metric during the training, evaluation, and the selection of the best model. This column is not considered as a predictive feature. For more information on Autopilot metrics, see Metrics and validation.
Sample weights should be numeric, non-negative, with larger values indicating which rows are more important than others. Data points that have invalid or no weight value are excluded.
Support for sample weights is available in Ensembling mode only.
TextGenerationJobConfig (dict) –
Settings used to configure an AutoML job V2 for the text generation (LLMs fine-tuning) problem type.
Note
The text generation models that support fine-tuning in Autopilot are currently accessible exclusively in regions supported by Canvas. Refer to the documentation of Canvas for the full list of its supported Regions.
CompletionCriteria (dict) –
How long a fine-tuning job is allowed to run. For
TextGenerationJobConfigproblem types, theMaxRuntimePerTrainingJobInSecondsattribute ofAutoMLJobCompletionCriteriadefaults to 72h (259200s).MaxCandidates (integer) –
The maximum number of times a training job is allowed to run.
For text and image classification, time-series forecasting, as well as text generation (LLMs fine-tuning) problem types, the supported value is 1. For tabular problem types, the maximum value is 750.
MaxRuntimePerTrainingJobInSeconds (integer) –
The maximum time, in seconds, that each training job executed inside hyperparameter tuning is allowed to run as part of a hyperparameter tuning job. For more information, see the StoppingCondition used by the CreateHyperParameterTuningJob action.
For job V2s (jobs created by calling
CreateAutoMLJobV2), this field controls the runtime of the job candidate.For TextGenerationJobConfig problem types, the maximum time defaults to 72 hours (259200 seconds).
MaxAutoMLJobRuntimeInSeconds (integer) –
The maximum runtime, in seconds, an AutoML job has to complete.
If an AutoML job exceeds the maximum runtime, the job is stopped automatically and its processing is ended gracefully. The AutoML job identifies the best model whose training was completed and marks it as the best-performing model. Any unfinished steps of the job, such as automatic one-click Autopilot model deployment, are not completed.
BaseModelName (string) –
The name of the base model to fine-tune. Autopilot supports fine-tuning a variety of large language models. For information on the list of supported models, see Text generation models supporting fine-tuning in Autopilot. If no
BaseModelNameis provided, the default model used is Falcon7BInstruct.TextGenerationHyperParameters (dict) –
The hyperparameters used to configure and optimize the learning process of the base model. You can set any combination of the following hyperparameters for all base models. For more information on each supported hyperparameter, see Optimize the learning process of your text generation models with hyperparameters.
"epochCount": The number of times the model goes through the entire training dataset. Its value should be a string containing an integer value within the range of “1” to “10”."batchSize": The number of data samples used in each iteration of training. Its value should be a string containing an integer value within the range of “1” to “64”."learningRate": The step size at which a model’s parameters are updated during training. Its value should be a string containing a floating-point value within the range of “0” to “1”."learningRateWarmupSteps": The number of training steps during which the learning rate gradually increases before reaching its target or maximum value. Its value should be a string containing an integer value within the range of “0” to “250”.
Here is an example where all four hyperparameters are configured.
{ "epochCount":"5", "learningRate":"0.5", "batchSize": "32", "learningRateWarmupSteps": "10" }(string) –
(string) –
ModelAccessConfig (dict) –
The access configuration file to control access to the ML model. You can explicitly accept the model end-user license agreement (EULA) within the
ModelAccessConfig.If you are a Jumpstart user, see the End-user license agreements section for more details on accepting the EULA.
If you are an AutoML user, see the Optional Parameters section of Create an AutoML job to fine-tune text generation models using the API for details on How to set the EULA acceptance when fine-tuning a model using the AutoML API.
AcceptEula (boolean) –
Specifies agreement to the model end-user license agreement (EULA). The
AcceptEulavalue must be explicitly defined asTruein order to accept the EULA that this model requires. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model.
AutoMLProblemTypeConfigName (string) –
Returns the name of the problem type configuration set for the AutoML job V2.
CreationTime (datetime) –
Returns the creation time of the AutoML job V2.
EndTime (datetime) –
Returns the end time of the AutoML job V2.
LastModifiedTime (datetime) –
Returns the job’s last modified time.
FailureReason (string) –
Returns the reason for the failure of the AutoML job V2, when applicable.
PartialFailureReasons (list) –
Returns a list of reasons for partial failures within an AutoML job V2.
(dict) –
The reason for a partial failure of an AutoML job.
PartialFailureMessage (string) –
The message containing the reason for a partial failure of an AutoML job.
BestCandidate (dict) –
Information about the candidate produced by an AutoML training job V2, including its status, steps, and other properties.
CandidateName (string) –
The name of the candidate.
FinalAutoMLJobObjectiveMetric (dict) –
The best candidate result from an AutoML training job.
Type (string) –
The type of metric with the best result.
MetricName (string) –
The name of the metric with the best result. For a description of the possible objective metrics, see AutoMLJobObjective$MetricName.
Value (float) –
The value of the metric with the best result.
StandardMetricName (string) –
The name of the standard metric. For a description of the standard metrics, see Autopilot candidate metrics.
ObjectiveStatus (string) –
The objective’s status.
CandidateSteps (list) –
Information about the candidate’s steps.
(dict) –
Information about the steps for a candidate and what step it is working on.
CandidateStepType (string) –
Whether the candidate is at the transform, training, or processing step.
CandidateStepArn (string) –
The ARN for the candidate’s step.
CandidateStepName (string) –
The name for the candidate’s step.
CandidateStatus (string) –
The candidate’s status.
InferenceContainers (list) –
Information about the recommended inference container definitions.
(dict) –
A list of container definitions that describe the different containers that make up an AutoML candidate. For more information, see ContainerDefinition.
Image (string) –
The Amazon Elastic Container Registry (Amazon ECR) path of the container. For more information, see ContainerDefinition.
ModelDataUrl (string) –
The location of the model artifacts. For more information, see ContainerDefinition.
Environment (dict) –
The environment variables to set in the container. For more information, see ContainerDefinition.
(string) –
(string) –
CreationTime (datetime) –
The creation time.
EndTime (datetime) –
The end time.
LastModifiedTime (datetime) –
The last modified time.
FailureReason (string) –
The failure reason.
CandidateProperties (dict) –
The properties of an AutoML candidate job.
CandidateArtifactLocations (dict) –
The Amazon S3 prefix to the artifacts generated for an AutoML candidate.
Explainability (string) –
The Amazon S3 prefix to the explainability artifacts generated for the AutoML candidate.
ModelInsights (string) –
The Amazon S3 prefix to the model insight artifacts generated for the AutoML candidate.
BacktestResults (string) –
The Amazon S3 prefix to the accuracy metrics and the inference results observed over the testing window. Available only for the time-series forecasting problem type.
CandidateMetrics (list) –
Information about the candidate metrics for an AutoML job.
(dict) –
Information about the metric for a candidate produced by an AutoML job.
MetricName (string) –
The name of the metric.
Value (float) –
The value of the metric.
Set (string) –
The dataset split from which the AutoML job produced the metric.
StandardMetricName (string) –
The name of the standard metric.
Note
For definitions of the standard metrics, see Autopilot candidate metrics.
InferenceContainerDefinitions (dict) –
The mapping of all supported processing unit (CPU, GPU, etc…) to inference container definitions for the candidate. This field is populated for the AutoML jobs V2 (for example, for jobs created by calling
CreateAutoMLJobV2) related to image or text classification problem types only.(string) –
Processing unit for an inference container. Currently Autopilot only supports
CPUorGPU.(list) –
Information about the recommended inference container definitions.
(dict) –
A list of container definitions that describe the different containers that make up an AutoML candidate. For more information, see ContainerDefinition.
Image (string) –
The Amazon Elastic Container Registry (Amazon ECR) path of the container. For more information, see ContainerDefinition.
ModelDataUrl (string) –
The location of the model artifacts. For more information, see ContainerDefinition.
Environment (dict) –
The environment variables to set in the container. For more information, see ContainerDefinition.
(string) –
(string) –
AutoMLJobStatus (string) –
Returns the status of the AutoML job V2.
AutoMLJobSecondaryStatus (string) –
Returns the secondary status of the AutoML job V2.
AutoMLJobArtifacts (dict) –
The artifacts that are generated during an AutoML job.
CandidateDefinitionNotebookLocation (string) –
The URL of the notebook location.
DataExplorationNotebookLocation (string) –
The URL of the notebook location.
ResolvedAttributes (dict) –
Returns the resolved attributes used by the AutoML job V2.
AutoMLJobObjective (dict) –
Specifies a metric to minimize or maximize as the objective of an AutoML job.
MetricName (string) –
The name of the objective metric used to measure the predictive quality of a machine learning system. During training, the model’s parameters are updated iteratively to optimize its performance based on the feedback provided by the objective metric when evaluating the model on the validation dataset.
The list of available metrics supported by Autopilot and the default metric applied when you do not specify a metric name explicitly depend on the problem type.
For tabular problem types:
List of available metrics:
Regression:
InferenceLatency,MAE,MSE,R2,RMSEBinary classification:
Accuracy,AUC,BalancedAccuracy,F1,InferenceLatency,LogLoss,Precision,RecallMulticlass classification:
Accuracy,BalancedAccuracy,F1macro,InferenceLatency,LogLoss,PrecisionMacro,RecallMacro
For a description of each metric, see Autopilot metrics for classification and regression.
Default objective metrics:
Regression:
MSE.Binary classification:
F1.Multiclass classification:
Accuracy.
For image or text classification problem types:
List of available metrics:
AccuracyFor a description of each metric, see Autopilot metrics for text and image classification.Default objective metrics:
Accuracy
For time-series forecasting problem types:
List of available metrics:
RMSE,wQL,Average wQL,MASE,MAPE,WAPEFor a description of each metric, see Autopilot metrics for time-series forecasting.Default objective metrics:
AverageWeightedQuantileLoss
For text generation problem types (LLMs fine-tuning): Fine-tuning language models in Autopilot does not require setting the
AutoMLJobObjectivefield. Autopilot fine-tunes LLMs without requiring multiple candidates to be trained and evaluated. Instead, using your dataset, Autopilot directly fine-tunes your target model to enhance a default objective metric, the cross-entropy loss. After fine-tuning a language model, you can evaluate the quality of its generated text using different metrics. For a list of the available metrics, see Metrics for fine-tuning LLMs in Autopilot.
CompletionCriteria (dict) –
How long a job is allowed to run, or how many candidates a job is allowed to generate.
MaxCandidates (integer) –
The maximum number of times a training job is allowed to run.
For text and image classification, time-series forecasting, as well as text generation (LLMs fine-tuning) problem types, the supported value is 1. For tabular problem types, the maximum value is 750.
MaxRuntimePerTrainingJobInSeconds (integer) –
The maximum time, in seconds, that each training job executed inside hyperparameter tuning is allowed to run as part of a hyperparameter tuning job. For more information, see the StoppingCondition used by the CreateHyperParameterTuningJob action.
For job V2s (jobs created by calling
CreateAutoMLJobV2), this field controls the runtime of the job candidate.For TextGenerationJobConfig problem types, the maximum time defaults to 72 hours (259200 seconds).
MaxAutoMLJobRuntimeInSeconds (integer) –
The maximum runtime, in seconds, an AutoML job has to complete.
If an AutoML job exceeds the maximum runtime, the job is stopped automatically and its processing is ended gracefully. The AutoML job identifies the best model whose training was completed and marks it as the best-performing model. Any unfinished steps of the job, such as automatic one-click Autopilot model deployment, are not completed.
AutoMLProblemTypeResolvedAttributes (dict) –
Defines the resolved attributes specific to a problem type.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
TabularResolvedAttributes,TextGenerationResolvedAttributes. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBERas the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBERis as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
TabularResolvedAttributes (dict) –
The resolved attributes for the tabular problem type.
ProblemType (string) –
The type of supervised learning problem available for the model candidates of the AutoML job V2 (Binary Classification, Multiclass Classification, Regression). For more information, see Amazon SageMaker Autopilot problem types.
TextGenerationResolvedAttributes (dict) –
The resolved attributes for the text generation problem type.
BaseModelName (string) –
The name of the base model to fine-tune.
ModelDeployConfig (dict) –
Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.
AutoGenerateEndpointName (boolean) –
Set to
Trueto automatically generate an endpoint name for a one-click Autopilot model deployment; set toFalseotherwise. The default value isFalse.Note
If you set
AutoGenerateEndpointNametoTrue, do not specify theEndpointName; otherwise a 400 error is thrown.EndpointName (string) –
Specifies the endpoint name to use for a one-click Autopilot model deployment if the endpoint name is not generated automatically.
Note
Specify the
EndpointNameif and only if you setAutoGenerateEndpointNametoFalse; otherwise a 400 error is thrown.
ModelDeployResult (dict) –
Provides information about endpoint for the model deployment.
EndpointName (string) –
The name of the endpoint to which the model has been deployed.
Note
If model deployment fails, this field is omitted from the response.
DataSplitConfig (dict) –
Returns the configuration settings of how the data are split into train and validation datasets.
ValidationFraction (float) –
The validation fraction (optional) is a float that specifies the portion of the training dataset to be used for validation. The default value is 0.2, and values must be greater than 0 and less than 1. We recommend setting this value to be less than 0.5.
SecurityConfig (dict) –
Returns the security configuration for traffic encryption or Amazon VPC settings.
VolumeKmsKeyId (string) –
The key used to encrypt stored data.
EnableInterContainerTrafficEncryption (boolean) –
Whether to use traffic encryption between the container layers.
VpcConfig (dict) –
The VPC configuration.
SecurityGroupIds (list) –
The VPC security group IDs, in the form
sg-xxxxxxxx. Specify the security groups for the VPC that is specified in theSubnetsfield.(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) –
Exceptions
SageMaker.Client.exceptions.ResourceNotFound