Skip to content

InferenceComponentSpecification

Source code in docs_src/capo_sagemaker/types/inference_component_specification.py
class InferenceComponentSpecification(TypedDict, closed=True):
    instance_type: NotRequired[
        "capo_sagemaker.types.production_variant_instance_type.ProductionVariantInstanceType"
    ]
    """<p>The ML compute instance type for the inference component specification. Specifies which instance type this specification applies to. Required when using the <code>Specifications</code> parameter with multiple entries.</p>"""
    model_name: NotRequired["capo_sagemaker.types.model_name.ModelName"]
    """<p>The name of an existing SageMaker AI model object in your account that you want to deploy with the inference component.</p>"""
    container: NotRequired[
        "capo_sagemaker.types.inference_component_container_specification.InferenceComponentContainerSpecification"
    ]
    """<p>Defines a container that provides the runtime environment for a model that you deploy with an inference component.</p>"""
    startup_parameters: NotRequired[
        "capo_sagemaker.types.inference_component_startup_parameters.InferenceComponentStartupParameters"
    ]
    """<p>Settings that take effect while the model container starts up.</p>"""
    compute_resource_requirements: NotRequired[
        "capo_sagemaker.types.inference_component_compute_resource_requirements.InferenceComponentComputeResourceRequirements"
    ]
    """<p>The compute resources allocated to run the model, plus any adapter models, that you assign to the inference component.</p> <p>Omit this parameter if your request is meant to create an adapter inference component. An adapter inference component is loaded by a base inference component, and it uses the compute resources of the base inference component.</p>"""
    base_inference_component_name: NotRequired[
        "capo_sagemaker.types.inference_component_name.InferenceComponentName"
    ]
    """<p>The name of an existing inference component that is to contain the inference component that you're creating with your request.</p> <p>Specify this parameter only if your request is meant to create an adapter inference component. An adapter inference component contains the path to an adapter model. The purpose of the adapter model is to tailor the inference output of a base foundation model, which is hosted by the base inference component. The adapter inference component uses the compute resources that you assigned to the base inference component.</p> <p>When you create an adapter inference component, use the <code>Container</code> parameter to specify the location of the adapter artifacts. In the parameter value, use the <code>ArtifactUrl</code> parameter of the <code>InferenceComponentContainerSpecification</code> data type.</p> <p>Before you can create an adapter inference component, you must have an existing inference component that contains the foundation model that you want to adapt.</p>"""
    data_cache_config: NotRequired[
        "capo_sagemaker.types.inference_component_data_cache_config.InferenceComponentDataCacheConfig"
    ]
    """<p>Settings that affect how the inference component caches data.</p>"""
    scheduling_config: NotRequired[
        "capo_sagemaker.types.inference_component_scheduling_config.InferenceComponentSchedulingConfig"
    ]
    """<p>The scheduling configuration that determines how inference component copies are placed across available instances when copies are added or removed.</p>"""

base_inference_component_name instance-attribute

base_inference_component_name: NotRequired[InferenceComponentName]

The name of an existing inference component that is to contain the inference component that you're creating with your request.

Specify this parameter only if your request is meant to create an adapter inference component. An adapter inference component contains the path to an adapter model. The purpose of the adapter model is to tailor the inference output of a base foundation model, which is hosted by the base inference component. The adapter inference component uses the compute resources that you assigned to the base inference component.

When you create an adapter inference component, use the Container parameter to specify the location of the adapter artifacts. In the parameter value, use the ArtifactUrl parameter of the InferenceComponentContainerSpecification data type.

Before you can create an adapter inference component, you must have an existing inference component that contains the foundation model that you want to adapt.

compute_resource_requirements instance-attribute

compute_resource_requirements: NotRequired[
    InferenceComponentComputeResourceRequirements
]

The compute resources allocated to run the model, plus any adapter models, that you assign to the inference component.

Omit this parameter if your request is meant to create an adapter inference component. An adapter inference component is loaded by a base inference component, and it uses the compute resources of the base inference component.

container instance-attribute

Defines a container that provides the runtime environment for a model that you deploy with an inference component.

data_cache_config instance-attribute

data_cache_config: NotRequired[InferenceComponentDataCacheConfig]

Settings that affect how the inference component caches data.

instance_type instance-attribute

instance_type: NotRequired[ProductionVariantInstanceType]

The ML compute instance type for the inference component specification. Specifies which instance type this specification applies to. Required when using the Specifications parameter with multiple entries.

model_name instance-attribute

model_name: NotRequired[ModelName]

The name of an existing SageMaker AI model object in your account that you want to deploy with the inference component.

scheduling_config instance-attribute

scheduling_config: NotRequired[InferenceComponentSchedulingConfig]

The scheduling configuration that determines how inference component copies are placed across available instances when copies are added or removed.

startup_parameters instance-attribute

startup_parameters: NotRequired[InferenceComponentStartupParameters]

Settings that take effect while the model container starts up.