AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::SageMaker::Types::DebugRuleConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

Note:

When making an API call, you may pass DebugRuleConfiguration data as a hash:

{
  rule_configuration_name: "RuleConfigurationName", # required
  local_path: "DirectoryPath",
  s3_output_path: "S3Uri",
  rule_evaluator_image: "AlgorithmImage", # required
  instance_type: "ml.t3.medium", # accepts ml.t3.medium, ml.t3.large, ml.t3.xlarge, ml.t3.2xlarge, ml.m4.xlarge, ml.m4.2xlarge, ml.m4.4xlarge, ml.m4.10xlarge, ml.m4.16xlarge, ml.c4.xlarge, ml.c4.2xlarge, ml.c4.4xlarge, ml.c4.8xlarge, ml.p2.xlarge, ml.p2.8xlarge, ml.p2.16xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.18xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.12xlarge, ml.m5.24xlarge, ml.r5.large, ml.r5.xlarge, ml.r5.2xlarge, ml.r5.4xlarge, ml.r5.8xlarge, ml.r5.12xlarge, ml.r5.16xlarge, ml.r5.24xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge
  volume_size_in_gb: 1,
  rule_parameters: {
    "ConfigKey" => "ConfigValue",
  },
}

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#instance_typeString

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

Returns:

  • (String)


10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10528

class DebugRuleConfiguration < Struct.new(
  :rule_configuration_name,
  :local_path,
  :s3_output_path,
  :rule_evaluator_image,
  :instance_type,
  :volume_size_in_gb,
  :rule_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#local_pathString

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

Returns:

  • (String)


10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10528

class DebugRuleConfiguration < Struct.new(
  :rule_configuration_name,
  :local_path,
  :s3_output_path,
  :rule_evaluator_image,
  :instance_type,
  :volume_size_in_gb,
  :rule_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#rule_configuration_nameString

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

Returns:

  • (String)


10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10528

class DebugRuleConfiguration < Struct.new(
  :rule_configuration_name,
  :local_path,
  :s3_output_path,
  :rule_evaluator_image,
  :instance_type,
  :volume_size_in_gb,
  :rule_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#rule_evaluator_imageString

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

Returns:

  • (String)


10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10528

class DebugRuleConfiguration < Struct.new(
  :rule_configuration_name,
  :local_path,
  :s3_output_path,
  :rule_evaluator_image,
  :instance_type,
  :volume_size_in_gb,
  :rule_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#rule_parametersHash<String,String>

Runtime configuration for rule container.

Returns:

  • (Hash<String,String>)


10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10528

class DebugRuleConfiguration < Struct.new(
  :rule_configuration_name,
  :local_path,
  :s3_output_path,
  :rule_evaluator_image,
  :instance_type,
  :volume_size_in_gb,
  :rule_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#s3_output_pathString

Path to Amazon S3 storage location for rules.

Returns:

  • (String)


10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10528

class DebugRuleConfiguration < Struct.new(
  :rule_configuration_name,
  :local_path,
  :s3_output_path,
  :rule_evaluator_image,
  :instance_type,
  :volume_size_in_gb,
  :rule_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#volume_size_in_gbInteger

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

Returns:

  • (Integer)


10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10528

class DebugRuleConfiguration < Struct.new(
  :rule_configuration_name,
  :local_path,
  :s3_output_path,
  :rule_evaluator_image,
  :instance_type,
  :volume_size_in_gb,
  :rule_parameters)
  SENSITIVE = []
  include Aws::Structure
end