Class: Aws::SageMaker::Types::ModelPackageContainerDefinition

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

Note:

When making an API call, you may pass ModelPackageContainerDefinition data as a hash:

{
  container_hostname: "ContainerHostname",
  image: "ContainerImage", # required
  image_digest: "ImageDigest",
  model_data_url: "Url",
  product_id: "ProductId",
  environment: {
    "EnvironmentKey" => "EnvironmentValue",
  },
  model_input: {
    data_input_config: "DataInputConfig", # required
  },
  framework: "String",
  framework_version: "FrameworkVersion",
  nearest_model_name: "String",
}

Describes the Docker container for the model package.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#container_hostnameString

The DNS host name for the Docker container.

Returns:

  • (String)


29638
29639
29640
29641
29642
29643
29644
29645
29646
29647
29648
29649
29650
29651
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 29638

class ModelPackageContainerDefinition < Struct.new(
  :container_hostname,
  :image,
  :image_digest,
  :model_data_url,
  :product_id,
  :environment,
  :model_input,
  :framework,
  :framework_version,
  :nearest_model_name)
  SENSITIVE = []
  include Aws::Structure
end

#environmentHash<String,String>

The environment variables to set in the Docker container. Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map.

Returns:

  • (Hash<String,String>)


29638
29639
29640
29641
29642
29643
29644
29645
29646
29647
29648
29649
29650
29651
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 29638

class ModelPackageContainerDefinition < Struct.new(
  :container_hostname,
  :image,
  :image_digest,
  :model_data_url,
  :product_id,
  :environment,
  :model_input,
  :framework,
  :framework_version,
  :nearest_model_name)
  SENSITIVE = []
  include Aws::Structure
end

#frameworkString

The machine learning framework of the model package container image.

Returns:

  • (String)


29638
29639
29640
29641
29642
29643
29644
29645
29646
29647
29648
29649
29650
29651
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 29638

class ModelPackageContainerDefinition < Struct.new(
  :container_hostname,
  :image,
  :image_digest,
  :model_data_url,
  :product_id,
  :environment,
  :model_input,
  :framework,
  :framework_version,
  :nearest_model_name)
  SENSITIVE = []
  include Aws::Structure
end

#framework_versionString

The framework version of the Model Package Container Image.

Returns:

  • (String)


29638
29639
29640
29641
29642
29643
29644
29645
29646
29647
29648
29649
29650
29651
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 29638

class ModelPackageContainerDefinition < Struct.new(
  :container_hostname,
  :image,
  :image_digest,
  :model_data_url,
  :product_id,
  :environment,
  :model_input,
  :framework,
  :framework_version,
  :nearest_model_name)
  SENSITIVE = []
  include Aws::Structure
end

#imageString

The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.

If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

Returns:

  • (String)


29638
29639
29640
29641
29642
29643
29644
29645
29646
29647
29648
29649
29650
29651
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 29638

class ModelPackageContainerDefinition < Struct.new(
  :container_hostname,
  :image,
  :image_digest,
  :model_data_url,
  :product_id,
  :environment,
  :model_input,
  :framework,
  :framework_version,
  :nearest_model_name)
  SENSITIVE = []
  include Aws::Structure
end

#image_digestString

An MD5 hash of the training algorithm that identifies the Docker image used for training.

Returns:

  • (String)


29638
29639
29640
29641
29642
29643
29644
29645
29646
29647
29648
29649
29650
29651
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 29638

class ModelPackageContainerDefinition < Struct.new(
  :container_hostname,
  :image,
  :image_digest,
  :model_data_url,
  :product_id,
  :environment,
  :model_input,
  :framework,
  :framework_version,
  :nearest_model_name)
  SENSITIVE = []
  include Aws::Structure
end

#model_data_urlString

The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

The model artifacts must be in an S3 bucket that is in the same region as the model package.

Returns:

  • (String)


29638
29639
29640
29641
29642
29643
29644
29645
29646
29647
29648
29649
29650
29651
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 29638

class ModelPackageContainerDefinition < Struct.new(
  :container_hostname,
  :image,
  :image_digest,
  :model_data_url,
  :product_id,
  :environment,
  :model_input,
  :framework,
  :framework_version,
  :nearest_model_name)
  SENSITIVE = []
  include Aws::Structure
end

#model_inputTypes::ModelInput

A structure with Model Input details.

Returns:



29638
29639
29640
29641
29642
29643
29644
29645
29646
29647
29648
29649
29650
29651
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 29638

class ModelPackageContainerDefinition < Struct.new(
  :container_hostname,
  :image,
  :image_digest,
  :model_data_url,
  :product_id,
  :environment,
  :model_input,
  :framework,
  :framework_version,
  :nearest_model_name)
  SENSITIVE = []
  include Aws::Structure
end

#nearest_model_nameString

The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model. You can find a list of benchmarked models by calling ListModelMetadata.

Returns:

  • (String)


29638
29639
29640
29641
29642
29643
29644
29645
29646
29647
29648
29649
29650
29651
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 29638

class ModelPackageContainerDefinition < Struct.new(
  :container_hostname,
  :image,
  :image_digest,
  :model_data_url,
  :product_id,
  :environment,
  :model_input,
  :framework,
  :framework_version,
  :nearest_model_name)
  SENSITIVE = []
  include Aws::Structure
end

#product_idString

The Amazon Web Services Marketplace product ID of the model package.

Returns:

  • (String)


29638
29639
29640
29641
29642
29643
29644
29645
29646
29647
29648
29649
29650
29651
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 29638

class ModelPackageContainerDefinition < Struct.new(
  :container_hostname,
  :image,
  :image_digest,
  :model_data_url,
  :product_id,
  :environment,
  :model_input,
  :framework,
  :framework_version,
  :nearest_model_name)
  SENSITIVE = []
  include Aws::Structure
end