Skip to content

ContainerConfig

Used by
Source code in docs_src/capo_cleanroomsml/types/container_config.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class ContainerConfig(TypedDict, closed=True):
    image_uri: "capo_cleanroomsml.types.algorithm_image.AlgorithmImage"
    """<p>The registry path of the docker image that contains the algorithm. Clean Rooms ML currently only supports the <code>registry/repository[:tag]</code> image path format. For more information about using images in Clean Rooms ML, see the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AlgorithmSpecification.html#sagemaker-Type-AlgorithmSpecification-TrainingImage">Sagemaker API reference</a>.</p>"""
    entrypoint: NotRequired[
        "capo_cleanroomsml.types.container_entrypoint.ContainerEntrypoint"
    ]
    """<p>The entrypoint script for a Docker container used to run a training job. This script takes precedence over the default train processing instructions. See How Amazon SageMaker Runs Your Training Image for additional information. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-training-algo-dockerfile.html">How Sagemaker runs your training image</a>.</p>"""
    arguments: NotRequired[
        "capo_cleanroomsml.types.container_arguments.ContainerArguments"
    ]
    """<p>The arguments for a container used to run a training job. See How Amazon SageMaker Runs Your Training Image for additional information. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-training-algo-dockerfile.html">How Sagemaker runs your training image</a>.</p>"""
    metric_definitions: NotRequired[
        "capo_cleanroomsml.types.metric_definition_list.MetricDefinitionList"
    ]
    """<p>A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. Amazon Web Services Clean Rooms ML publishes each metric to all members' Amazon CloudWatch using IAM role configured in <a>PutMLConfiguration</a>.</p>"""

arguments instance-attribute 

arguments: NotRequired[ContainerArguments]

The arguments for a container used to run a training job. See How Amazon SageMaker Runs Your Training Image for additional information. For more information, see How Sagemaker runs your training image.

entrypoint instance-attribute 

entrypoint: NotRequired[ContainerEntrypoint]

The entrypoint script for a Docker container used to run a training job. This script takes precedence over the default train processing instructions. See How Amazon SageMaker Runs Your Training Image for additional information. For more information, see How Sagemaker runs your training image.

image_uri instance-attribute 

image_uri: AlgorithmImage

The registry path of the docker image that contains the algorithm. Clean Rooms ML currently only supports the registry/repository[:tag] image path format. For more information about using images in Clean Rooms ML, see the Sagemaker API reference.

metric_definitions instance-attribute 

metric_definitions: NotRequired[MetricDefinitionList]

A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. Amazon Web Services Clean Rooms ML publishes each metric to all members' Amazon CloudWatch using IAM role configured in PutMLConfiguration.