Class Algorithm
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Algorithm.Builder,
Algorithm>
Describes a custom algorithm.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The Amazon Resource Name (ARN) of the algorithm.final AlgorithmImage
The URI of the Docker container for the algorithm image.static Algorithm.Builder
builder()
final Instant
The date and time (in Unix time) that the algorithm was created.Specifies the default hyperparameters, their ranges, and whether they are tunable.Specifies the default hyperparameters.Specifies the default maximum number of training jobs and parallel training jobs.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 DefaultHyperParameters property.final boolean
For responses, this returns true if the service returned a value for the DefaultResourceConfig property.final int
hashCode()
final Instant
The date and time (in Unix time) that the algorithm was last updated.final String
name()
The name of the algorithm.final String
roleArn()
The Amazon Resource Name (ARN) of the role.static Class
<? extends Algorithm.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 training input mode.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the algorithm.
- Returns:
- The name of the algorithm.
-
algorithmArn
The Amazon Resource Name (ARN) of the algorithm.
- Returns:
- The Amazon Resource Name (ARN) of the algorithm.
-
algorithmImage
The URI of the Docker container for the algorithm image.
- Returns:
- The URI of the Docker container for the algorithm image.
-
hasDefaultHyperParameters
public final boolean hasDefaultHyperParameters()For responses, this returns true if the service returned a value for the DefaultHyperParameters 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. -
defaultHyperParameters
Specifies the default hyperparameters.
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
hasDefaultHyperParameters()
method.- Returns:
- Specifies the default hyperparameters.
-
defaultHyperParameterRanges
Specifies the default hyperparameters, their ranges, and whether they are tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).
- Returns:
- Specifies the default hyperparameters, their ranges, and whether they are tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).
-
hasDefaultResourceConfig
public final boolean hasDefaultResourceConfig()For responses, this returns true if the service returned a value for the DefaultResourceConfig 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. -
defaultResourceConfig
Specifies the default maximum number of training jobs and parallel training jobs.
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
hasDefaultResourceConfig()
method.- Returns:
- Specifies the default maximum number of training jobs and parallel training jobs.
-
trainingInputMode
The training input mode.
- Returns:
- The training input mode.
-
roleArn
The Amazon Resource Name (ARN) of the role.
- Returns:
- The Amazon Resource Name (ARN) of the role.
-
creationDateTime
The date and time (in Unix time) that the algorithm was created.
- Returns:
- The date and time (in Unix time) that the algorithm was created.
-
lastUpdatedDateTime
The date and time (in Unix time) that the algorithm was last updated.
- Returns:
- The date and time (in Unix time) that the algorithm was last updated.
-
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<Algorithm.Builder,
Algorithm> - 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
-