Class: Aws::SageMaker::Types::ProfilerRuleConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::ProfilerRuleConfiguration

Defined in:

gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

Note:

When making an API call, you may pass ProfilerRuleConfiguration 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 profiling rules.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #instance_type ⇒ String

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

• #local_path ⇒ String

  Path to local storage location for output of rules.

• #rule_configuration_name ⇒ String

  The name of the rule configuration.

• #rule_evaluator_image ⇒ String

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

• #rule_parameters ⇒ Hash<String,String>

  Runtime configuration for rule container.

• #s3_output_path ⇒ String

  Path to Amazon S3 storage location for rules.

• #volume_size_in_gb ⇒ Integer

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

Instance Attribute Details

#instance_type ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 29300

class ProfilerRuleConfiguration < 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_path ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 29300

class ProfilerRuleConfiguration < 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_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 29300

class ProfilerRuleConfiguration < 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_image ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 29300

class ProfilerRuleConfiguration < 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_parameters ⇒ Hash<String,String>

Runtime configuration for rule container.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 29300

class ProfilerRuleConfiguration < 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_path ⇒ String

Path to Amazon S3 storage location for rules.

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 29300

class ProfilerRuleConfiguration < 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_gb ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 29300

class ProfilerRuleConfiguration < 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