Class ProfilerConfig
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ProfilerConfig.Builder,
ProfilerConfig>
Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ProfilerConfig.Builder
builder()
final Boolean
Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ProfilingParameters property.final Long
A time interval for capturing system metrics in milliseconds.Configuration information for capturing framework metrics.final String
Path to Amazon S3 storage location for system and framework metrics.static Class
<? extends ProfilerConfig.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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 theisEmpty()
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
Configuration information for capturing framework metrics. Available key strings for different profiling options are
DetailedProfilingConfig
,PythonProfilingConfig
, andDataLoaderProfilingConfig
. The following codes are configuration structures for theProfilingParameters
parameter. To learn more about how to configure theProfilingParameters
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
, andDataLoaderProfilingConfig
. The following codes are configuration structures for theProfilingParameters
parameter. To learn more about how to configure theProfilingParameters
parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
-
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ProfilerConfig.Builder,
ProfilerConfig> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-