Package software.amazon.awssdk.services.sagemaker.model

Class ProfilerConfig

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.ProfilerConfig

All Implemented Interfaces:

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

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

Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ProfilerConfig.Builder

Method Summary

Modifier and Type	Method	Description
static ProfilerConfig.Builder	builder()
Boolean	disableProfiler()	Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasProfilingParameters()	For responses, this returns true if the service returned a value for the ProfilingParameters property.
Long	profilingIntervalInMilliseconds()	A time interval for capturing system metrics in milliseconds.
Map<String,String>	profilingParameters()	Configuration information for capturing framework metrics.
String	s3OutputPath()	Path to Amazon S3 storage location for system and framework metrics.
List<SdkField<?>>	sdkFields()
static Class<? extends ProfilerConfig.Builder>	serializableBuilderClass()
ProfilerConfig.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

s3OutputPath

public final String s3OutputPath()

Path to Amazon S3 storage location for system and framework metrics.

Returns:

Path to Amazon S3 storage location for system and framework metrics.

profilingIntervalInMilliseconds

public final Long profilingIntervalInMilliseconds()

A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.

Returns:

A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.

hasProfilingParameters

public final boolean hasProfilingParameters()

For responses, this returns true if the service returned a value for the ProfilingParameters 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.

profilingParameters

public final Map<String,String> profilingParameters()

Configuration information for capturing framework metrics. Available key strings for different profiling options are DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are configuration structures for the ProfilingParameters parameter. To learn more about how to configure the ProfilingParameters 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 hasProfilingParameters() method.

Returns:

Configuration information for capturing framework metrics. Available key strings for different profiling options are DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are configuration structures for the ProfilingParameters parameter. To learn more about how to configure the ProfilingParameters parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

disableProfiler

public final Boolean disableProfiler()

Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality. To turn it off, set to True.

Returns:

Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality. To turn it off, set to True.

toBuilder

public ProfilerConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ProfilerConfig.Builder,ProfilerConfig>

builder

public static ProfilerConfig.Builder builder()

serializableBuilderClass

public static Class<? extends ProfilerConfig.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