Create Model

sagemaker_create_model

R Documentation

Creates a model in SageMaker

Description

Creates a model in SageMaker. In the request, you name the model and describe a primary container. For the primary container, you specify the Docker image that contains inference code, artifacts (from prior training), and a custom environment map that the inference code uses when you deploy the model for predictions.

Use this API to create a model if you want to use SageMaker hosting services or run a batch transform job.

To host your model, you create an endpoint configuration with the create_endpoint_config API, and then create an endpoint with the create_endpoint API. SageMaker then deploys all of the containers that you defined for the model in the hosting environment.

To run a batch transform using your model, you start a job with the create_transform_job API. SageMaker uses your model and your dataset to get inferences which are then saved to a specified S3 location.

In the request, you also provide an IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute hosting instances or for batch transform jobs. In addition, you also use the IAM role to manage permissions the inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role.

Usage

sagemaker_create_model(ModelName, PrimaryContainer, Containers,
  InferenceExecutionConfig, ExecutionRoleArn, Tags, VpcConfig,
  EnableNetworkIsolation)

Arguments

ModelName

[required] The name of the new model.

PrimaryContainer

The location of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions.

Containers

Specifies the containers in the inference pipeline.

InferenceExecutionConfig

Specifies details of how containers in a multi-container endpoint are called.

ExecutionRoleArn

The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute instances or for batch transform jobs. Deploying on ML compute instances is part of model hosting. For more information, see SageMaker Roles.

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

Tags

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 Services Resources.

VpcConfig

A VpcConfig object that specifies the VPC that you want your model to connect to. Control access to and from your model container by configuring the VPC. VpcConfig is used in hosting services and in batch transform. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud.

EnableNetworkIsolation

Isolates the model container. No inbound or outbound network calls can be made to or from the model container.

Value

A list with the following syntax:

list(
  ModelArn = "string"
)

Request syntax

svc$create_model(
  ModelName = "string",
  PrimaryContainer = list(
    ContainerHostname = "string",
    Image = "string",
    ImageConfig = list(
      RepositoryAccessMode = "Platform"|"Vpc",
      RepositoryAuthConfig = list(
        RepositoryCredentialsProviderArn = "string"
      )
    ),
    Mode = "SingleModel"|"MultiModel",
    ModelDataUrl = "string",
    ModelDataSource = list(
      S3DataSource = list(
        S3Uri = "string",
        S3DataType = "S3Prefix"|"S3Object",
        CompressionType = "None"|"Gzip",
        ModelAccessConfig = list(
          AcceptEula = TRUE|FALSE
        ),
        HubAccessConfig = list(
          HubContentArn = "string"
        )
      )
    ),
    AdditionalModelDataSources = list(
      list(
        ChannelName = "string",
        S3DataSource = list(
          S3Uri = "string",
          S3DataType = "S3Prefix"|"S3Object",
          CompressionType = "None"|"Gzip",
          ModelAccessConfig = list(
            AcceptEula = TRUE|FALSE
          ),
          HubAccessConfig = list(
            HubContentArn = "string"
          )
        )
      )
    ),
    Environment = list(
      "string"
    ),
    ModelPackageName = "string",
    InferenceSpecificationName = "string",
    MultiModelConfig = list(
      ModelCacheSetting = "Enabled"|"Disabled"
    )
  ),
  Containers = list(
    list(
      ContainerHostname = "string",
      Image = "string",
      ImageConfig = list(
        RepositoryAccessMode = "Platform"|"Vpc",
        RepositoryAuthConfig = list(
          RepositoryCredentialsProviderArn = "string"
        )
      ),
      Mode = "SingleModel"|"MultiModel",
      ModelDataUrl = "string",
      ModelDataSource = list(
        S3DataSource = list(
          S3Uri = "string",
          S3DataType = "S3Prefix"|"S3Object",
          CompressionType = "None"|"Gzip",
          ModelAccessConfig = list(
            AcceptEula = TRUE|FALSE
          ),
          HubAccessConfig = list(
            HubContentArn = "string"
          )
        )
      ),
      AdditionalModelDataSources = list(
        list(
          ChannelName = "string",
          S3DataSource = list(
            S3Uri = "string",
            S3DataType = "S3Prefix"|"S3Object",
            CompressionType = "None"|"Gzip",
            ModelAccessConfig = list(
              AcceptEula = TRUE|FALSE
            ),
            HubAccessConfig = list(
              HubContentArn = "string"
            )
          )
        )
      ),
      Environment = list(
        "string"
      ),
      ModelPackageName = "string",
      InferenceSpecificationName = "string",
      MultiModelConfig = list(
        ModelCacheSetting = "Enabled"|"Disabled"
      )
    )
  ),
  InferenceExecutionConfig = list(
    Mode = "Serial"|"Direct"
  ),
  ExecutionRoleArn = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  VpcConfig = list(
    SecurityGroupIds = list(
      "string"
    ),
    Subnets = list(
      "string"
    )
  ),
  EnableNetworkIsolation = TRUE|FALSE
)