SageMaker / Client / create_inference_recommendations_job

create_inference_recommendations_job#

SageMaker.Client.create_inference_recommendations_job(**kwargs)#

Starts a recommendation job. You can create either an instance recommendation or load test job.

Request Syntax

response = client.create_inference_recommendations_job(
    JobName='string',
    JobType='Default'|'Advanced',
    RoleArn='string',
    InputConfig={
        'ModelPackageVersionArn': 'string',
        'JobDurationInSeconds': 123,
        'TrafficPattern': {
            'TrafficType': 'PHASES'|'STAIRS',
            'Phases': [
                {
                    'InitialNumberOfUsers': 123,
                    'SpawnRate': 123,
                    'DurationInSeconds': 123
                },
            ],
            'Stairs': {
                'DurationInSeconds': 123,
                'NumberOfSteps': 123,
                'UsersPerStep': 123
            }
        },
        'ResourceLimit': {
            'MaxNumberOfTests': 123,
            'MaxParallelOfTests': 123
        },
        'EndpointConfigurations': [
            {
                'InstanceType': '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'|'ml.p5.48xlarge',
                'InferenceSpecificationName': 'string',
                'EnvironmentParameterRanges': {
                    'CategoricalParameterRanges': [
                        {
                            'Name': 'string',
                            'Value': [
                                'string',
                            ]
                        },
                    ]
                },
                'ServerlessConfig': {
                    'MemorySizeInMB': 123,
                    'MaxConcurrency': 123,
                    'ProvisionedConcurrency': 123
                }
            },
        ],
        'VolumeKmsKeyId': 'string',
        'ContainerConfig': {
            'Domain': 'string',
            'Task': 'string',
            'Framework': 'string',
            'FrameworkVersion': 'string',
            'PayloadConfig': {
                'SamplePayloadUrl': 'string',
                'SupportedContentTypes': [
                    'string',
                ]
            },
            'NearestModelName': 'string',
            'SupportedInstanceTypes': [
                'string',
            ],
            'DataInputConfig': 'string',
            'SupportedEndpointType': 'RealTime'|'Serverless',
            'SupportedResponseMIMETypes': [
                'string',
            ]
        },
        'Endpoints': [
            {
                'EndpointName': 'string'
            },
        ],
        'VpcConfig': {
            'SecurityGroupIds': [
                'string',
            ],
            'Subnets': [
                'string',
            ]
        },
        'ModelName': 'string'
    },
    JobDescription='string',
    StoppingConditions={
        'MaxInvocations': 123,
        'ModelLatencyThresholds': [
            {
                'Percentile': 'string',
                'ValueInMilliseconds': 123
            },
        ],
        'FlatInvocations': 'Continue'|'Stop'
    },
    OutputConfig={
        'KmsKeyId': 'string',
        'CompiledOutputConfig': {
            'S3OutputUri': 'string'
        }
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

JobName (string) –
[REQUIRED]

A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account. The job name is passed down to the resources created by the recommendation job. The names of resources (such as the model, endpoint configuration, endpoint, and compilation) that are prefixed with the job name are truncated at 40 characters.
JobType (string) –
[REQUIRED]

Defines the type of recommendation job. Specify Default to initiate an instance recommendation and Advanced to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation ( DEFAULT) job.
RoleArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
InputConfig (dict) –
[REQUIRED]

Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.
- ModelPackageVersionArn (string) –
  
  The Amazon Resource Name (ARN) of a versioned model package.
- JobDurationInSeconds (integer) –
  
  Specifies the maximum duration of the job, in seconds. The maximum value is 18,000 seconds.
- TrafficPattern (dict) –
  
  Specifies the traffic pattern of the job.
  - TrafficType (string) –
    
    Defines the traffic patterns. Choose either PHASES or STAIRS.
  - Phases (list) –
    
    Defines the phases traffic specification.
    - (dict) –
      
      Defines the traffic pattern.
      - InitialNumberOfUsers (integer) –
        
        Specifies how many concurrent users to start with. The value should be between 1 and 3.
      - SpawnRate (integer) –
        
        Specified how many new users to spawn in a minute.
      - DurationInSeconds (integer) –
        
        Specifies how long a traffic phase should be. For custom load tests, the value should be between 120 and 3600. This value should not exceed JobDurationInSeconds.
  - Stairs (dict) –
    
    Defines the stairs traffic pattern.
    - DurationInSeconds (integer) –
      
      Defines how long each traffic step should be.
    - NumberOfSteps (integer) –
      
      Specifies how many steps to perform during traffic.
    - UsersPerStep (integer) –
      
      Specifies how many new users to spawn in each step.
- ResourceLimit (dict) –
  
  Defines the resource limit of the job.
  - MaxNumberOfTests (integer) –
    
    Defines the maximum number of load tests.
  - MaxParallelOfTests (integer) –
    
    Defines the maximum number of parallel load tests.
- EndpointConfigurations (list) –
  
  Specifies the endpoint configuration to use for a job.
  - (dict) –
    
    The endpoint configuration for the load test.
    - InstanceType (string) –
      
      The instance types to use for the load test.
    - InferenceSpecificationName (string) –
      
      The inference specification name in the model package version.
    - EnvironmentParameterRanges (dict) –
      
      The parameter you want to benchmark against.
      - CategoricalParameterRanges (list) –
        
        Specified a list of parameters for each category.
        
        (dict) –
        
        Environment parameters you want to benchmark your load test against.
        
        Name (string) – [REQUIRED]
        
        The Name of the environment variable.
        
        Value (list) – [REQUIRED]
        
        The list of values you can pass.
        
        (string) –
    - ServerlessConfig (dict) –
      
      Specifies the serverless configuration for an endpoint variant.
      - MemorySizeInMB (integer) – [REQUIRED]
        
        The memory size of your serverless endpoint. Valid values are in 1 GB increments: 1024 MB, 2048 MB, 3072 MB, 4096 MB, 5120 MB, or 6144 MB.
      - MaxConcurrency (integer) – [REQUIRED]
        
        The maximum number of concurrent invocations your serverless endpoint can process.
      - ProvisionedConcurrency (integer) –
        
        The amount of provisioned concurrency to allocate for the serverless endpoint. Should be less than or equal to MaxConcurrency.
        
        Note
        This field is not supported for serverless endpoint recommendations for Inference Recommender jobs. For more information about creating an Inference Recommender job, see CreateInferenceRecommendationsJobs.
- VolumeKmsKeyId (string) –
  
  The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. This key will be passed to SageMaker Hosting for endpoint creation.
  
  The SageMaker execution role must have kms:CreateGrant permission in order to encrypt data on the storage volume of the endpoints created for inference recommendation. The inference recommendation job will fail asynchronously during endpoint configuration creation if the role passed does not have kms:CreateGrant permission.
  
  The KmsKeyId can be any of the following formats:
  - // KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab"
  - // Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"
  - // KMS Key Alias "alias/ExampleAlias"
  - // Amazon Resource Name (ARN) of a KMS Key Alias "arn:aws:kms:<region>:<account>:alias/<ExampleAlias>"
  For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.
- ContainerConfig (dict) –
  
  Specifies mandatory fields for running an Inference Recommender job. The fields specified in ContainerConfig override the corresponding fields in the model package.
  - Domain (string) –
    
    The machine learning domain of the model and its components.
    
    Valid Values: COMPUTER_VISION | NATURAL_LANGUAGE_PROCESSING | MACHINE_LEARNING
  - Task (string) –
    
    The machine learning task that the model accomplishes.
    
    Valid Values: IMAGE_CLASSIFICATION | OBJECT_DETECTION | TEXT_GENERATION | IMAGE_SEGMENTATION | FILL_MASK | CLASSIFICATION | REGRESSION | OTHER
  - Framework (string) –
    
    The machine learning framework of the container image.
    
    Valid Values: TENSORFLOW | PYTORCH | XGBOOST | SAGEMAKER-SCIKIT-LEARN
  - FrameworkVersion (string) –
    
    The framework version of the container image.
  - PayloadConfig (dict) –
    
    Specifies the SamplePayloadUrl and all other sample payload-related fields.
    - SamplePayloadUrl (string) –
      
      The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).
    - SupportedContentTypes (list) –
      
      The supported MIME types for the input data.
      - (string) –
  - NearestModelName (string) –
    
    The name of a pre-trained machine learning model benchmarked by Amazon SageMaker Inference Recommender that matches your model.
    
    Valid Values: efficientnetb7 | unet | xgboost | faster-rcnn-resnet101 | nasnetlarge | vgg16 | inception-v3 | mask-rcnn | sagemaker-scikit-learn | densenet201-gluon | resnet18v2-gluon | xception | densenet201 | yolov4 | resnet152 | bert-base-cased | xceptionV1-keras | resnet50 | retinanet
  - SupportedInstanceTypes (list) –
    
    A list of the instance types that are used to generate inferences in real-time.
    - (string) –
  - DataInputConfig (string) –
    
    Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. This field is used for optimizing your model using SageMaker Neo. For more information, see DataInputConfig.
  - SupportedEndpointType (string) –
    
    The endpoint type to receive recommendations for. By default this is null, and the results of the inference recommendation job return a combined list of both real-time and serverless benchmarks. By specifying a value for this field, you can receive a longer list of benchmarks for the desired endpoint type.
  - SupportedResponseMIMETypes (list) –
    
    The supported MIME types for the output data.
    - (string) –
- Endpoints (list) –
  
  Existing customer endpoints on which to run an Inference Recommender job.
  - (dict) –
    
    Details about a customer endpoint that was compared in an Inference Recommender job.
    - EndpointName (string) – [REQUIRED]
      
      The name of a customer’s endpoint.
- VpcConfig (dict) –
  
  Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.
  - SecurityGroupIds (list) – [REQUIRED]
    
    The VPC security group IDs. IDs have the form of 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 model.
    - (string) –
- ModelName (string) –
  
  The name of the created model.
JobDescription (string) – Description of the recommendation job.
StoppingConditions (dict) –
A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.
- MaxInvocations (integer) –
  
  The maximum number of requests per minute expected for the endpoint.
- ModelLatencyThresholds (list) –
  
  The interval of time taken by a model to respond as viewed from SageMaker. The interval includes the local communication time taken to send the request and to fetch the response from the container of a model and the time taken to complete the inference in the container.
  - (dict) –
    
    The model latency threshold.
    - Percentile (string) –
      
      The model latency percentile threshold. Acceptable values are P95 and P99. For custom load tests, specify the value as P95.
    - ValueInMilliseconds (integer) –
      
      The model latency percentile value in milliseconds.
- FlatInvocations (string) –
  
  Stops a load test when the number of invocations (TPS) peaks and flattens, which means that the instance has reached capacity. The default value is Stop. If you want the load test to continue after invocations have flattened, set the value to Continue.
OutputConfig (dict) –
Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.
- KmsKeyId (string) –
  
  The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have kms:GenerateDataKey permission.
  
  The KmsKeyId can be any of the following formats:
  - // KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab"
  - // Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"
  - // KMS Key Alias "alias/ExampleAlias"
  - // Amazon Resource Name (ARN) of a KMS Key Alias "arn:aws:kms:<region>:<account>:alias/<ExampleAlias>"
  For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.
- CompiledOutputConfig (dict) –
  
  Provides information about the output configuration for the compiled model.
  - S3OutputUri (string) –
    
    Identifies the Amazon S3 bucket where you want SageMaker to store the compiled model artifacts.
Tags (list) –
The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
- (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.

Return type:

dict

Returns:

Response Syntax

{
    'JobArn': 'string'
}

Response Structure

(dict) –
- JobArn (string) –
  
  The Amazon Resource Name (ARN) of the recommendation job.

Exceptions

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