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() Returns true if the CollectionConfigurations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasHookParameters() Returns true if the HookParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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()

Returns true if the HookParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasHookParameters() to see if a value was sent in this field.

Returns:

Configuration information for the Debugger hook parameters.

hasCollectionConfigurations

public final boolean hasCollectionConfigurations()

Returns true if the CollectionConfigurations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasCollectionConfigurations() to see if a value was sent in this field.

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