Class: Aws::SageMaker::Types::ProductionVariant

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::ProductionVariant

Defined in:

gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

Note:

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

{
  variant_name: "VariantName", # required
  model_name: "ModelName", # required
  initial_instance_count: 1,
  instance_type: "ml.t2.medium", # accepts 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
  initial_variant_weight: 1.0,
  accelerator_type: "ml.eia1.medium", # accepts ml.eia1.medium, ml.eia1.large, ml.eia1.xlarge, ml.eia2.medium, ml.eia2.large, ml.eia2.xlarge
  core_dump_config: {
    destination_s3_uri: "DestinationS3Uri", # required
    kms_key_id: "KmsKeyId",
  },
  serverless_config: {
    memory_size_in_mb: 1, # required
    max_concurrency: 1, # required
  },
  volume_size_in_gb: 1,
  model_data_download_timeout_in_seconds: 1,
  container_startup_health_check_timeout_in_seconds: 1,
}

Identifies a model that you want to host and the resources chosen to deploy for hosting it. If you are deploying multiple models, tell SageMaker how to distribute traffic among the models by specifying variant weights.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #accelerator_type ⇒ String

  The size of the Elastic Inference (EI) instance to use for the production variant.

• #container_startup_health_check_timeout_in_seconds ⇒ Integer

  The timeout value, in seconds, for your inference container to pass health check by SageMaker Hosting.

• #core_dump_config ⇒ Types::ProductionVariantCoreDumpConfig

  Specifies configuration for a core dump from the model container when the process crashes.

• #initial_instance_count ⇒ Integer

  Number of instances to launch initially.

• #initial_variant_weight ⇒ Float

  Determines initial traffic distribution among all of the models that you specify in the endpoint configuration.

• #instance_type ⇒ String

  The ML compute instance type.

• #model_data_download_timeout_in_seconds ⇒ Integer

  The timeout value, in seconds, to download and extract the model that you want to host from Amazon S3 to the individual inference instance associated with this production variant.

• #model_name ⇒ String

  The name of the model that you want to host.

• #serverless_config ⇒ Types::ProductionVariantServerlessConfig

  The serverless configuration for an endpoint.

• #variant_name ⇒ String

  The name of the production variant.

• #volume_size_in_gb ⇒ Integer

  The size, in GB, of the ML storage volume attached to individual inference instance associated with the production variant.

Instance Attribute Details

#accelerator_type ⇒ String

The size of the Elastic Inference (EI) instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker.

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 34877

class ProductionVariant < Struct.new(
  :variant_name,
  :model_name,
  :initial_instance_count,
  :instance_type,
  :initial_variant_weight,
  :accelerator_type,
  :core_dump_config,
  :serverless_config,
  :volume_size_in_gb,
  :model_data_download_timeout_in_seconds,
  :container_startup_health_check_timeout_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#container_startup_health_check_timeout_in_seconds ⇒ Integer

The timeout value, in seconds, for your inference container to pass health check by SageMaker Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.

Returns:

• (Integer)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 34877

class ProductionVariant < Struct.new(
  :variant_name,
  :model_name,
  :initial_instance_count,
  :instance_type,
  :initial_variant_weight,
  :accelerator_type,
  :core_dump_config,
  :serverless_config,
  :volume_size_in_gb,
  :model_data_download_timeout_in_seconds,
  :container_startup_health_check_timeout_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#core_dump_config ⇒ Types::ProductionVariantCoreDumpConfig

Specifies configuration for a core dump from the model container when the process crashes.

Returns:

• (Types::ProductionVariantCoreDumpConfig)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 34877

class ProductionVariant < Struct.new(
  :variant_name,
  :model_name,
  :initial_instance_count,
  :instance_type,
  :initial_variant_weight,
  :accelerator_type,
  :core_dump_config,
  :serverless_config,
  :volume_size_in_gb,
  :model_data_download_timeout_in_seconds,
  :container_startup_health_check_timeout_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#initial_instance_count ⇒ Integer

Number of instances to launch initially.

Returns:

• (Integer)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 34877

class ProductionVariant < Struct.new(
  :variant_name,
  :model_name,
  :initial_instance_count,
  :instance_type,
  :initial_variant_weight,
  :accelerator_type,
  :core_dump_config,
  :serverless_config,
  :volume_size_in_gb,
  :model_data_download_timeout_in_seconds,
  :container_startup_health_check_timeout_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#initial_variant_weight ⇒ Float

Determines initial traffic distribution among all of the models that you specify in the endpoint configuration. The traffic to a production variant is determined by the ratio of the VariantWeight to the sum of all VariantWeight values across all ProductionVariants. If unspecified, it defaults to 1.0.

Returns:

• (Float)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 34877

class ProductionVariant < Struct.new(
  :variant_name,
  :model_name,
  :initial_instance_count,
  :instance_type,
  :initial_variant_weight,
  :accelerator_type,
  :core_dump_config,
  :serverless_config,
  :volume_size_in_gb,
  :model_data_download_timeout_in_seconds,
  :container_startup_health_check_timeout_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#instance_type ⇒ String

The ML compute instance type.

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 34877

class ProductionVariant < Struct.new(
  :variant_name,
  :model_name,
  :initial_instance_count,
  :instance_type,
  :initial_variant_weight,
  :accelerator_type,
  :core_dump_config,
  :serverless_config,
  :volume_size_in_gb,
  :model_data_download_timeout_in_seconds,
  :container_startup_health_check_timeout_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#model_data_download_timeout_in_seconds ⇒ Integer

The timeout value, in seconds, to download and extract the model that you want to host from Amazon S3 to the individual inference instance associated with this production variant.

Returns:

• (Integer)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 34877

class ProductionVariant < Struct.new(
  :variant_name,
  :model_name,
  :initial_instance_count,
  :instance_type,
  :initial_variant_weight,
  :accelerator_type,
  :core_dump_config,
  :serverless_config,
  :volume_size_in_gb,
  :model_data_download_timeout_in_seconds,
  :container_startup_health_check_timeout_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#model_name ⇒ String

The name of the model that you want to host. This is the name that you specified when creating the model.

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 34877

class ProductionVariant < Struct.new(
  :variant_name,
  :model_name,
  :initial_instance_count,
  :instance_type,
  :initial_variant_weight,
  :accelerator_type,
  :core_dump_config,
  :serverless_config,
  :volume_size_in_gb,
  :model_data_download_timeout_in_seconds,
  :container_startup_health_check_timeout_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#serverless_config ⇒ Types::ProductionVariantServerlessConfig

The serverless configuration for an endpoint. Specifies a serverless endpoint configuration instead of an instance-based endpoint configuration.

Returns:

• (Types::ProductionVariantServerlessConfig)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 34877

class ProductionVariant < Struct.new(
  :variant_name,
  :model_name,
  :initial_instance_count,
  :instance_type,
  :initial_variant_weight,
  :accelerator_type,
  :core_dump_config,
  :serverless_config,
  :volume_size_in_gb,
  :model_data_download_timeout_in_seconds,
  :container_startup_health_check_timeout_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#variant_name ⇒ String

The name of the production variant.

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 34877

class ProductionVariant < Struct.new(
  :variant_name,
  :model_name,
  :initial_instance_count,
  :instance_type,
  :initial_variant_weight,
  :accelerator_type,
  :core_dump_config,
  :serverless_config,
  :volume_size_in_gb,
  :model_data_download_timeout_in_seconds,
  :container_startup_health_check_timeout_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#volume_size_in_gb ⇒ Integer

The size, in GB, of the ML storage volume attached to individual inference instance associated with the production variant. Currenly only Amazon EBS gp2 storage volumes are supported.

Returns:

• (Integer)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 34877

class ProductionVariant < Struct.new(
  :variant_name,
  :model_name,
  :initial_instance_count,
  :instance_type,
  :initial_variant_weight,
  :accelerator_type,
  :core_dump_config,
  :serverless_config,
  :volume_size_in_gb,
  :model_data_download_timeout_in_seconds,
  :container_startup_health_check_timeout_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end