Struct DebugRuleConfiguration

#[non_exhaustive]
pub struct DebugRuleConfiguration {
    pub rule_configuration_name: Option<String>,
    pub local_path: Option<String>,
    pub s3_output_path: Option<String>,
    pub rule_evaluator_image: Option<String>,
    pub instance_type: Option<ProcessingInstanceType>,
    pub volume_size_in_gb: Option<i32>,
    pub rule_parameters: Option<HashMap<String, String>>,
}

Configuration information for SageMaker Debugger rules for debugging. To learn more about how to configure the DebugRuleConfiguration parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

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.

rule_configuration_name: Option<String>

The name of the rule configuration. It must be unique relative to other rule configuration names.

local_path: Option<String>

Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.

s3_output_path: Option<String>

Path to Amazon S3 storage location for rules.

rule_evaluator_image: Option<String>

The Amazon Elastic Container (ECR) Image for the managed rule evaluation.

instance_type: Option<ProcessingInstanceType>

The instance type to deploy a custom rule for debugging a training job.

volume_size_in_gb: Option<i32>

The size, in GB, of the ML storage volume attached to the processing instance.

rule_parameters: Option<HashMap<String, String>>

Runtime configuration for rule container.

Implementations

impl DebugRuleConfiguration

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

The name of the rule configuration. It must be unique relative to other rule configuration names.

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

Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.

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

Path to Amazon S3 storage location for rules.

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

The Amazon Elastic Container (ECR) Image for the managed rule evaluation.

pub fn instance_type(&self) -> Option<&ProcessingInstanceType>

The instance type to deploy a custom rule for debugging a training job.

pub fn volume_size_in_gb(&self) -> Option<i32>

The size, in GB, of the ML storage volume attached to the processing instance.

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

Runtime configuration for rule container.

impl DebugRuleConfiguration

pub fn builder() -> DebugRuleConfigurationBuilder

Creates a new builder-style object to manufacture DebugRuleConfiguration.

Trait Implementations

impl Clone for DebugRuleConfiguration

fn clone(&self) -> DebugRuleConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DebugRuleConfiguration

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

Formats the value using the given formatter.

impl PartialEq for DebugRuleConfiguration

fn eq(&self, other: &DebugRuleConfiguration) -> 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 DebugRuleConfiguration