Interface AlgorithmSpecification.Builder

All Superinterfaces:
Buildable, CopyableBuilder<AlgorithmSpecification.Builder,AlgorithmSpecification>, SdkBuilder<AlgorithmSpecification.Builder,AlgorithmSpecification>, SdkPojo
Enclosing class:
AlgorithmSpecification
public static interface AlgorithmSpecification.Builder extends SdkPojo, CopyableBuilder<AlgorithmSpecification.Builder,AlgorithmSpecification>

  • Method Details

    • trainingImage

      AlgorithmSpecification.Builder trainingImage(String trainingImage)

      The registry path of the Docker image that contains the training algorithm. For information about docker registry paths for SageMaker built-in algorithms, see Docker Registry Paths and Example Code in the Amazon SageMaker developer guide. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information about using your custom training container, see Using Your Own Algorithms with Amazon SageMaker.

      You must specify either the algorithm name to the AlgorithmName parameter or the image URI of the algorithm container to the TrainingImage parameter.

      For more information, see the note in the AlgorithmName parameter description.

      Parameters:
      trainingImage - The registry path of the Docker image that contains the training algorithm. For information about docker registry paths for SageMaker built-in algorithms, see Docker Registry Paths and Example Code in the Amazon SageMaker developer guide. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information about using your custom training container, see Using Your Own Algorithms with Amazon SageMaker.

      You must specify either the algorithm name to the AlgorithmName parameter or the image URI of the algorithm container to the TrainingImage parameter.

      For more information, see the note in the AlgorithmName parameter description.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • algorithmName

      AlgorithmSpecification.Builder algorithmName(String algorithmName)

      The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on Amazon Web Services Marketplace.

      You must specify either the algorithm name to the AlgorithmName parameter or the image URI of the algorithm container to the TrainingImage parameter.

      Note that the AlgorithmName parameter is mutually exclusive with the TrainingImage parameter. If you specify a value for the AlgorithmName parameter, you can't specify a value for TrainingImage, and vice versa.

      If you specify values for both parameters, the training job might break; if you don't specify any value for both parameters, the training job might raise a null error.

      Parameters:
      algorithmName - The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on Amazon Web Services Marketplace.

      You must specify either the algorithm name to the AlgorithmName parameter or the image URI of the algorithm container to the TrainingImage parameter.

      Note that the AlgorithmName parameter is mutually exclusive with the TrainingImage parameter. If you specify a value for the AlgorithmName parameter, you can't specify a value for TrainingImage, and vice versa.

      If you specify values for both parameters, the training job might break; if you don't specify any value for both parameters, the training job might raise a null error.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trainingInputMode

      AlgorithmSpecification.Builder trainingInputMode(String trainingInputMode)
      Sets the value of the TrainingInputMode property for this object.
      Parameters:
      trainingInputMode - The new value for the TrainingInputMode property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • trainingInputMode

      AlgorithmSpecification.Builder trainingInputMode(TrainingInputMode trainingInputMode)
      Sets the value of the TrainingInputMode property for this object.
      Parameters:
      trainingInputMode - The new value for the TrainingInputMode property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • metricDefinitions

      AlgorithmSpecification.Builder metricDefinitions(Collection<MetricDefinition> metricDefinitions)

      A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. SageMaker publishes each metric to Amazon CloudWatch.

      Parameters:
      metricDefinitions - A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. SageMaker publishes each metric to Amazon CloudWatch.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metricDefinitions

      AlgorithmSpecification.Builder metricDefinitions(MetricDefinition... metricDefinitions)

      A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. SageMaker publishes each metric to Amazon CloudWatch.

      Parameters:
      metricDefinitions - A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. SageMaker publishes each metric to Amazon CloudWatch.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metricDefinitions

      AlgorithmSpecification.Builder metricDefinitions(Consumer<MetricDefinition.Builder>... metricDefinitions)

      A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. SageMaker publishes each metric to Amazon CloudWatch.

      This is a convenience method that creates an instance of the MetricDefinition.Builder avoiding the need to create one manually via MetricDefinition.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to metricDefinitions(List<MetricDefinition>).

      Parameters:
      metricDefinitions - a consumer that will call methods on MetricDefinition.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • enableSageMakerMetricsTimeSeries

      AlgorithmSpecification.Builder enableSageMakerMetricsTimeSeries(Boolean enableSageMakerMetricsTimeSeries)

      To generate and save time-series metrics during training, set to true. The default is false and time-series metrics aren't generated except in the following cases:

      Parameters:
      enableSageMakerMetricsTimeSeries - To generate and save time-series metrics during training, set to true. The default is false and time-series metrics aren't generated except in the following cases:

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • containerEntrypoint

      AlgorithmSpecification.Builder containerEntrypoint(Collection<String> containerEntrypoint)

      The entrypoint script for a Docker container used to run a training job. This script takes precedence over the default train processing instructions. See How Amazon SageMaker Runs Your Training Image for more information.

      Parameters:
      containerEntrypoint - The entrypoint script for a Docker container used to run a training job. This script takes precedence over the default train processing instructions. See How Amazon SageMaker Runs Your Training Image for more information.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • containerEntrypoint

      AlgorithmSpecification.Builder containerEntrypoint(String... containerEntrypoint)

      The entrypoint script for a Docker container used to run a training job. This script takes precedence over the default train processing instructions. See How Amazon SageMaker Runs Your Training Image for more information.

      Parameters:
      containerEntrypoint - The entrypoint script for a Docker container used to run a training job. This script takes precedence over the default train processing instructions. See How Amazon SageMaker Runs Your Training Image for more information.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • containerArguments

      AlgorithmSpecification.Builder containerArguments(Collection<String> containerArguments)

      The arguments for a container used to run a training job. See How Amazon SageMaker Runs Your Training Image for additional information.

      Parameters:
      containerArguments - The arguments for a container used to run a training job. See How Amazon SageMaker Runs Your Training Image for additional information.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • containerArguments

      AlgorithmSpecification.Builder containerArguments(String... containerArguments)

      The arguments for a container used to run a training job. See How Amazon SageMaker Runs Your Training Image for additional information.

      Parameters:
      containerArguments - The arguments for a container used to run a training job. See How Amazon SageMaker Runs Your Training Image for additional information.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trainingImageConfig

      AlgorithmSpecification.Builder trainingImageConfig(TrainingImageConfig trainingImageConfig)

      The configuration to use an image from a private Docker registry for a training job.

      Parameters:
      trainingImageConfig - The configuration to use an image from a private Docker registry for a training job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trainingImageConfig

      default AlgorithmSpecification.Builder trainingImageConfig(Consumer<TrainingImageConfig.Builder> trainingImageConfig)

      The configuration to use an image from a private Docker registry for a training job.

      This is a convenience method that creates an instance of the TrainingImageConfig.Builder avoiding the need to create one manually via TrainingImageConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to trainingImageConfig(TrainingImageConfig).

      Parameters:
      trainingImageConfig - a consumer that will call methods on TrainingImageConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: