SageMaker

Introduction

Amazon SageMaker is a fully managed service provided by Amazon Web Services (AWS) that provides the tools to build, train, and deploy machine-learning models in the cloud for predictive analytics applications. It streamlines the machine learning development process, reduces the time and effort required to build and deploy models, and offers the scalability and flexibility needed for large-scale machine learning projects in the AWS cloud.

LocalStack provides a local version of the SageMaker API, which allows running jobs to create machine learning models (e.g., using PyTorch) and to deploy them. The supported APIs are available on our API Coverage section, which provides information on the extent of Sagemaker’s integration with LocalStack.

Getting started

This guide is designed for users new to SageMaker and assumes basic knowledge of Python3 and AWS SDK for Python (Boto3).

We will demonstrate an application illustrating running a machine learning job using the SageMaker API locally that perform the following:

Set up an MNIST model in SageMaker using LocalStack.
Creates a SageMaker Endpoint for accessing the model
Invokes the endpoint directly on the container via Boto3

Download the sample application

You can download the sample application from GitHub or by running the following commands:

mkdir localstack-samples && cd localstack-samples
git init
git remote add origin -f git@github.com:localstack/localstack-pro-samples.git
git config core.sparseCheckout true
echo sagemaker-inference >> .git/info/sparse-checkout
git pull origin master

Set up the environment

After downloading the sample application, you can set up your Docker Client to pull the AWS Deep Learning images by running the following command:

aws ecr get-login-password --region us-east-1 | docker login --username AWS --password-stdin 763104351884.dkr.ecr.us-east-1.amazonaws.com

Since the images are quite large (several gigabytes), it’s a good idea to pull the images using Docker in advance.

docker pull 763104351884.dkr.ecr.us-east-1.amazonaws.com/pytorch-inference:1.5.0-cpu-py3

Run the sample application

Start your LocalStack container using your preferred method. Run the sample application by executing the following command:

python3 main.py

Creating bucket...
Uploading model data to bucket...
Creating model in SageMaker...
Adding endpoint configuration...
Creating endpoint...
Checking endpoint status...
Endpoint not ready - waiting...
Checking endpoint status...
Endpoint ready!
Invoking via boto...
Predicted digits: [7, 3]
Invoking endpoint directly...
Predicted digits: [2, 6]

You can also invoke a serverless endpoint, by navigating to main.py and uncommenting the run_serverless function call.

Resource Browser

The LocalStack Web Application provides a Resource Browser for managing Sagemaker resources. You can access the Resource Browser by opening the LocalStack Web Application in your browser, navigating to the Resources section, and then clicking on Sagemaker under the Compute section.

The Resource Browser displays Models, Endpoint Configurations and Endpoint. You can click on individual resources to view their details.

Sagemaker Resource Browser

The Resource Browser allows you to perform the following actions:

Create and Remove Models: You can remove existing model and create a new model with the required configuration
Endpoint Configurations & Endpoints: You can create endpoints from the resource browser that hosts your deployed machine learning model. You can also create endpoint configuration that specifies the type and number of instances that will be used to serve your model on an endpoint.

Examples

The following code snippets and sample applications provide practical examples of how to use Sagemaker in LocalStack for various use cases:

MNIST handwritten digit recognition model demonstrates a web application that allows users to draw a digit and submit it to a locally running SageMaker endpoint.

Limitations

Currently, GPU models are not supported by the LocalStack SageMaker implementation.

API Coverage

119 of 404 operations implemented

Available from the Ultimate plan. Licensing details

Find an API

Search the full operation list, then sort the table to compare current support.

Loading operations…

Search by operation name

		Verified on Kubernetes
Loading operations…

Complete static API list All 404 operations and their current support status

Operation	Status
AddAssociation	Not implemented
AddTags	Implemented
AssociateTrialComponent	Implemented
AttachClusterNodeNetworkInterface	Not implemented
AttachClusterNodeVolume	Not implemented
BatchAddClusterNodes	Not implemented
BatchDeleteClusterNodes	Not implemented
BatchDescribeModelPackage	Not implemented
BatchRebootClusterNodes	Not implemented
BatchReplaceClusterNodes	Not implemented
CreateAIBenchmarkJob	Not implemented
CreateAIRecommendationJob	Not implemented
CreateAIWorkloadConfig	Not implemented
CreateAction	Not implemented
CreateAlgorithm	Not implemented
CreateApp	Not implemented
CreateAppImageConfig	Not implemented
CreateArtifact	Not implemented
CreateAutoMLJob	Not implemented
CreateAutoMLJobV2	Implemented
CreateCluster	Implemented
CreateClusterSchedulerConfig	Not implemented
CreateCodeRepository	Not implemented
CreateCompilationJob	Implemented
CreateComputeQuota	Not implemented
CreateContext	Not implemented
CreateDataQualityJobDefinition	Implemented
CreateDeviceFleet	Not implemented
CreateDomain	Implemented
CreateEdgeDeploymentPlan	Not implemented
CreateEdgeDeploymentStage	Not implemented
CreateEdgePackagingJob	Not implemented
CreateEndpoint	Implemented
CreateEndpointConfig	Implemented
CreateExperiment	Implemented
CreateFeatureGroup	Implemented
CreateFlowDefinition	Not implemented
CreateHub	Not implemented
CreateHubContentPresignedUrls	Not implemented
CreateHubContentReference	Not implemented
CreateHumanTaskUi	Not implemented
CreateHyperParameterTuningJob	Implemented
CreateImage	Not implemented
CreateImageVersion	Not implemented
CreateInferenceComponent	Not implemented
CreateInferenceExperiment	Not implemented
CreateInferenceRecommendationsJob	Not implemented
CreateJob	Not implemented
CreateLabelingJob	Not implemented
CreateMlflowApp	Not implemented
CreateMlflowTrackingServer	Not implemented
CreateModel	Implemented
CreateModelBiasJobDefinition	Implemented
CreateModelCard	Implemented
CreateModelCardExportJob	Not implemented
CreateModelExplainabilityJobDefinition	Implemented
CreateModelPackage	Implemented
CreateModelPackageGroup	Implemented
CreateModelQualityJobDefinition	Implemented
CreateMonitoringSchedule	Not implemented
CreateNotebookInstance	Implemented
CreateNotebookInstanceLifecycleConfig	Implemented
CreateOptimizationJob	Not implemented
CreatePartnerApp	Not implemented
CreatePartnerAppPresignedUrl	Not implemented
CreatePipeline	Implemented
CreatePresignedDomainUrl	Not implemented
CreatePresignedMlflowAppUrl	Not implemented
CreatePresignedMlflowTrackingServerUrl	Not implemented
CreatePresignedNotebookInstanceUrl	Not implemented
CreateProcessingJob	Implemented
CreateProject	Not implemented
CreateSpace	Not implemented
CreateStudioLifecycleConfig	Not implemented
CreateTrainingJob	Implemented
CreateTrainingPlan	Not implemented
CreateTransformJob	Implemented
CreateTrial	Implemented
CreateTrialComponent	Implemented
CreateUserProfile	Implemented
CreateWorkforce	Not implemented
CreateWorkteam	Not implemented
DeleteAIBenchmarkJob	Not implemented
DeleteAIRecommendationJob	Not implemented
DeleteAIWorkloadConfig	Not implemented
DeleteAction	Not implemented
DeleteAlgorithm	Not implemented
DeleteApp	Not implemented
DeleteAppImageConfig	Not implemented
DeleteArtifact	Not implemented
DeleteAssociation	Not implemented
DeleteCluster	Implemented
DeleteClusterSchedulerConfig	Not implemented
DeleteCodeRepository	Not implemented
DeleteCompilationJob	Implemented
DeleteComputeQuota	Not implemented
DeleteContext	Not implemented
DeleteDataQualityJobDefinition	Implemented
DeleteDeviceFleet	Not implemented
DeleteDomain	Implemented
DeleteEdgeDeploymentPlan	Not implemented
DeleteEdgeDeploymentStage	Not implemented
DeleteEndpoint	Implemented
DeleteEndpointConfig	Implemented
DeleteExperiment	Implemented
DeleteFeatureGroup	Not implemented
DeleteFlowDefinition	Not implemented
DeleteHub	Not implemented
DeleteHubContent	Not implemented
DeleteHubContentReference	Not implemented
DeleteHumanTaskUi	Not implemented
DeleteHyperParameterTuningJob	Implemented
DeleteImage	Not implemented
DeleteImageVersion	Not implemented
DeleteInferenceComponent	Not implemented
DeleteInferenceExperiment	Not implemented
DeleteJob	Not implemented
DeleteMlflowApp	Not implemented
DeleteMlflowTrackingServer	Not implemented
DeleteModel	Implemented
DeleteModelBiasJobDefinition	Implemented
DeleteModelCard	Implemented
DeleteModelExplainabilityJobDefinition	Implemented
DeleteModelPackage	Not implemented
DeleteModelPackageGroup	Not implemented
DeleteModelPackageGroupPolicy	Not implemented
DeleteModelQualityJobDefinition	Implemented
DeleteMonitoringSchedule	Not implemented
DeleteNotebookInstance	Implemented
DeleteNotebookInstanceLifecycleConfig	Implemented
DeleteOptimizationJob	Not implemented
DeletePartnerApp	Not implemented
DeletePipeline	Implemented
DeleteProcessingJob	Not implemented
DeleteProject	Not implemented
DeleteSpace	Not implemented
DeleteStudioLifecycleConfig	Not implemented
DeleteTags	Implemented
DeleteTrainingJob	Not implemented
DeleteTrial	Implemented
DeleteTrialComponent	Implemented
DeleteUserProfile	Implemented
DeleteWorkforce	Not implemented
DeleteWorkteam	Not implemented
DeregisterDevices	Not implemented
DescribeAIBenchmarkJob	Not implemented
DescribeAIRecommendationJob	Not implemented
DescribeAIWorkloadConfig	Not implemented
DescribeAction	Not implemented
DescribeAlgorithm	Not implemented
DescribeApp	Not implemented
DescribeAppImageConfig	Not implemented
DescribeArtifact	Not implemented
DescribeAutoMLJob	Not implemented
DescribeAutoMLJobV2	Implemented
DescribeCluster	Implemented
DescribeClusterEvent	Not implemented
DescribeClusterNode	Implemented
DescribeClusterSchedulerConfig	Not implemented
DescribeCodeRepository	Not implemented
DescribeCompilationJob	Implemented
DescribeComputeQuota	Not implemented
DescribeContext	Not implemented
DescribeDataQualityJobDefinition	Implemented
DescribeDevice	Not implemented
DescribeDeviceFleet	Not implemented
DescribeDomain	Implemented
DescribeEdgeDeploymentPlan	Not implemented
DescribeEdgePackagingJob	Not implemented
DescribeEndpoint	Implemented
DescribeEndpointConfig	Implemented
DescribeExperiment	Implemented
DescribeFeatureGroup	Implemented
DescribeFeatureMetadata	Not implemented
DescribeFlowDefinition	Not implemented
DescribeHub	Not implemented
DescribeHubContent	Not implemented
DescribeHumanTaskUi	Not implemented
DescribeHyperParameterTuningJob	Implemented
DescribeImage	Not implemented
DescribeImageVersion	Not implemented
DescribeInferenceComponent	Not implemented
DescribeInferenceExperiment	Not implemented
DescribeInferenceRecommendationsJob	Not implemented
DescribeJob	Not implemented
DescribeJobSchemaVersion	Not implemented
DescribeLabelingJob	Not implemented
DescribeLineageGroup	Not implemented
DescribeMlflowApp	Not implemented
DescribeMlflowTrackingServer	Not implemented
DescribeModel	Implemented
DescribeModelBiasJobDefinition	Implemented
DescribeModelCard	Implemented
DescribeModelCardExportJob	Not implemented
DescribeModelExplainabilityJobDefinition	Implemented
DescribeModelPackage	Implemented
DescribeModelPackageGroup	Implemented
DescribeModelQualityJobDefinition	Implemented
DescribeMonitoringSchedule	Not implemented
DescribeNotebookInstance	Implemented
DescribeNotebookInstanceLifecycleConfig	Implemented
DescribeOptimizationJob	Not implemented
DescribePartnerApp	Not implemented
DescribePipeline	Implemented
DescribePipelineDefinitionForExecution	Implemented
DescribePipelineExecution	Implemented
DescribeProcessingJob	Implemented
DescribeProject	Not implemented
DescribeReservedCapacity	Not implemented
DescribeSpace	Not implemented
DescribeStudioLifecycleConfig	Not implemented
DescribeSubscribedWorkteam	Not implemented
DescribeTrainingJob	Implemented
DescribeTrainingPlan	Not implemented
DescribeTrainingPlanExtensionHistory	Not implemented
DescribeTransformJob	Implemented
DescribeTrial	Implemented
DescribeTrialComponent	Implemented
DescribeUserProfile	Implemented
DescribeWorkforce	Not implemented
DescribeWorkteam	Not implemented
DetachClusterNodeVolume	Not implemented
DisableSagemakerServicecatalogPortfolio	Not implemented
DisassociateTrialComponent	Implemented
EnableSagemakerServicecatalogPortfolio	Not implemented
ExtendTrainingPlan	Not implemented
GetDeviceFleetReport	Not implemented
GetLineageGroupPolicy	Not implemented
GetModelPackageGroupPolicy	Not implemented
GetSagemakerServicecatalogPortfolioStatus	Not implemented
GetScalingConfigurationRecommendation	Not implemented
GetSearchSuggestions	Not implemented
ImportHubContent	Not implemented
ListAIBenchmarkJobs	Not implemented
ListAIRecommendationJobs	Not implemented
ListAIWorkloadConfigs	Not implemented
ListActions	Not implemented
ListAlgorithms	Not implemented
ListAliases	Not implemented
ListAppImageConfigs	Not implemented
ListApps	Not implemented
ListArtifacts	Not implemented
ListAssociations	Not implemented
ListAutoMLJobs	Implemented
ListCandidatesForAutoMLJob	Not implemented
ListClusterEvents	Not implemented
ListClusterNodes	Implemented
ListClusterSchedulerConfigs	Not implemented
ListClusters	Implemented
ListCodeRepositories	Not implemented
ListCompilationJobs	Implemented
ListComputeQuotas	Not implemented
ListContexts	Not implemented
ListDataQualityJobDefinitions	Implemented
ListDeviceFleets	Not implemented
ListDevices	Not implemented
ListDomains	Implemented
ListEdgeDeploymentPlans	Not implemented
ListEdgePackagingJobs	Not implemented
ListEndpointConfigs	Implemented
ListEndpoints	Implemented
ListExperiments	Implemented
ListFeatureGroups	Not implemented
ListFlowDefinitions	Not implemented
ListHubContentVersions	Not implemented
ListHubContents	Not implemented
ListHubs	Not implemented
ListHumanTaskUis	Not implemented
ListHyperParameterTuningJobs	Implemented
ListImageVersions	Not implemented
ListImages	Not implemented
ListInferenceComponents	Not implemented
ListInferenceExperiments	Not implemented
ListInferenceRecommendationsJobSteps	Not implemented
ListInferenceRecommendationsJobs	Not implemented
ListJobSchemaVersions	Not implemented
ListJobs	Not implemented
ListLabelingJobs	Not implemented
ListLabelingJobsForWorkteam	Not implemented
ListLineageGroups	Not implemented
ListMlflowApps	Not implemented
ListMlflowTrackingServers	Not implemented
ListModelBiasJobDefinitions	Implemented
ListModelCardExportJobs	Not implemented
ListModelCardVersions	Implemented
ListModelCards	Implemented
ListModelExplainabilityJobDefinitions	Implemented
ListModelMetadata	Not implemented
ListModelPackageGroups	Implemented
ListModelPackages	Implemented
ListModelQualityJobDefinitions	Implemented
ListModels	Implemented
ListMonitoringAlertHistory	Not implemented
ListMonitoringAlerts	Not implemented
ListMonitoringExecutions	Not implemented
ListMonitoringSchedules	Not implemented
ListNotebookInstanceLifecycleConfigs	Not implemented
ListNotebookInstances	Implemented
ListOptimizationJobs	Not implemented
ListPartnerApps	Not implemented
ListPipelineExecutionSteps	Not implemented
ListPipelineExecutions	Implemented
ListPipelineParametersForExecution	Implemented
ListPipelineVersions	Not implemented
ListPipelines	Implemented
ListProcessingJobs	Implemented
ListProjects	Not implemented
ListResourceCatalogs	Not implemented
ListSpaces	Not implemented
ListStageDevices	Not implemented
ListStudioLifecycleConfigs	Not implemented
ListSubscribedWorkteams	Not implemented
ListTags	Implemented
ListTrainingJobs	Implemented
ListTrainingJobsForHyperParameterTuningJob	Not implemented
ListTrainingPlans	Not implemented
ListTransformJobs	Implemented
ListTrialComponents	Implemented
ListTrials	Implemented
ListUltraServersByReservedCapacity	Not implemented
ListUserProfiles	Implemented
ListWorkforces	Not implemented
ListWorkteams	Not implemented
PutModelPackageGroupPolicy	Not implemented
QueryLineage	Not implemented
RegisterDevices	Not implemented
RenderUiTemplate	Not implemented
RetryPipelineExecution	Not implemented
Search	Implemented
SearchTrainingPlanOfferings	Not implemented
SendPipelineExecutionStepFailure	Not implemented
SendPipelineExecutionStepSuccess	Not implemented
StartClusterHealthCheck	Not implemented
StartEdgeDeploymentStage	Not implemented
StartInferenceExperiment	Not implemented
StartMlflowTrackingServer	Not implemented
StartMonitoringSchedule	Not implemented
StartNotebookInstance	Implemented
StartPipelineExecution	Implemented
StartSession	Not implemented
StopAIBenchmarkJob	Not implemented
StopAIRecommendationJob	Not implemented
StopAutoMLJob	Implemented
StopCompilationJob	Not implemented
StopEdgeDeploymentStage	Not implemented
StopEdgePackagingJob	Not implemented
StopHyperParameterTuningJob	Not implemented
StopInferenceExperiment	Not implemented
StopInferenceRecommendationsJob	Not implemented
StopJob	Not implemented
StopLabelingJob	Not implemented
StopMlflowTrackingServer	Not implemented
StopMonitoringSchedule	Not implemented
StopNotebookInstance	Implemented
StopOptimizationJob	Not implemented
StopPipelineExecution	Not implemented
StopProcessingJob	Not implemented
StopTrainingJob	Not implemented
StopTransformJob	Not implemented
UpdateAction	Not implemented
UpdateAppImageConfig	Not implemented
UpdateArtifact	Not implemented
UpdateCluster	Not implemented
UpdateClusterSchedulerConfig	Not implemented
UpdateClusterSoftware	Not implemented
UpdateCodeRepository	Not implemented
UpdateComputeQuota	Not implemented
UpdateContext	Not implemented
UpdateDeviceFleet	Not implemented
UpdateDevices	Not implemented
UpdateDomain	Implemented
UpdateEndpoint	Not implemented
UpdateEndpointWeightsAndCapacities	Implemented
UpdateExperiment	Not implemented
UpdateFeatureGroup	Not implemented
UpdateFeatureMetadata	Not implemented
UpdateHub	Not implemented
UpdateHubContent	Not implemented
UpdateHubContentReference	Not implemented
UpdateImage	Not implemented
UpdateImageVersion	Not implemented
UpdateInferenceComponent	Not implemented
UpdateInferenceComponentRuntimeConfig	Not implemented
UpdateInferenceExperiment	Not implemented
UpdateMlflowApp	Not implemented
UpdateMlflowTrackingServer	Not implemented
UpdateModelCard	Implemented
UpdateModelPackage	Implemented
UpdateMonitoringAlert	Not implemented
UpdateMonitoringSchedule	Not implemented
UpdateNotebookInstance	Not implemented
UpdateNotebookInstanceLifecycleConfig	Not implemented
UpdatePartnerApp	Not implemented
UpdatePipeline	Implemented
UpdatePipelineExecution	Not implemented
UpdatePipelineVersion	Not implemented
UpdateProject	Not implemented
UpdateSpace	Not implemented
UpdateTrainingJob	Not implemented
UpdateTrial	Not implemented
UpdateTrialComponent	Implemented
UpdateUserProfile	Implemented
UpdateWorkforce	Not implemented
UpdateWorkteam	Not implemented

1 of 3 operations implemented