Package software.amazon.awssdk.services.sagemaker.model

Class CreateAlgorithmRequest

    • Method Detail

      • algorithmName

        public final String algorithmName()

        The name of the algorithm.

        Returns:
        The name of the algorithm.

      • algorithmDescription

        public final String algorithmDescription()

        A description of the algorithm.

        Returns:
        A description of the algorithm.

      • trainingSpecification

        public final TrainingSpecification 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.

        Returns:
        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.

      • inferenceSpecification

        public final InferenceSpecification 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.

        Returns:
        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.

      • validationSpecification

        public final AlgorithmValidationSpecification validationSpecification()

        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.

        Returns:
        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.

      • certifyForMarketplace

        public final Boolean certifyForMarketplace()

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

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

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

        public final List<Tag> tags()

        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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        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.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object