Skip to content

RecommendationJobContainerConfig

Source code in docs_src/capo_sagemaker/types/recommendation_job_container_config.py
class RecommendationJobContainerConfig(TypedDict, closed=True):
    domain: NotRequired["capo_sagemaker.types.string.String"]
    """<p>The machine learning domain of the model and its components.</p> <p>Valid Values: <code>COMPUTER_VISION | NATURAL_LANGUAGE_PROCESSING | MACHINE_LEARNING</code> </p>"""
    task: NotRequired["capo_sagemaker.types.string.String"]
    """<p>The machine learning task that the model accomplishes.</p> <p>Valid Values: <code>IMAGE_CLASSIFICATION | OBJECT_DETECTION | TEXT_GENERATION | IMAGE_SEGMENTATION | FILL_MASK | CLASSIFICATION | REGRESSION | OTHER</code> </p>"""
    framework: NotRequired["capo_sagemaker.types.string.String"]
    """<p>The machine learning framework of the container image.</p> <p>Valid Values: <code>TENSORFLOW | PYTORCH | XGBOOST | SAGEMAKER-SCIKIT-LEARN</code> </p>"""
    framework_version: NotRequired[
        "capo_sagemaker.types.recommendation_job_framework_version.RecommendationJobFrameworkVersion"
    ]
    """<p>The framework version of the container image.</p>"""
    payload_config: NotRequired[
        "capo_sagemaker.types.recommendation_job_payload_config.RecommendationJobPayloadConfig"
    ]
    """<p>Specifies the <code>SamplePayloadUrl</code> and all other sample payload-related fields.</p>"""
    nearest_model_name: NotRequired["capo_sagemaker.types.string.String"]
    """<p>The name of a pre-trained machine learning model benchmarked by Amazon SageMaker Inference Recommender that matches your model.</p> <p>Valid Values: <code>efficientnetb7 | unet | xgboost | faster-rcnn-resnet101 | nasnetlarge | vgg16 | inception-v3 | mask-rcnn | sagemaker-scikit-learn | densenet201-gluon | resnet18v2-gluon | xception | densenet201 | yolov4 | resnet152 | bert-base-cased | xceptionV1-keras | resnet50 | retinanet</code> </p>"""
    supported_instance_types: NotRequired[
        "capo_sagemaker.types.recommendation_job_supported_instance_types.RecommendationJobSupportedInstanceTypes"
    ]
    """<p>A list of the instance types that are used to generate inferences in real-time.</p>"""
    supported_endpoint_type: NotRequired[
        "capo_sagemaker.types.recommendation_job_supported_endpoint_type.RecommendationJobSupportedEndpointType"
    ]
    """<p>The endpoint type to receive recommendations for. By default this is null, and the results of the inference recommendation job return a combined list of both real-time and serverless benchmarks. By specifying a value for this field, you can receive a longer list of benchmarks for the desired endpoint type.</p>"""
    data_input_config: NotRequired[
        "capo_sagemaker.types.recommendation_job_data_input_config.RecommendationJobDataInputConfig"
    ]
    """<p>Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. This field is used for optimizing your model using SageMaker Neo. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_InputConfig.html#sagemaker-Type-InputConfig-DataInputConfig">DataInputConfig</a>.</p>"""
    supported_response_mime_types: NotRequired[
        "capo_sagemaker.types.recommendation_job_supported_response_mime_types.RecommendationJobSupportedResponseMIMETypes"
    ]
    """<p>The supported MIME types for the output data.</p>"""

data_input_config instance-attribute

data_input_config: NotRequired[RecommendationJobDataInputConfig]

Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. This field is used for optimizing your model using SageMaker Neo. For more information, see DataInputConfig.

domain instance-attribute

domain: NotRequired[String]

The machine learning domain of the model and its components.

Valid Values: COMPUTER_VISION | NATURAL_LANGUAGE_PROCESSING | MACHINE_LEARNING

framework instance-attribute

framework: NotRequired[String]

The machine learning framework of the container image.

Valid Values: TENSORFLOW | PYTORCH | XGBOOST | SAGEMAKER-SCIKIT-LEARN

framework_version instance-attribute

framework_version: NotRequired[RecommendationJobFrameworkVersion]

The framework version of the container image.

nearest_model_name instance-attribute

nearest_model_name: NotRequired[String]

The name of a pre-trained machine learning model benchmarked by Amazon SageMaker Inference Recommender that matches your model.

Valid Values: efficientnetb7 | unet | xgboost | faster-rcnn-resnet101 | nasnetlarge | vgg16 | inception-v3 | mask-rcnn | sagemaker-scikit-learn | densenet201-gluon | resnet18v2-gluon | xception | densenet201 | yolov4 | resnet152 | bert-base-cased | xceptionV1-keras | resnet50 | retinanet

payload_config instance-attribute

payload_config: NotRequired[RecommendationJobPayloadConfig]

Specifies the SamplePayloadUrl and all other sample payload-related fields.

supported_endpoint_type instance-attribute

supported_endpoint_type: NotRequired[RecommendationJobSupportedEndpointType]

The endpoint type to receive recommendations for. By default this is null, and the results of the inference recommendation job return a combined list of both real-time and serverless benchmarks. By specifying a value for this field, you can receive a longer list of benchmarks for the desired endpoint type.

supported_instance_types instance-attribute

supported_instance_types: NotRequired[RecommendationJobSupportedInstanceTypes]

A list of the instance types that are used to generate inferences in real-time.

supported_response_mime_types instance-attribute

supported_response_mime_types: NotRequired[RecommendationJobSupportedResponseMIMETypes]

The supported MIME types for the output data.

task instance-attribute

task: NotRequired[String]

The machine learning task that the model accomplishes.

Valid Values: IMAGE_CLASSIFICATION | OBJECT_DETECTION | TEXT_GENERATION | IMAGE_SEGMENTATION | FILL_MASK | CLASSIFICATION | REGRESSION | OTHER