Skip to content

CreateAlgorithmInput

Source code in docs_src/capo_sagemaker/types/create_algorithm_input.py
class CreateAlgorithmInput(TypedDict, closed=True):
    algorithm_name: NotRequired["capo_sagemaker.types.entity_name.EntityName"]
    """<p>The name of the algorithm.</p>"""
    algorithm_description: NotRequired[
        "capo_sagemaker.types.entity_description.EntityDescription"
    ]
    """<p>A description of the algorithm.</p>"""
    training_specification: NotRequired[
        "capo_sagemaker.types.training_specification.TrainingSpecification"
    ]
    """<p>Specifies details about training jobs run by this algorithm, including the following:</p> <ul> <li> <p>The Amazon ECR path of the container and the version digest of the algorithm.</p> </li> <li> <p>The hyperparameters that the algorithm supports.</p> </li> <li> <p>The instance types that the algorithm supports for training.</p> </li> <li> <p>Whether the algorithm supports distributed training.</p> </li> <li> <p>The metrics that the algorithm emits to Amazon CloudWatch.</p> </li> <li> <p>Which metrics that the algorithm emits can be used as the objective metric for hyperparameter tuning jobs.</p> </li> <li> <p>The input channels that the algorithm supports for training data. For example, an algorithm might support <code>train</code>, <code>validation</code>, and <code>test</code> channels.</p> </li> </ul>"""
    inference_specification: NotRequired[
        "capo_sagemaker.types.inference_specification.InferenceSpecification"
    ]
    """<p>Specifies details about inference jobs that the algorithm runs, including the following:</p> <ul> <li> <p>The Amazon ECR paths of containers that contain the inference code and model artifacts.</p> </li> <li> <p>The instance types that the algorithm supports for transform jobs and real-time endpoints used for inference.</p> </li> <li> <p>The input and output content formats that the algorithm supports for inference.</p> </li> </ul>"""
    validation_specification: NotRequired[
        "capo_sagemaker.types.algorithm_validation_specification.AlgorithmValidationSpecification"
    ]
    """<p>Specifies configurations for one or more training jobs and that SageMaker runs to test the algorithm's training code and, optionally, one or more batch transform jobs that SageMaker runs to test the algorithm's inference code.</p>"""
    certify_for_marketplace: NotRequired[
        "capo_sagemaker.types.certify_for_marketplace.CertifyForMarketplace"
    ]
    """<p>Whether to certify the algorithm so that it can be listed in Amazon Web Services Marketplace.</p>"""
    tags: NotRequired["capo_sagemaker.types.tag_list.TagList"]
    """<p>An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.</p>"""

algorithm_description instance-attribute

algorithm_description: NotRequired[EntityDescription]

A description of the algorithm.

algorithm_name instance-attribute

algorithm_name: NotRequired[EntityName]

The name of the algorithm.

certify_for_marketplace instance-attribute

certify_for_marketplace: NotRequired[CertifyForMarketplace]

Whether to certify the algorithm so that it can be listed in Amazon Web Services Marketplace.

inference_specification instance-attribute

inference_specification: NotRequired[InferenceSpecification]

Specifies details about inference jobs that the algorithm runs, including the following:

  • The Amazon ECR paths of containers that contain the inference code and model artifacts.

  • The instance types that the algorithm supports for transform jobs and real-time endpoints used for inference.

  • The input and output content formats that the algorithm supports for inference.

tags instance-attribute

tags: NotRequired[TagList]

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

training_specification instance-attribute

training_specification: NotRequired[TrainingSpecification]

Specifies details about training jobs run by this algorithm, including the following:

  • The Amazon ECR path of the container and the version digest of the algorithm.

  • The hyperparameters that the algorithm supports.

  • The instance types that the algorithm supports for training.

  • Whether the algorithm supports distributed training.

  • The metrics that the algorithm emits to Amazon CloudWatch.

  • Which metrics that the algorithm emits can be used as the objective metric for hyperparameter tuning jobs.

  • The input channels that the algorithm supports for training data. For example, an algorithm might support train, validation, and test channels.

validation_specification instance-attribute

validation_specification: NotRequired[AlgorithmValidationSpecification]

Specifies configurations for one or more training jobs and that SageMaker runs to test the algorithm's training code and, optionally, one or more batch transform jobs that SageMaker runs to test the algorithm's inference code.