Skip to content

TrainingSpecification

Source code in docs_src/capo_sagemaker/types/training_specification.py
class TrainingSpecification(TypedDict, closed=True):
    training_image: NotRequired["capo_sagemaker.types.container_image.ContainerImage"]
    """<p>The Amazon ECR registry path of the Docker image that contains the training algorithm.</p>"""
    training_image_digest: NotRequired["capo_sagemaker.types.image_digest.ImageDigest"]
    """<p>An MD5 hash of the training algorithm that identifies the Docker image used for training.</p>"""
    supported_hyper_parameters: NotRequired[
        "capo_sagemaker.types.hyper_parameter_specifications.HyperParameterSpecifications"
    ]
    """<p>A list of the <code>HyperParameterSpecification</code> objects, that define the supported hyperparameters. This is required if the algorithm supports automatic model tuning.&gt;</p>"""
    supported_training_instance_types: NotRequired[
        "capo_sagemaker.types.training_instance_types.TrainingInstanceTypes"
    ]
    """<p>A list of the instance types that this algorithm can use for training.</p>"""
    supports_distributed_training: NotRequired["capo_sagemaker.types.boolean.Boolean"]
    """<p>Indicates whether the algorithm supports distributed training. If set to false, buyers can't request more than one instance during training.</p>"""
    metric_definitions: NotRequired[
        "capo_sagemaker.types.metric_definition_list.MetricDefinitionList"
    ]
    """<p>A list of <code>MetricDefinition</code> objects, which are used for parsing metrics generated by the algorithm.</p>"""
    training_channels: NotRequired[
        "capo_sagemaker.types.channel_specifications.ChannelSpecifications"
    ]
    """<p>A list of <code>ChannelSpecification</code> objects, which specify the input sources to be used by the algorithm.</p>"""
    supported_tuning_job_objective_metrics: NotRequired[
        "capo_sagemaker.types.hyper_parameter_tuning_job_objectives.HyperParameterTuningJobObjectives"
    ]
    """<p>A list of the metrics that the algorithm emits that can be used as the objective metric in a hyperparameter tuning job.</p>"""
    additional_s3_data_source: NotRequired[
        "capo_sagemaker.types.additional_s3_data_source.AdditionalS3DataSource"
    ]
    """<p>The additional data source used during the training job.</p>"""

additional_s3_data_source instance-attribute

additional_s3_data_source: NotRequired[AdditionalS3DataSource]

The additional data source used during the training job.

metric_definitions instance-attribute

metric_definitions: NotRequired[MetricDefinitionList]

A list of MetricDefinition objects, which are used for parsing metrics generated by the algorithm.

supported_hyper_parameters instance-attribute

supported_hyper_parameters: NotRequired[HyperParameterSpecifications]

A list of the HyperParameterSpecification objects, that define the supported hyperparameters. This is required if the algorithm supports automatic model tuning.>

supported_training_instance_types instance-attribute

supported_training_instance_types: NotRequired[TrainingInstanceTypes]

A list of the instance types that this algorithm can use for training.

supported_tuning_job_objective_metrics instance-attribute

supported_tuning_job_objective_metrics: NotRequired[HyperParameterTuningJobObjectives]

A list of the metrics that the algorithm emits that can be used as the objective metric in a hyperparameter tuning job.

supports_distributed_training instance-attribute

supports_distributed_training: NotRequired[Boolean]

Indicates whether the algorithm supports distributed training. If set to false, buyers can't request more than one instance during training.

training_channels instance-attribute

training_channels: NotRequired[ChannelSpecifications]

A list of ChannelSpecification objects, which specify the input sources to be used by the algorithm.

training_image instance-attribute

training_image: NotRequired[ContainerImage]

The Amazon ECR registry path of the Docker image that contains the training algorithm.

training_image_digest instance-attribute

training_image_digest: NotRequired[ImageDigest]

An MD5 hash of the training algorithm that identifies the Docker image used for training.