Class DebugHookConfig
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DebugHookConfig.Builder,
DebugHookConfig>
Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and
storage paths. To learn more about how to configure the DebugHookConfig
parameter, see Use the SageMaker and
Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic DebugHookConfig.Builder
builder()
final List
<CollectionConfiguration> Configuration information for Amazon SageMaker Debugger tensor collections.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 CollectionConfigurations property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the HookParameters property.Configuration information for the Amazon SageMaker Debugger hook parameters.final String
Path to local storage location for metrics and tensors.final String
Path to Amazon S3 storage location for metrics and tensors.static Class
<? extends DebugHookConfig.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
localPath
Path to local storage location for metrics and tensors. Defaults to
/opt/ml/output/tensors/
.- Returns:
- Path to local storage location for metrics and tensors. Defaults to
/opt/ml/output/tensors/
.
-
s3OutputPath
Path to Amazon S3 storage location for metrics and tensors.
- Returns:
- Path to Amazon S3 storage location for metrics and tensors.
-
hasHookParameters
public final boolean hasHookParameters()For responses, this returns true if the service returned a value for the HookParameters 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. -
hookParameters
Configuration information for the Amazon SageMaker Debugger hook parameters.
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
hasHookParameters()
method.- Returns:
- Configuration information for the Amazon SageMaker Debugger hook parameters.
-
hasCollectionConfigurations
public final boolean hasCollectionConfigurations()For responses, this returns true if the service returned a value for the CollectionConfigurations 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. -
collectionConfigurations
Configuration information for Amazon SageMaker Debugger tensor collections. To learn more about how to configure the
CollectionConfiguration
parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.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
hasCollectionConfigurations()
method.- Returns:
- Configuration information for Amazon SageMaker Debugger tensor collections. To learn more about how to
configure the
CollectionConfiguration
parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your 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<DebugHookConfig.Builder,
DebugHookConfig> - 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
-