Class: AWSCDK::Sagemaker::CfnModelExplainabilityJobDefinition::BatchTransformInputProperty

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

Overview

Input object for the batch transform job.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data_captured_destination_s3_uri:, dataset_format:, local_path:, features_attribute: nil, inference_attribute: nil, probability_attribute: nil, s3_data_distribution_type: nil, s3_input_mode: nil) ⇒ BatchTransformInputProperty

Returns a new instance of BatchTransformInputProperty.

Parameters:

  • data_captured_destination_s3_uri (String) —

    The Amazon S3 location being used to capture the data.

  • dataset_format (AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnModelExplainabilityJobDefinition::DatasetFormatProperty) —

    The dataset format for your batch transform job.

  • local_path (String) —

    Path to the filesystem where the batch transform 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 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.



662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 662

def initialize(data_captured_destination_s3_uri:, dataset_format:, local_path:, features_attribute: nil, inference_attribute: nil, probability_attribute: nil, s3_data_distribution_type: nil, s3_input_mode: nil)
  @data_captured_destination_s3_uri = data_captured_destination_s3_uri
  Jsii::Type.check_type(@data_captured_destination_s3_uri, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataCapturedDestinationS3Uri")
  @dataset_format = dataset_format.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelExplainabilityJobDefinition::DatasetFormatProperty.new(**dataset_format.transform_keys(&:to_sym)) : dataset_format
  Jsii::Type.check_type(@dataset_format, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxFeHBsYWluYWJpbGl0eUpvYkRlZmluaXRpb24uRGF0YXNldEZvcm1hdFByb3BlcnR5In1dfX0=")), "datasetFormat")
  @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

#data_captured_destination_s3_uri ⇒ String (readonly)

The Amazon S3 location being used to capture the data.

Returns:

  • (String)

See Also:



685
686
687
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 685

def data_captured_destination_s3_uri
  @data_captured_destination_s3_uri
end

#dataset_format ⇒ AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnModelExplainabilityJobDefinition::DatasetFormatProperty (readonly)

The dataset format for your batch transform job.

Returns:

See Also:



690
691
692
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 690

def dataset_format
  @dataset_format
end

#features_attribute ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



700
701
702
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 700

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:



705
706
707
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 705

def inference_attribute
  @inference_attribute
end

#local_path ⇒ String (readonly)

Path to the filesystem where the batch transform data is available to the container.

Returns:

  • (String)

See Also:



695
696
697
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 695

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:



710
711
712
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 710

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 S3 key.

Defaults to FullyReplicated

Returns:

  • (String, nil)

See Also:



717
718
719
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 717

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:



724
725
726
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 724

def s3_input_mode
  @s3_input_mode
end

Class Method Details

.jsii_properties ⇒ Object 



726
727
728
729
730
731
732
733
734
735
736
737
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 726

def self.jsii_properties
  {
    :data_captured_destination_s3_uri => "dataCapturedDestinationS3Uri",
    :dataset_format => "datasetFormat",
    :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 



739
740
741
742
743
744
745
746
747
748
749
750
751
752
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 739

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