software.amazon.awssdk.services.sagemaker.model

Class DebugHookConfig

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.DebugHookConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DebugHookConfig.Builder,DebugHookConfig>

@Generated(value="software.amazon.awssdk:codegen")
public final class DebugHookConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DebugHookConfig.Builder,DebugHookConfig>

Configuration information for the 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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DebugHookConfig.Builder

Method Summary

Modifier and Type	Method and Description
static DebugHookConfig.Builder	builder()
List<CollectionConfiguration>	collectionConfigurations() Configuration information for Debugger tensor collections.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCollectionConfigurations() For responses, this returns true if the service returned a value for the CollectionConfigurations property.
int	hashCode()
boolean	hasHookParameters() For responses, this returns true if the service returned a value for the HookParameters property.
Map<String,String>	hookParameters() Configuration information for the Debugger hook parameters.
String	localPath() Path to local storage location for metrics and tensors.
String	s3OutputPath() Path to Amazon S3 storage location for metrics and tensors.
List<SdkField<?>>	sdkFields()
static Class<? extends DebugHookConfig.Builder>	serializableBuilderClass()
DebugHookConfig.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

localPath

public final String 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

public final String 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 the isEmpty() 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

public final Map<String,String> hookParameters()

Configuration information for the 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 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 the isEmpty() 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

public final List<CollectionConfiguration> collectionConfigurations()

Configuration information for 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 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

public DebugHookConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DebugHookConfig.Builder,DebugHookConfig>

builder

public static DebugHookConfig.Builder builder()

serializableBuilderClass

public static Class<? extends DebugHookConfig.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo