com.amazonaws.services.sagemaker.model

Class DebugHookConfig

java.lang.Object

com.amazonaws.services.sagemaker.model.DebugHookConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DebugHookConfig
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DebugHookConfig()

Method Summary

Modifier and Type	Method and Description
DebugHookConfig	addHookParametersEntry(String key, String value) Add a single HookParameters entry
DebugHookConfig	clearHookParametersEntries() Removes all the entries added into HookParameters.
DebugHookConfig	clone()
boolean	equals(Object obj)
List<CollectionConfiguration>	getCollectionConfigurations() Configuration information for Debugger tensor collections.
Map<String,String>	getHookParameters() Configuration information for the Debugger hook parameters.
String	getLocalPath() Path to local storage location for metrics and tensors.
String	getS3OutputPath() Path to Amazon S3 storage location for metrics and tensors.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setCollectionConfigurations(Collection<CollectionConfiguration> collectionConfigurations) Configuration information for Debugger tensor collections.
void	setHookParameters(Map<String,String> hookParameters) Configuration information for the Debugger hook parameters.
void	setLocalPath(String localPath) Path to local storage location for metrics and tensors.
void	setS3OutputPath(String s3OutputPath) Path to Amazon S3 storage location for metrics and tensors.
String	toString() Returns a string representation of this object.
DebugHookConfig	withCollectionConfigurations(Collection<CollectionConfiguration> collectionConfigurations) Configuration information for Debugger tensor collections.
DebugHookConfig	withCollectionConfigurations(CollectionConfiguration... collectionConfigurations) Configuration information for Debugger tensor collections.
DebugHookConfig	withHookParameters(Map<String,String> hookParameters) Configuration information for the Debugger hook parameters.
DebugHookConfig	withLocalPath(String localPath) Path to local storage location for metrics and tensors.
DebugHookConfig	withS3OutputPath(String s3OutputPath) Path to Amazon S3 storage location for metrics and tensors.

Methods inherited from class java.lang.Object

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

Constructor Detail

DebugHookConfig

public DebugHookConfig()

Method Detail

setLocalPath

public void setLocalPath(String localPath)

Path to local storage location for metrics and tensors. Defaults to /opt/ml/output/tensors/.

Parameters:

localPath - Path to local storage location for metrics and tensors. Defaults to /opt/ml/output/tensors/.

getLocalPath

public String getLocalPath()

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/.

withLocalPath

public DebugHookConfig withLocalPath(String localPath)

Path to local storage location for metrics and tensors. Defaults to /opt/ml/output/tensors/.

Parameters:

localPath - Path to local storage location for metrics and tensors. Defaults to /opt/ml/output/tensors/.

Returns:

Returns a reference to this object so that method calls can be chained together.

setS3OutputPath

public void setS3OutputPath(String s3OutputPath)

Path to Amazon S3 storage location for metrics and tensors.

Parameters:

s3OutputPath - Path to Amazon S3 storage location for metrics and tensors.

getS3OutputPath

public String getS3OutputPath()

Path to Amazon S3 storage location for metrics and tensors.

Returns:

Path to Amazon S3 storage location for metrics and tensors.

withS3OutputPath

public DebugHookConfig withS3OutputPath(String s3OutputPath)

Path to Amazon S3 storage location for metrics and tensors.

Parameters:

s3OutputPath - Path to Amazon S3 storage location for metrics and tensors.

Returns:

Returns a reference to this object so that method calls can be chained together.

getHookParameters

public Map<String,String> getHookParameters()

Configuration information for the Debugger hook parameters.

Returns:

Configuration information for the Debugger hook parameters.

setHookParameters

public void setHookParameters(Map<String,String> hookParameters)

Configuration information for the Debugger hook parameters.

Parameters:

hookParameters - Configuration information for the Debugger hook parameters.

withHookParameters

public DebugHookConfig withHookParameters(Map<String,String> hookParameters)

Configuration information for the Debugger hook parameters.

Parameters:

hookParameters - Configuration information for the Debugger hook parameters.

Returns:

Returns a reference to this object so that method calls can be chained together.

addHookParametersEntry

public DebugHookConfig addHookParametersEntry(String key,
                                              String value)

Add a single HookParameters entry

See Also:

withHookParameters(java.util.Map<java.lang.String, java.lang.String>)

clearHookParametersEntries

public DebugHookConfig clearHookParametersEntries()

Removes all the entries added into HookParameters.

Returns:

Returns a reference to this object so that method calls can be chained together.

getCollectionConfigurations

public List<CollectionConfiguration> getCollectionConfigurations()

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.

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.

setCollectionConfigurations

public void setCollectionConfigurations(Collection<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.

Parameters:

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.

withCollectionConfigurations

public DebugHookConfig withCollectionConfigurations(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.

NOTE: This method appends the values to the existing list (if any). Use setCollectionConfigurations(java.util.Collection) or withCollectionConfigurations(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withCollectionConfigurations

public DebugHookConfig withCollectionConfigurations(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DebugHookConfig clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo