Class: AWSCDK::Sagemaker::CfnModelExplainabilityJobDefinition::EndpointInputProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
sagemaker/cfn_model_explainability_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:, features_attribute: nil, inference_attribute: nil, probability_attribute: nil, s3_data_distribution_type: nil, s3_input_mode: 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.

  • 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.

  • 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.



954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 954

def initialize(endpoint_name:, local_path:, features_attribute: nil, inference_attribute: nil, probability_attribute: nil, s3_data_distribution_type: nil, s3_input_mode: 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")
  @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?
  @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?
end

Instance Attribute Details

#endpoint_name ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



975
976
977
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 975

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:



985
986
987
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 985

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:



990
991
992
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 990

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:



980
981
982
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 980

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:



995
996
997
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 995

def probability_attribute
  @probability_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:



1002
1003
1004
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 1002

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:



1009
1010
1011
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 1009

def s3_input_mode
  @s3_input_mode
end

Class Method Details

.jsii_properties ⇒ Object 



1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 1011

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

Instance Method Details

#to_jsii ⇒ Object 



1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 1023

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