/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.sagemaker.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CreateAlgorithmRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* The name of the algorithm. *
*/ private String algorithmName; /** ** A description of the algorithm. *
*/ private String algorithmDescription; /** ** 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.
*
* 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. *
** 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. *
*/ private AlgorithmValidationSpecification validationSpecification; /** ** Whether to certify the algorithm so that it can be listed in Amazon Web Services Marketplace. *
*/ private Boolean certifyForMarketplace; /** ** 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. *
*/ private java.util.List* The name of the algorithm. *
* * @param algorithmName * The name of the algorithm. */ public void setAlgorithmName(String algorithmName) { this.algorithmName = algorithmName; } /** ** The name of the algorithm. *
* * @return The name of the algorithm. */ public String getAlgorithmName() { return this.algorithmName; } /** ** The name of the algorithm. *
* * @param algorithmName * The name of the algorithm. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateAlgorithmRequest withAlgorithmName(String algorithmName) { setAlgorithmName(algorithmName); return this; } /** ** A description of the algorithm. *
* * @param algorithmDescription * A description of the algorithm. */ public void setAlgorithmDescription(String algorithmDescription) { this.algorithmDescription = algorithmDescription; } /** ** A description of the algorithm. *
* * @return A description of the algorithm. */ public String getAlgorithmDescription() { return this.algorithmDescription; } /** ** A description of the algorithm. *
* * @param algorithmDescription * A description of the algorithm. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateAlgorithmRequest withAlgorithmDescription(String algorithmDescription) { setAlgorithmDescription(algorithmDescription); return this; } /** ** 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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. *
** 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. *
** 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. *
** 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. *
** 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. *
** 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. *
** 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. *
* * @param 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. */ public void setValidationSpecification(AlgorithmValidationSpecification validationSpecification) { this.validationSpecification = 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. *
* * @return 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. */ public AlgorithmValidationSpecification getValidationSpecification() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateAlgorithmRequest withValidationSpecification(AlgorithmValidationSpecification validationSpecification) { setValidationSpecification(validationSpecification); return this; } /** ** Whether to certify the algorithm so that it can be listed in Amazon Web Services Marketplace. *
* * @param certifyForMarketplace * Whether to certify the algorithm so that it can be listed in Amazon Web Services Marketplace. */ public void setCertifyForMarketplace(Boolean certifyForMarketplace) { this.certifyForMarketplace = certifyForMarketplace; } /** ** Whether to certify the algorithm so that it can be listed in Amazon Web Services Marketplace. *
* * @return Whether to certify the algorithm so that it can be listed in Amazon Web Services Marketplace. */ public Boolean getCertifyForMarketplace() { return this.certifyForMarketplace; } /** ** Whether to certify the algorithm so that it can be listed in Amazon Web Services Marketplace. *
* * @param certifyForMarketplace * Whether to certify the algorithm so that it can be listed in Amazon Web Services Marketplace. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateAlgorithmRequest withCertifyForMarketplace(Boolean certifyForMarketplace) { setCertifyForMarketplace(certifyForMarketplace); return this; } /** ** Whether to certify the algorithm so that it can be listed in Amazon Web Services Marketplace. *
* * @return Whether to certify the algorithm so that it can be listed in Amazon Web Services Marketplace. */ public Boolean isCertifyForMarketplace() { return this.certifyForMarketplace; } /** ** 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. *
* * @return 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. */ public java.util.List* 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. *
* * @param 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. */ public void setTags(java.util.Collection* 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. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the * existing values. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateAlgorithmRequest withTags(Tag... tags) { if (this.tags == null) { setTags(new java.util.ArrayList* 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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateAlgorithmRequest withTags(java.util.Collection