Class: AWSCDK::Sagemaker::CfnModelBiasJobDefinition::BatchTransformInputProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
sagemaker/cfn_model_bias_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:, 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) ⇒ 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::CfnModelBiasJobDefinition::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.

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

    If specified, monitoring jobs subtract 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 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.



665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
 
# File 'sagemaker/cfn_model_bias_job_definition.rb', line 665

def initialize(data_captured_destination_s3_uri:, dataset_format:, 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)
  @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::CfnModelBiasJobDefinition::DatasetFormatProperty.new(**dataset_format.transform_keys(&:to_sym)) : dataset_format
  Jsii::Type.check_type(@dataset_format, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxCaWFzSm9iRGVmaW5pdGlvbi5EYXRhc2V0Rm9ybWF0UHJvcGVydHkifV19fQ==")), "datasetFormat")
  @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

#data_captured_destination_s3_uri ⇒ String (readonly)

The Amazon S3 location being used to capture the data.

Returns:

  • (String)

See Also:



694
695
696
 
# File 'sagemaker/cfn_model_bias_job_definition.rb', line 694

def data_captured_destination_s3_uri
  @data_captured_destination_s3_uri
end

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

The dataset format for your batch transform job.

Returns:

See Also:



699
700
701
 
# File 'sagemaker/cfn_model_bias_job_definition.rb', line 699

def dataset_format
  @dataset_format
end

#end_time_offset ⇒ String? (readonly)

If specified, monitoring jobs subtract 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:



711
712
713
 
# File 'sagemaker/cfn_model_bias_job_definition.rb', line 711

def end_time_offset
  @end_time_offset
end

#features_attribute ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



716
717
718
 
# File 'sagemaker/cfn_model_bias_job_definition.rb', line 716

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:



721
722
723
 
# File 'sagemaker/cfn_model_bias_job_definition.rb', line 721

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:



704
705
706
 
# File 'sagemaker/cfn_model_bias_job_definition.rb', line 704

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:



726
727
728
 
# File 'sagemaker/cfn_model_bias_job_definition.rb', line 726

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:



731
732
733
 
# File 'sagemaker/cfn_model_bias_job_definition.rb', line 731

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

Defaults to FullyReplicated

Returns:

  • (String, nil)

See Also:



738
739
740
 
# File 'sagemaker/cfn_model_bias_job_definition.rb', line 738

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:



745
746
747
 
# File 'sagemaker/cfn_model_bias_job_definition.rb', line 745

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:



752
753
754
 
# File 'sagemaker/cfn_model_bias_job_definition.rb', line 752

def start_time_offset
  @start_time_offset
end

Class Method Details

.jsii_properties ⇒ Object 



754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
 
# File 'sagemaker/cfn_model_bias_job_definition.rb', line 754

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



770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
 
# File 'sagemaker/cfn_model_bias_job_definition.rb', line 770

def to_jsii
  result = {}
  result.merge!({
    "dataCapturedDestinationS3Uri" => @data_captured_destination_s3_uri,
    "datasetFormat" => @dataset_format,
    "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