Class AlgorithmSpecification
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AlgorithmSpecification.Builder,
AlgorithmSpecification>
Specifies the training algorithm to use in a CreateTrainingJob request.
For more information about algorithms provided by SageMaker, see Algorithms. For information about using your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The name of the algorithm resource to use for the training job.builder()
The arguments for a container used to run a training job.The entrypoint script for a Docker container used to run a training job.final Boolean
To generate and save time-series metrics during training, set totrue
.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the ContainerArguments property.final boolean
For responses, this returns true if the service returned a value for the ContainerEntrypoint property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the MetricDefinitions property.final List
<MetricDefinition> A list of metric definition objects.static Class
<? extends AlgorithmSpecification.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The registry path of the Docker image that contains the training algorithm.final TrainingImageConfig
The configuration to use an image from a private Docker registry for a training job.final TrainingInputMode
Returns the value of the TrainingInputMode property for this object.final String
Returns the value of the TrainingInputMode property for this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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]
andregistry/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 theTrainingImage
parameter.For more information, see the note in the
AlgorithmName
parameter description.- Returns:
- 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]
andregistry/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 theTrainingImage
parameter.For more information, see the note in the
AlgorithmName
parameter description.
-
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 theTrainingImage
parameter.Note that the
AlgorithmName
parameter is mutually exclusive with theTrainingImage
parameter. If you specify a value for theAlgorithmName
parameter, you can't specify a value forTrainingImage
, 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:
- 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 theTrainingImage
parameter.Note that the
AlgorithmName
parameter is mutually exclusive with theTrainingImage
parameter. If you specify a value for theAlgorithmName
parameter, you can't specify a value forTrainingImage
, 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.
-
trainingInputMode
Returns the value of the TrainingInputMode property for this object.If the service returns an enum value that is not available in the current SDK version,
trainingInputMode
will returnTrainingInputMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtrainingInputModeAsString()
.- Returns:
- The value of the TrainingInputMode property for this object.
- See Also:
-
trainingInputModeAsString
Returns the value of the TrainingInputMode property for this object.If the service returns an enum value that is not available in the current SDK version,
trainingInputMode
will returnTrainingInputMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtrainingInputModeAsString()
.- Returns:
- The value of the TrainingInputMode property for this object.
- See Also:
-
hasMetricDefinitions
public final boolean hasMetricDefinitions()For responses, this returns true if the service returned a value for the MetricDefinitions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.
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
hasMetricDefinitions()
method.- Returns:
- 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.
-
enableSageMakerMetricsTimeSeries
To generate and save time-series metrics during training, set to
true
. The default isfalse
and time-series metrics aren't generated except in the following cases:-
You use one of the SageMaker built-in algorithms
-
You use one of the following Prebuilt SageMaker Docker Images:
-
Tensorflow (version >= 1.15)
-
MXNet (version >= 1.6)
-
PyTorch (version >= 1.3)
-
-
You specify at least one MetricDefinition
- Returns:
- To generate and save time-series metrics during training, set to
true
. The default isfalse
and time-series metrics aren't generated except in the following cases:-
You use one of the SageMaker built-in algorithms
-
You use one of the following Prebuilt SageMaker Docker Images:
-
Tensorflow (version >= 1.15)
-
MXNet (version >= 1.6)
-
PyTorch (version >= 1.3)
-
-
You specify at least one MetricDefinition
-
-
-
hasContainerEntrypoint
public final boolean hasContainerEntrypoint()For responses, this returns true if the service returned a value for the ContainerEntrypoint property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.
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
hasContainerEntrypoint()
method.- Returns:
- 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.
-
hasContainerArguments
public final boolean hasContainerArguments()For responses, this returns true if the service returned a value for the ContainerArguments property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
containerArguments
The arguments for a container used to run a training job. See How Amazon SageMaker Runs Your Training Image for additional information.
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
hasContainerArguments()
method.- Returns:
- The arguments for a container used to run a training job. See How Amazon SageMaker Runs Your Training Image for additional information.
-
trainingImageConfig
The configuration to use an image from a private Docker registry for a training job.
- Returns:
- The configuration to use an image from a private Docker registry for a training job.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<AlgorithmSpecification.Builder,
AlgorithmSpecification> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-