Struct DebugHookConfig

#[non_exhaustive]
pub struct DebugHookConfig {
    pub local_path: Option<String>,
    pub s3_output_path: Option<String>,
    pub hook_parameters: Option<HashMap<String, String>>,
    pub collection_configurations: Option<Vec<CollectionConfiguration>>,
}

Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and storage paths. To learn more about how to configure the DebugHookConfig 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.

local_path: Option<String>

Path to local storage location for metrics and tensors. Defaults to /opt/ml/output/tensors/.

s3_output_path: Option<String>

Path to Amazon S3 storage location for metrics and tensors.

hook_parameters: Option<HashMap<String, String>>

Configuration information for the Amazon SageMaker Debugger hook parameters.

collection_configurations: Option<Vec<CollectionConfiguration>>

Configuration information for Amazon SageMaker Debugger tensor collections. To learn more about how to configure the CollectionConfiguration parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

Implementations

impl DebugHookConfig

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

Path to local storage location for metrics and tensors. Defaults to /opt/ml/output/tensors/.

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

Path to Amazon S3 storage location for metrics and tensors.

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

Configuration information for the Amazon SageMaker Debugger hook parameters.

pub fn collection_configurations(&self) -> &[CollectionConfiguration]

Configuration information for Amazon SageMaker Debugger tensor collections. To learn more about how to configure the CollectionConfiguration parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .collection_configurations.is_none().

impl DebugHookConfig

pub fn builder() -> DebugHookConfigBuilder

Creates a new builder-style object to manufacture DebugHookConfig.

Trait Implementations

impl Clone for DebugHookConfig

fn clone(&self) -> DebugHookConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DebugHookConfig

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

Formats the value using the given formatter.

impl PartialEq for DebugHookConfig

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