Interface ProfilerConfig.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ProfilerConfig.Builder,ProfilerConfig>, SdkBuilder<ProfilerConfig.Builder,ProfilerConfig>, SdkPojo

Enclosing class:

ProfilerConfig

@Mutable
@NotThreadSafe
public static interface ProfilerConfig.Builder
extends SdkPojo, CopyableBuilder<ProfilerConfig.Builder,ProfilerConfig>

Method Summary

Modifier and Type	Method	Description
ProfilerConfig.Builder	disableProfiler(Boolean disableProfiler)	Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality.
ProfilerConfig.Builder	profilingIntervalInMilliseconds(Long profilingIntervalInMilliseconds)	A time interval for capturing system metrics in milliseconds.
ProfilerConfig.Builder	profilingParameters(Map<String,String> profilingParameters)	Configuration information for capturing framework metrics.
ProfilerConfig.Builder	s3OutputPath(String s3OutputPath)	Path to Amazon S3 storage location for system and framework metrics.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

s3OutputPath

ProfilerConfig.Builder s3OutputPath(String s3OutputPath)

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

Parameters:

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

Returns:

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

profilingIntervalInMilliseconds

ProfilerConfig.Builder profilingIntervalInMilliseconds(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.

Parameters:

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:

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

profilingParameters

ProfilerConfig.Builder profilingParameters(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.

Parameters:

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.

Returns:

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

disableProfiler

ProfilerConfig.Builder disableProfiler(Boolean disableProfiler)

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

Parameters:

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

Returns:

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