Skip to content

DebugRuleConfiguration

Source code in docs_src/capo_sagemaker/types/debug_rule_configuration.py
class DebugRuleConfiguration(TypedDict, closed=True):
    rule_configuration_name: NotRequired[
        "capo_sagemaker.types.rule_configuration_name.RuleConfigurationName"
    ]
    """<p>The name of the rule configuration. It must be unique relative to other rule configuration names.</p>"""
    local_path: NotRequired["capo_sagemaker.types.directory_path.DirectoryPath"]
    """<p>Path to local storage location for output of rules. Defaults to <code>/opt/ml/processing/output/rule/</code>.</p>"""
    s3_output_path: NotRequired["capo_sagemaker.types.s3_uri.S3Uri"]
    """<p>Path to Amazon S3 storage location for rules.</p>"""
    rule_evaluator_image: NotRequired[
        "capo_sagemaker.types.algorithm_image.AlgorithmImage"
    ]
    """<p>The Amazon Elastic Container (ECR) Image for the managed rule evaluation.</p>"""
    instance_type: NotRequired[
        "capo_sagemaker.types.processing_instance_type.ProcessingInstanceType"
    ]
    """<p>The instance type to deploy a custom rule for debugging a training job.</p>"""
    volume_size_in_gb: NotRequired[
        "capo_sagemaker.types.optional_volume_size_in_gb.OptionalVolumeSizeInGB"
    ]
    """<p>The size, in GB, of the ML storage volume attached to the processing instance.</p>"""
    rule_parameters: NotRequired["capo_sagemaker.types.rule_parameters.RuleParameters"]
    """<p>Runtime configuration for rule container.</p>"""

instance_type instance-attribute

instance_type: NotRequired[ProcessingInstanceType]

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

local_path instance-attribute

local_path: NotRequired[DirectoryPath]

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

rule_configuration_name instance-attribute

rule_configuration_name: NotRequired[RuleConfigurationName]

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

rule_evaluator_image instance-attribute

rule_evaluator_image: NotRequired[AlgorithmImage]

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

rule_parameters instance-attribute

rule_parameters: NotRequired[RuleParameters]

Runtime configuration for rule container.

s3_output_path instance-attribute

s3_output_path: NotRequired[S3Uri]

Path to Amazon S3 storage location for rules.

volume_size_in_gb instance-attribute

volume_size_in_gb: NotRequired[OptionalVolumeSizeInGB]

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