Skip to content

HyperParameterAlgorithmSpecification

Source code in docs_src/capo_sagemaker/types/hyper_parameter_algorithm_specification.py
class HyperParameterAlgorithmSpecification(TypedDict, closed=True):
    training_image: NotRequired["capo_sagemaker.types.algorithm_image.AlgorithmImage"]
    """<p> The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html">Algorithms Provided by Amazon SageMaker: Common Parameters</a>. SageMaker supports both <code>registry/repository[:tag]</code> and <code>registry/repository[@digest]</code> image path formats. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html">Using Your Own Algorithms with Amazon SageMaker</a>.</p>"""
    training_input_mode: NotRequired[
        "capo_sagemaker.types.training_input_mode.TrainingInputMode"
    ]
    algorithm_name: NotRequired["capo_sagemaker.types.arn_or_name.ArnOrName"]
    """<p>The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for <code>TrainingImage</code>.</p>"""
    metric_definitions: NotRequired[
        "capo_sagemaker.types.metric_definition_list.MetricDefinitionList"
    ]
    """<p>An array of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_MetricDefinition.html">MetricDefinition</a> objects that specify the metrics that the algorithm emits.</p>"""

algorithm_name instance-attribute

algorithm_name: NotRequired[ArnOrName]

The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.

metric_definitions instance-attribute

metric_definitions: NotRequired[MetricDefinitionList]

An array of MetricDefinition objects that specify the metrics that the algorithm emits.

training_image instance-attribute

training_image: NotRequired[AlgorithmImage]

The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

training_input_mode instance-attribute

training_input_mode: NotRequired[TrainingInputMode]