SageMaker / Client / create_auto_ml_job

create_auto_ml_job#

SageMaker.Client.create_auto_ml_job(**kwargs)#

Creates an Autopilot job.

Find the best-performing model after you run an Autopilot job by calling DescribeAutoMLJob.

For information about how to use Autopilot, see Automate Model Development with Amazon SageMaker Autopilot.

Request Syntax

response = client.create_auto_ml_job(
    AutoMLJobName='string',
    InputDataConfig=[
        {
            'DataSource': {
                'S3DataSource': {
                    'S3DataType': 'ManifestFile'|'S3Prefix'|'AugmentedManifestFile',
                    'S3Uri': 'string'
                }
            },
            'CompressionType': 'None'|'Gzip',
            'TargetAttributeName': 'string',
            'ContentType': 'string',
            'ChannelType': 'training'|'validation',
            'SampleWeightAttributeName': 'string'
        },
    ],
    OutputDataConfig={
        'KmsKeyId': 'string',
        'S3OutputPath': 'string'
    },
    ProblemType='BinaryClassification'|'MulticlassClassification'|'Regression',
    AutoMLJobObjective={
        'MetricName': 'Accuracy'|'MSE'|'F1'|'F1macro'|'AUC'|'RMSE'|'MAE'|'R2'|'BalancedAccuracy'|'Precision'|'PrecisionMacro'|'Recall'|'RecallMacro'
    },
    AutoMLJobConfig={
        'CompletionCriteria': {
            'MaxCandidates': 123,
            'MaxRuntimePerTrainingJobInSeconds': 123,
            'MaxAutoMLJobRuntimeInSeconds': 123
        },
        'SecurityConfig': {
            'VolumeKmsKeyId': 'string',
            'EnableInterContainerTrafficEncryption': True|False,
            'VpcConfig': {
                'SecurityGroupIds': [
                    'string',
                ],
                'Subnets': [
                    'string',
                ]
            }
        },
        'DataSplitConfig': {
            'ValidationFraction': ...
        },
        'CandidateGenerationConfig': {
            'FeatureSpecificationS3Uri': 'string',
            'AlgorithmsConfig': [
                {
                    'AutoMLAlgorithms': [
                        'xgboost'|'linear-learner'|'mlp'|'lightgbm'|'catboost'|'randomforest'|'extra-trees'|'nn-torch'|'fastai',
                    ]
                },
            ]
        },
        'Mode': 'AUTO'|'ENSEMBLING'|'HYPERPARAMETER_TUNING'
    },
    RoleArn='string',
    GenerateCandidateDefinitionsOnly=True|False,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ModelDeployConfig={
        'AutoGenerateEndpointName': True|False,
        'EndpointName': 'string'
    }
)

Parameters:

AutoMLJobName (string) –
[REQUIRED]

Identifies an Autopilot job. The name must be unique to your account and is case insensitive.
InputDataConfig (list) –
[REQUIRED]

An array of channel objects that describes the input data and its location. Each channel is a named input source. Similar to InputDataConfig supported by HyperParameterTrainingJobDefinition. Format(s) supported: CSV, Parquet. A minimum of 500 rows is required for the training dataset. There is not a minimum number of rows required for the validation dataset.
- (dict) –
  
  A channel is a named input source that training algorithms can consume. The validation dataset size is limited to less than 2 GB. The training dataset size must be less than 100 GB. For more information, see Channel.
  
  Note
  
  A validation dataset must contain the same headers as the training dataset.
  - DataSource (dict) – [REQUIRED]
    
    The data source for an AutoML channel.
    - S3DataSource (dict) – [REQUIRED]
      
      The Amazon S3 location of the input data.
      - S3DataType (string) – [REQUIRED]
        
        The data type.
        
        If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker uses all objects that match the specified key name prefix for model training. The S3Prefix should have the following format: s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER-OR-FILE
        
        If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want SageMaker to use for model training. A ManifestFile should 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, 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 is available for V2 API jobs only (for example, for jobs created by calling CreateAutoMLJobV2). Here is a minimal, single-record example of an AugmentedManifestFile: {"source-ref": "s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/cats/cat.jpg", "label-metadata": {"class-name": "cat" } For more information on AugmentedManifestFile, see Provide Dataset Metadata to Training Jobs with an Augmented Manifest File.
      - S3Uri (string) – [REQUIRED]
        
        The URL to the Amazon S3 data source. The Uri refers to the Amazon S3 prefix or ManifestFile depending on the data type.
  - CompressionType (string) –
    
    You can use Gzip or None. The default value is None.
  - TargetAttributeName (string) – [REQUIRED]
    
    The name of the target variable in supervised learning, usually represented by ‘y’.
  - ContentType (string) –
    
    The content type of the data from the input source. You can use text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.
  - ChannelType (string) –
    
    The channel type (optional) is an enum string. The default value is training. Channels for training and validation must share the same ContentType and TargetAttributeName. For information on specifying training and validation channel types, see How to specify training and validation datasets.
  - 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.
OutputDataConfig (dict) –
[REQUIRED]

Provides information about encryption and the Amazon S3 output path needed to store artifacts from an AutoML job. Format(s) supported: CSV.
- KmsKeyId (string) –
  
  The Key Management Service (KMS) encryption key ID.
- S3OutputPath (string) – [REQUIRED]
  
  The Amazon S3 output path. Must be 128 characters or less.
ProblemType (string) – Defines the type of supervised learning problem available for the candidates. For more information, see Amazon SageMaker Autopilot problem types.
AutoMLJobObjective (dict) –
Defines the objective metric used to measure the predictive quality of an AutoML job. You provide an AutoMLJobObjective$MetricName and Autopilot infers whether to minimize or maximize it. For CreateAutoMLJobV2, only Accuracy is supported.
- MetricName (string) – [REQUIRED]
  
  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.
  
  For the list of all available metrics supported by Autopilot, see Autopilot metrics.
  
  If you do not specify a metric explicitly, the default behavior is to automatically use:
  - MSE: for regression.
  - F1: for binary classification
  - Accuracy: for multiclass classification.
AutoMLJobConfig (dict) –
A collection of settings used to configure an AutoML job.
- CompletionCriteria (dict) –
  
  How long an AutoML 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 V2 jobs (jobs created by calling CreateAutoMLJobV2), the supported value is 1.
  - 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 V2 jobs (jobs created by calling CreateAutoMLJobV2), this field controls the runtime of the job candidate.
  - 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.
- SecurityConfig (dict) –
  
  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) – [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) –
- DataSplitConfig (dict) –
  
  The configuration for splitting the input training dataset.
  
  Type: AutoMLDataSplitConfig
  - 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.
- CandidateGenerationConfig (dict) –
  
  The configuration for generating a candidate for an AutoML job (optional).
  - FeatureSpecificationS3Uri (string) –
    
    A URL to the Amazon S3 data source containing selected features from the input data source to run an Autopilot job. 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, and datetime. In HPO mode, Autopilot can support numeric, categorical, text, datetime, and sequence.
    
    If only FeatureDataTypes is provided, the column keys ( col1, col2,..) should be a subset of the column names in the input data.
    
    If both FeatureDataTypes and FeatureAttributeNames are provided, then the column keys should be a subset of the column names provided in FeatureAttributeNames.
    
    The key name FeatureAttributeNames is 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.
  - AlgorithmsConfig (list) –
    
    Stores the configuration information for the selection of algorithms used to train the model candidates.
    
    The list of available algorithms to choose from depends on the training mode set in AutoMLJobConfig.Mode.
    - AlgorithmsConfig should not be set in AUTO training mode.
    - When AlgorithmsConfig is provided, one AutoMLAlgorithms attribute must be set and one only. If the list of algorithms provided as values for AutoMLAlgorithms is empty, AutoMLCandidateGenerationConfig uses the full set of algorithms for the given training mode.
    - When AlgorithmsConfig is not provided, AutoMLCandidateGenerationConfig uses the full set of algorithms for the given training mode.
    For the list of all algorithms per 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) – [REQUIRED]
        
        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 ( ENSEMBLING or HYPERPARAMETER_TUNING). Choose a minimum of 1 algorithm.
        
        In ENSEMBLING mode:
        
        ”catboost”
        
        ”extra-trees”
        
        ”fastai”
        
        ”lightgbm”
        
        ”linear-learner”
        
        ”nn-torch”
        
        ”randomforest”
        
        ”xgboost”
        
        In HYPERPARAMETER_TUNING mode:
        
        ”linear-learner”
        
        ”mlp”
        
        ”xgboost”
        
        (string) –
- 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. In AUTO mode, Autopilot chooses ENSEMBLING for datasets smaller than 100 MB, and HYPERPARAMETER_TUNING for larger ones.
  
  The ENSEMBLING mode 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 by ENSEMBLING mode.
  
  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 by HYPERPARAMETER_TUNING mode.
RoleArn (string) –
[REQUIRED]

The ARN of the role that is used to access the data.
GenerateCandidateDefinitionsOnly (boolean) – Generates possible candidates without training the models. A candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.
Tags (list) –
An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web ServicesResources. Tag keys must be unique per resource.
- (dict) –
  
  A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.
  
  You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.
  
  For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.
  - Key (string) – [REQUIRED]
    
    The tag key. Tag keys must be unique per resource.
  - Value (string) – [REQUIRED]
    
    The tag value.
ModelDeployConfig (dict) –
Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.
- AutoGenerateEndpointName (boolean) –
  
  Set to True to automatically generate an endpoint name for a one-click Autopilot model deployment; set to False otherwise. The default value is False.
  
  Note
  
  If you set AutoGenerateEndpointName to True, do not specify the EndpointName; 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 EndpointName if and only if you set AutoGenerateEndpointName to False; otherwise a 400 error is thrown.

Return type:

dict

Returns:

Response Syntax

{
    'AutoMLJobArn': 'string'
}

Response Structure

(dict) –
- AutoMLJobArn (string) –
  
  The unique ARN assigned to the AutoML job when it is created.

Exceptions

SageMaker.Client.exceptions.ResourceInUse
SageMaker.Client.exceptions.ResourceLimitExceeded