Struct ProfilerConfigForUpdate

#[non_exhaustive]
pub struct ProfilerConfigForUpdate {
    pub s3_output_path: Option<String>,
    pub profiling_interval_in_milliseconds: Option<i64>,
    pub profiling_parameters: Option<HashMap<String, String>>,
    pub disable_profiler: Option<bool>,
}

Configuration information for updating the Amazon SageMaker Debugger profile parameters, system and framework metrics configurations, and storage paths.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

s3_output_path: Option<String>

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

profiling_interval_in_milliseconds: Option<i64>

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.

profiling_parameters: Option<HashMap<String, String>>

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.

disable_profiler: Option<bool>

To turn off Amazon SageMaker Debugger monitoring and profiling while a training job is in progress, set to True.

Implementations

impl ProfilerConfigForUpdate

pub fn s3_output_path(&self) -> Option<&str>

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

pub fn profiling_interval_in_milliseconds(&self) -> Option<i64>

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.

pub fn profiling_parameters(&self) -> Option<&HashMap<String, String>>

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.

pub fn disable_profiler(&self) -> Option<bool>

To turn off Amazon SageMaker Debugger monitoring and profiling while a training job is in progress, set to True.

impl ProfilerConfigForUpdate

pub fn builder() -> ProfilerConfigForUpdateBuilder

Creates a new builder-style object to manufacture ProfilerConfigForUpdate.

Trait Implementations

impl Clone for ProfilerConfigForUpdate

fn clone(&self) -> ProfilerConfigForUpdate

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProfilerConfigForUpdate

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ProfilerConfigForUpdate

fn eq(&self, other: &ProfilerConfigForUpdate) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ProfilerConfigForUpdate