Class: AWSCDK::Sagemaker::CfnModelBiasJobDefinition::EndpointInputProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
sagemaker/cfn_model_bias_job_definition.rb

Overview

Input object for the endpoint.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(endpoint_name:, local_path:, end_time_offset: nil, features_attribute: nil, inference_attribute: nil, probability_attribute: nil, probability_threshold_attribute: nil, s3_data_distribution_type: nil, s3_input_mode: nil, start_time_offset: nil) ⇒ EndpointInputProperty

Returns a new instance of EndpointInputProperty.

Parameters:

  • endpoint_name (String) —

    An endpoint in customer's account which has enabled DataCaptureConfig enabled.

  • local_path (String) —

    Path to the filesystem where the endpoint data is available to the container.

  • end_time_offset (String, nil) (defaults to: nil) —

    If specified, monitoring jobs substract this time from the end time.

  • features_attribute (String, nil) (defaults to: nil) —

    The attributes of the input data that are the input features.

  • inference_attribute (String, nil) (defaults to: nil) —

    The attribute of the input data that represents the ground truth label.

  • probability_attribute (String, nil) (defaults to: nil) —

    In a classification problem, the attribute that represents the class probability.

  • probability_threshold_attribute (Numeric, nil) (defaults to: nil) —

    The threshold for the class probability to be evaluated as a positive result.

  • s3_data_distribution_type (String, nil) (defaults to: nil) —

    Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key.

  • s3_input_mode (String, nil) (defaults to: nil) —

    Whether the Pipe or File is used as the input mode for transferring data for the monitoring job.

  • start_time_offset (String, nil) (defaults to: nil) —

    If specified, monitoring jobs substract this time from the start time.



991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
 
# File 'sagemaker/cfn_model_bias_job_definition.rb', line 991

def initialize(endpoint_name:, local_path:, end_time_offset: nil, features_attribute: nil, inference_attribute: nil, probability_attribute: nil, probability_threshold_attribute: nil, s3_data_distribution_type: nil, s3_input_mode: nil, start_time_offset: nil)
  @endpoint_name = endpoint_name
  Jsii::Type.check_type(@endpoint_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "endpointName")
  @local_path = local_path
  Jsii::Type.check_type(@local_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "localPath")
  @end_time_offset = end_time_offset
  Jsii::Type.check_type(@end_time_offset, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "endTimeOffset") unless @end_time_offset.nil?
  @features_attribute = features_attribute
  Jsii::Type.check_type(@features_attribute, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "featuresAttribute") unless @features_attribute.nil?
  @inference_attribute = inference_attribute
  Jsii::Type.check_type(@inference_attribute, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "inferenceAttribute") unless @inference_attribute.nil?
  @probability_attribute = probability_attribute
  Jsii::Type.check_type(@probability_attribute, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "probabilityAttribute") unless @probability_attribute.nil?
  @probability_threshold_attribute = probability_threshold_attribute
  Jsii::Type.check_type(@probability_threshold_attribute, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "probabilityThresholdAttribute") unless @probability_threshold_attribute.nil?
  @s3_data_distribution_type = s3_data_distribution_type
  Jsii::Type.check_type(@s3_data_distribution_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3DataDistributionType") unless @s3_data_distribution_type.nil?
  @s3_input_mode = s3_input_mode
  Jsii::Type.check_type(@s3_input_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3InputMode") unless @s3_input_mode.nil?
  @start_time_offset = start_time_offset
  Jsii::Type.check_type(@start_time_offset, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "startTimeOffset") unless @start_time_offset.nil?
end

Instance Attribute Details

#end_time_offset ⇒ String? (readonly)

If specified, monitoring jobs substract this time from the end time.

For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs .

Returns:

  • (String, nil)

See Also:



1030
1031
1032
 
# File 'sagemaker/cfn_model_bias_job_definition.rb', line 1030

def end_time_offset
  @end_time_offset
end

#endpoint_name ⇒ String (readonly)

An endpoint in customer's account which has enabled DataCaptureConfig enabled.

Returns:

  • (String)

See Also:



1018
1019
1020
 
# File 'sagemaker/cfn_model_bias_job_definition.rb', line 1018

def endpoint_name
  @endpoint_name
end

#features_attribute ⇒ String? (readonly)

The attributes of the input data that are the input features.

Returns:

  • (String, nil)

See Also:



1035
1036
1037
 
# File 'sagemaker/cfn_model_bias_job_definition.rb', line 1035

def features_attribute
  @features_attribute
end

#inference_attribute ⇒ String? (readonly)

The attribute of the input data that represents the ground truth label.

Returns:

  • (String, nil)

See Also:



1040
1041
1042
 
# File 'sagemaker/cfn_model_bias_job_definition.rb', line 1040

def inference_attribute
  @inference_attribute
end

#local_path ⇒ String (readonly)

Path to the filesystem where the endpoint data is available to the container.

Returns:

  • (String)

See Also:



1023
1024
1025
 
# File 'sagemaker/cfn_model_bias_job_definition.rb', line 1023

def local_path
  @local_path
end

#probability_attribute ⇒ String? (readonly)

In a classification problem, the attribute that represents the class probability.

Returns:

  • (String, nil)

See Also:



1045
1046
1047
 
# File 'sagemaker/cfn_model_bias_job_definition.rb', line 1045

def probability_attribute
  @probability_attribute
end

#probability_threshold_attribute ⇒ Numeric? (readonly)

The threshold for the class probability to be evaluated as a positive result.

Returns:

  • (Numeric, nil)

See Also:



1050
1051
1052
 
# File 'sagemaker/cfn_model_bias_job_definition.rb', line 1050

def probability_threshold_attribute
  @probability_threshold_attribute
end

#s3_data_distribution_type ⇒ String? (readonly)

Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key.

Defaults to FullyReplicated

Returns:

  • (String, nil)

See Also:



1057
1058
1059
 
# File 'sagemaker/cfn_model_bias_job_definition.rb', line 1057

def s3_data_distribution_type
  @s3_data_distribution_type
end

#s3_input_mode ⇒ String? (readonly)

Whether the Pipe or File is used as the input mode for transferring data for the monitoring job.

Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File .

Returns:

  • (String, nil)

See Also:



1064
1065
1066
 
# File 'sagemaker/cfn_model_bias_job_definition.rb', line 1064

def s3_input_mode
  @s3_input_mode
end

#start_time_offset ⇒ String? (readonly)

If specified, monitoring jobs substract this time from the start time.

For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs .

Returns:

  • (String, nil)

See Also:



1071
1072
1073
 
# File 'sagemaker/cfn_model_bias_job_definition.rb', line 1071

def start_time_offset
  @start_time_offset
end

Class Method Details

.jsii_properties ⇒ Object 



1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
 
# File 'sagemaker/cfn_model_bias_job_definition.rb', line 1073

def self.jsii_properties
  {
    :endpoint_name => "endpointName",
    :local_path => "localPath",
    :end_time_offset => "endTimeOffset",
    :features_attribute => "featuresAttribute",
    :inference_attribute => "inferenceAttribute",
    :probability_attribute => "probabilityAttribute",
    :probability_threshold_attribute => "probabilityThresholdAttribute",
    :s3_data_distribution_type => "s3DataDistributionType",
    :s3_input_mode => "s3InputMode",
    :start_time_offset => "startTimeOffset",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
 
# File 'sagemaker/cfn_model_bias_job_definition.rb', line 1088

def to_jsii
  result = {}
  result.merge!({
    "endpointName" => @endpoint_name,
    "localPath" => @local_path,
    "endTimeOffset" => @end_time_offset,
    "featuresAttribute" => @features_attribute,
    "inferenceAttribute" => @inference_attribute,
    "probabilityAttribute" => @probability_attribute,
    "probabilityThresholdAttribute" => @probability_threshold_attribute,
    "s3DataDistributionType" => @s3_data_distribution_type,
    "s3InputMode" => @s3_input_mode,
    "startTimeOffset" => @start_time_offset,
  })
  result.compact
end