CfnAlgorithmPropsMixin

class aws_cdk.cfn_property_mixins.aws_sagemaker.CfnAlgorithmPropsMixin(props, *, strategy=None)

Bases: Mixin

Resource Type definition for AWS::SageMaker::Algorithm.

See:

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

CloudformationResource:

AWS::SageMaker::Algorithm

Mixin:

true

ExampleMetadata:

fixture=_generated

Example:

# 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
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_algorithm_props_mixin = sagemaker.CfnAlgorithmPropsMixin(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=[cdk.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"
    )
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::SageMaker::Algorithm.

Parameters:

  • props (Union[CfnAlgorithmMixinProps, Dict[str, Any]]) – L1 properties to apply.

  • strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

None

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['algorithmDescription', 'algorithmName', 'certifyForMarketplace', 'inferenceSpecification', 'tags', 'trainingSpecification']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

CategoricalParameterRangeSpecificationProperty

class CfnAlgorithmPropsMixin.CategoricalParameterRangeSpecificationProperty(*, values=None)

Bases: object

Parameters:

values (Optional[Sequence[str]])

See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

categorical_parameter_range_specification_property = sagemaker.CfnAlgorithmPropsMixin.CategoricalParameterRangeSpecificationProperty(
    values=["values"]
)

Attributes

values

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-categoricalparameterrangespecification.html#cfn-sagemaker-algorithm-categoricalparameterrangespecification-values

Type:

see

ChannelSpecificationProperty

class CfnAlgorithmPropsMixin.ChannelSpecificationProperty(*, description=None, is_required=None, name=None, supported_compression_types=None, supported_content_types=None, supported_input_modes=None)

Bases: object

Parameters:

  • description (Optional[str])

  • is_required (Union[bool, IResolvable, None])

  • name (Optional[str])

  • supported_compression_types (Optional[Sequence[str]])

  • supported_content_types (Optional[Sequence[str]])

  • supported_input_modes (Optional[Sequence[str]])

See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

channel_specification_property = sagemaker.CfnAlgorithmPropsMixin.ChannelSpecificationProperty(
    description="description",
    is_required=False,
    name="name",
    supported_compression_types=["supportedCompressionTypes"],
    supported_content_types=["supportedContentTypes"],
    supported_input_modes=["supportedInputModes"]
)

Attributes

description

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-channelspecification.html#cfn-sagemaker-algorithm-channelspecification-description

Type:

see

is_required

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-channelspecification.html#cfn-sagemaker-algorithm-channelspecification-isrequired

Type:

see

name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-channelspecification.html#cfn-sagemaker-algorithm-channelspecification-name

Type:

see

supported_compression_types

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-channelspecification.html#cfn-sagemaker-algorithm-channelspecification-supportedcompressiontypes

Type:

see

supported_content_types

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-channelspecification.html#cfn-sagemaker-algorithm-channelspecification-supportedcontenttypes

Type:

see

supported_input_modes

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-channelspecification.html#cfn-sagemaker-algorithm-channelspecification-supportedinputmodes

Type:

see

ContinuousParameterRangeSpecificationProperty

class CfnAlgorithmPropsMixin.ContinuousParameterRangeSpecificationProperty(*, max_value=None, min_value=None)

Bases: object

Parameters:

  • max_value (Optional[str])

  • min_value (Optional[str])

See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

continuous_parameter_range_specification_property = sagemaker.CfnAlgorithmPropsMixin.ContinuousParameterRangeSpecificationProperty(
    max_value="maxValue",
    min_value="minValue"
)

Attributes

max_value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-continuousparameterrangespecification.html#cfn-sagemaker-algorithm-continuousparameterrangespecification-maxvalue

Type:

see

min_value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-continuousparameterrangespecification.html#cfn-sagemaker-algorithm-continuousparameterrangespecification-minvalue

Type:

see

HyperParameterSpecificationProperty

class CfnAlgorithmPropsMixin.HyperParameterSpecificationProperty(*, default_value=None, description=None, is_required=None, is_tunable=None, name=None, range=None, type=None)

Bases: object

Parameters:
See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

hyper_parameter_specification_property = 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"
)

Attributes

default_value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-hyperparameterspecification.html#cfn-sagemaker-algorithm-hyperparameterspecification-defaultvalue

Type:

see

description

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-hyperparameterspecification.html#cfn-sagemaker-algorithm-hyperparameterspecification-description

Type:

see

is_required

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-hyperparameterspecification.html#cfn-sagemaker-algorithm-hyperparameterspecification-isrequired

Type:

see

is_tunable

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-hyperparameterspecification.html#cfn-sagemaker-algorithm-hyperparameterspecification-istunable

Type:

see

name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-hyperparameterspecification.html#cfn-sagemaker-algorithm-hyperparameterspecification-name

Type:

see

range

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-hyperparameterspecification.html#cfn-sagemaker-algorithm-hyperparameterspecification-range

Type:

see

type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-hyperparameterspecification.html#cfn-sagemaker-algorithm-hyperparameterspecification-type

Type:

see

HyperParameterTuningJobObjectiveProperty

class CfnAlgorithmPropsMixin.HyperParameterTuningJobObjectiveProperty(*, metric_name=None, type=None)

Bases: object

Parameters:

  • metric_name (Optional[str])

  • type (Optional[str])

See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

hyper_parameter_tuning_job_objective_property = sagemaker.CfnAlgorithmPropsMixin.HyperParameterTuningJobObjectiveProperty(
    metric_name="metricName",
    type="type"
)

Attributes

metric_name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-hyperparametertuningjobobjective.html#cfn-sagemaker-algorithm-hyperparametertuningjobobjective-metricname

Type:

see

type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-hyperparametertuningjobobjective.html#cfn-sagemaker-algorithm-hyperparametertuningjobobjective-type

Type:

see

InferenceSpecificationProperty

class CfnAlgorithmPropsMixin.InferenceSpecificationProperty(*, containers=None, supported_content_types=None, supported_realtime_inference_instance_types=None, supported_response_mime_types=None, supported_transform_instance_types=None)

Bases: object

Parameters:

  • containers (Union[IResolvable, Sequence[Union[IResolvable, ModelPackageContainerDefinitionProperty, Dict[str, Any]]], None])

  • supported_content_types (Optional[Sequence[str]])

  • supported_realtime_inference_instance_types (Optional[Sequence[str]])

  • supported_response_mime_types (Optional[Sequence[str]])

  • supported_transform_instance_types (Optional[Sequence[str]])

See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

inference_specification_property = 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"]
)

Attributes

containers

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-inferencespecification.html#cfn-sagemaker-algorithm-inferencespecification-containers

Type:

see

supported_content_types

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-inferencespecification.html#cfn-sagemaker-algorithm-inferencespecification-supportedcontenttypes

Type:

see

supported_realtime_inference_instance_types

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-inferencespecification.html#cfn-sagemaker-algorithm-inferencespecification-supportedrealtimeinferenceinstancetypes

Type:

see

supported_response_mime_types

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-inferencespecification.html#cfn-sagemaker-algorithm-inferencespecification-supportedresponsemimetypes

Type:

see

supported_transform_instance_types

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-inferencespecification.html#cfn-sagemaker-algorithm-inferencespecification-supportedtransforminstancetypes

Type:

see

IntegerParameterRangeSpecificationProperty

class CfnAlgorithmPropsMixin.IntegerParameterRangeSpecificationProperty(*, max_value=None, min_value=None)

Bases: object

Parameters:

  • max_value (Optional[str])

  • min_value (Optional[str])

See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

integer_parameter_range_specification_property = sagemaker.CfnAlgorithmPropsMixin.IntegerParameterRangeSpecificationProperty(
    max_value="maxValue",
    min_value="minValue"
)

Attributes

max_value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-integerparameterrangespecification.html#cfn-sagemaker-algorithm-integerparameterrangespecification-maxvalue

Type:

see

min_value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-integerparameterrangespecification.html#cfn-sagemaker-algorithm-integerparameterrangespecification-minvalue

Type:

see

MetricDefinitionProperty

class CfnAlgorithmPropsMixin.MetricDefinitionProperty(*, name=None, regex=None)

Bases: object

Parameters:

  • name (Optional[str])

  • regex (Optional[str])

See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

metric_definition_property = sagemaker.CfnAlgorithmPropsMixin.MetricDefinitionProperty(
    name="name",
    regex="regex"
)

Attributes

name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-metricdefinition.html#cfn-sagemaker-algorithm-metricdefinition-name

Type:

see

regex

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-metricdefinition.html#cfn-sagemaker-algorithm-metricdefinition-regex

Type:

see

ModelInputProperty

class CfnAlgorithmPropsMixin.ModelInputProperty(*, data_input_config=None)

Bases: object

Parameters:

data_input_config (Optional[str])

See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

model_input_property = sagemaker.CfnAlgorithmPropsMixin.ModelInputProperty(
    data_input_config="dataInputConfig"
)

Attributes

data_input_config

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-modelinput.html#cfn-sagemaker-algorithm-modelinput-datainputconfig

Type:

see

ModelPackageContainerDefinitionProperty

class CfnAlgorithmPropsMixin.ModelPackageContainerDefinitionProperty(*, container_hostname=None, environment=None, framework=None, framework_version=None, image=None, image_digest=None, is_checkpoint=None, model_input=None, nearest_model_name=None)

Bases: object

Parameters:

  • container_hostname (Optional[str])

  • environment (Union[IResolvable, Mapping[str, str], None])

  • framework (Optional[str])

  • framework_version (Optional[str])

  • image (Optional[str])

  • image_digest (Optional[str])

  • is_checkpoint (Union[bool, IResolvable, None])

  • model_input (Union[IResolvable, ModelInputProperty, Dict[str, Any], None])

  • nearest_model_name (Optional[str])

See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

model_package_container_definition_property = 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"
)

Attributes

container_hostname

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-modelpackagecontainerdefinition.html#cfn-sagemaker-algorithm-modelpackagecontainerdefinition-containerhostname

Type:

see

environment

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-modelpackagecontainerdefinition.html#cfn-sagemaker-algorithm-modelpackagecontainerdefinition-environment

Type:

see

framework

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-modelpackagecontainerdefinition.html#cfn-sagemaker-algorithm-modelpackagecontainerdefinition-framework

Type:

see

framework_version

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-modelpackagecontainerdefinition.html#cfn-sagemaker-algorithm-modelpackagecontainerdefinition-frameworkversion

Type:

see

image

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-modelpackagecontainerdefinition.html#cfn-sagemaker-algorithm-modelpackagecontainerdefinition-image

Type:

see

image_digest

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-modelpackagecontainerdefinition.html#cfn-sagemaker-algorithm-modelpackagecontainerdefinition-imagedigest

Type:

see

is_checkpoint

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-modelpackagecontainerdefinition.html#cfn-sagemaker-algorithm-modelpackagecontainerdefinition-ischeckpoint

Type:

see

model_input

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-modelpackagecontainerdefinition.html#cfn-sagemaker-algorithm-modelpackagecontainerdefinition-modelinput

Type:

see

nearest_model_name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-modelpackagecontainerdefinition.html#cfn-sagemaker-algorithm-modelpackagecontainerdefinition-nearestmodelname

Type:

see

ParameterRangeProperty

class CfnAlgorithmPropsMixin.ParameterRangeProperty(*, categorical_parameter_range_specification=None, continuous_parameter_range_specification=None, integer_parameter_range_specification=None)

Bases: object

Parameters:
See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

parameter_range_property = 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"
    )
)

Attributes

categorical_parameter_range_specification

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-parameterrange.html#cfn-sagemaker-algorithm-parameterrange-categoricalparameterrangespecification

Type:

see

continuous_parameter_range_specification

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-parameterrange.html#cfn-sagemaker-algorithm-parameterrange-continuousparameterrangespecification

Type:

see

integer_parameter_range_specification

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-parameterrange.html#cfn-sagemaker-algorithm-parameterrange-integerparameterrangespecification

Type:

see

TrainingSpecificationProperty

class CfnAlgorithmPropsMixin.TrainingSpecificationProperty(*, metric_definitions=None, supported_hyper_parameters=None, supported_training_instance_types=None, supported_tuning_job_objective_metrics=None, supports_distributed_training=None, training_channels=None, training_image=None, training_image_digest=None)

Bases: object

Parameters:
See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

training_specification_property = 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"
)

Attributes

metric_definitions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-trainingspecification.html#cfn-sagemaker-algorithm-trainingspecification-metricdefinitions

Type:

see

supported_hyper_parameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-trainingspecification.html#cfn-sagemaker-algorithm-trainingspecification-supportedhyperparameters

Type:

see

supported_training_instance_types

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-trainingspecification.html#cfn-sagemaker-algorithm-trainingspecification-supportedtraininginstancetypes

Type:

see

supported_tuning_job_objective_metrics

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-trainingspecification.html#cfn-sagemaker-algorithm-trainingspecification-supportedtuningjobobjectivemetrics

Type:

see

supports_distributed_training

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-trainingspecification.html#cfn-sagemaker-algorithm-trainingspecification-supportsdistributedtraining

Type:

see

training_channels

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-trainingspecification.html#cfn-sagemaker-algorithm-trainingspecification-trainingchannels

Type:

see

training_image

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-trainingspecification.html#cfn-sagemaker-algorithm-trainingspecification-trainingimage

Type:

see

training_image_digest

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-algorithm-trainingspecification.html#cfn-sagemaker-algorithm-trainingspecification-trainingimagedigest

Type:

see