CfnAlgorithmMixinProps

class aws_cdk.cfn_property_mixins.aws_sagemaker.CfnAlgorithmMixinProps(*, algorithm_description=None, algorithm_name=None, certify_for_marketplace=None, inference_specification=None, tags=None, training_specification=None)

Bases: object

Properties for CfnAlgorithmPropsMixin.

Parameters:

algorithm_description (Optional[str]) – A description of the algorithm.
algorithm_name (Optional[str]) – The name of the algorithm.
certify_for_marketplace (Union[bool, IResolvable, None]) – Whether to certify the algorithm so that it can be listed in AWS Marketplace.
inference_specification (Union[IResolvable, InferenceSpecificationProperty, Dict[str, Any], None])
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource.
training_specification (Union[IResolvable, TrainingSpecificationProperty, Dict[str, Any], None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-algorithm.html

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_sagemaker as sagemaker

cfn_algorithm_mixin_props = sagemaker.CfnAlgorithmMixinProps(
    algorithm_description="algorithmDescription",
    algorithm_name="algorithmName",
    certify_for_marketplace=False,
    inference_specification=sagemaker.CfnAlgorithmPropsMixin.InferenceSpecificationProperty(
        containers=[sagemaker.CfnAlgorithmPropsMixin.ModelPackageContainerDefinitionProperty(
            container_hostname="containerHostname",
            environment={
                "environment_key": "environment"
            },
            framework="framework",
            framework_version="frameworkVersion",
            image="image",
            image_digest="imageDigest",
            is_checkpoint=False,
            model_input=sagemaker.CfnAlgorithmPropsMixin.ModelInputProperty(
                data_input_config="dataInputConfig"
            ),
            nearest_model_name="nearestModelName"
        )],
        supported_content_types=["supportedContentTypes"],
        supported_realtime_inference_instance_types=["supportedRealtimeInferenceInstanceTypes"],
        supported_response_mime_types=["supportedResponseMimeTypes"],
        supported_transform_instance_types=["supportedTransformInstanceTypes"]
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    training_specification=sagemaker.CfnAlgorithmPropsMixin.TrainingSpecificationProperty(
        metric_definitions=[sagemaker.CfnAlgorithmPropsMixin.MetricDefinitionProperty(
            name="name",
            regex="regex"
        )],
        supported_hyper_parameters=[sagemaker.CfnAlgorithmPropsMixin.HyperParameterSpecificationProperty(
            default_value="defaultValue",
            description="description",
            is_required=False,
            is_tunable=False,
            name="name",
            range=sagemaker.CfnAlgorithmPropsMixin.ParameterRangeProperty(
                categorical_parameter_range_specification=sagemaker.CfnAlgorithmPropsMixin.CategoricalParameterRangeSpecificationProperty(
                    values=["values"]
                ),
                continuous_parameter_range_specification=sagemaker.CfnAlgorithmPropsMixin.ContinuousParameterRangeSpecificationProperty(
                    max_value="maxValue",
                    min_value="minValue"
                ),
                integer_parameter_range_specification=sagemaker.CfnAlgorithmPropsMixin.IntegerParameterRangeSpecificationProperty(
                    max_value="maxValue",
                    min_value="minValue"
                )
            ),
            type="type"
        )],
        supported_training_instance_types=["supportedTrainingInstanceTypes"],
        supported_tuning_job_objective_metrics=[sagemaker.CfnAlgorithmPropsMixin.HyperParameterTuningJobObjectiveProperty(
            metric_name="metricName",
            type="type"
        )],
        supports_distributed_training=False,
        training_channels=[sagemaker.CfnAlgorithmPropsMixin.ChannelSpecificationProperty(
            description="description",
            is_required=False,
            name="name",
            supported_compression_types=["supportedCompressionTypes"],
            supported_content_types=["supportedContentTypes"],
            supported_input_modes=["supportedInputModes"]
        )],
        training_image="trainingImage",
        training_image_digest="trainingImageDigest"
    )
)