Package software.amazon.awscdk.services.sagemaker

Interface CfnModelPackage.TransformInputProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnModelPackage.TransformInputProperty.Jsii$Proxy
Enclosing class:
CfnModelPackage
@Stability(Stable) public static interface CfnModelPackage.TransformInputProperty extends software.amazon.jsii.JsiiSerializable
Describes the input source of a transform job and the way the transform job consumes it.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 TransformInputProperty transformInputProperty = TransformInputProperty.builder()
         .dataSource(DataSourceProperty.builder()
                 .s3DataSource(S3DataSourceProperty.builder()
                         .s3DataType("s3DataType")
                         .s3Uri("s3Uri")
                         .build())
                 .build())
         // the properties below are optional
         .compressionType("compressionType")
         .contentType("contentType")
         .splitType("splitType")
         .build();

  • Method Details

    • getDataSource

      @Stability(Stable) @NotNull Object getDataSource()
      Describes the location of the channel data, which is, the S3 location of the input data that the model can consume.

    • getCompressionType

      @Stability(Stable) @Nullable default String getCompressionType()
      If your transform data is compressed, specify the compression type.

      Amazon SageMaker automatically decompresses the data for the transform job accordingly. The default value is None .

    • getContentType

      @Stability(Stable) @Nullable default String getContentType()
      The multipurpose internet mail extension (MIME) type of the data.

      Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job.

    • getSplitType

      @Stability(Stable) @Nullable default String getSplitType()
      The method to use to split the transform job's data files into smaller batches.

      Splitting is necessary when the total size of each object is too large to fit in a single request. You can also use data splitting to improve performance by processing multiple concurrent mini-batches. The default value for SplitType is None , which indicates that input data files are not split, and request payloads contain the entire contents of an input object. Set the value of this parameter to Line to split records on a newline character boundary. SplitType also supports a number of record-oriented binary data formats. Currently, the supported record formats are:

      • RecordIO
      • TFRecord

      When splitting is enabled, the size of a mini-batch depends on the values of the BatchStrategy and MaxPayloadInMB parameters. When the value of BatchStrategy is MultiRecord , Amazon SageMaker sends the maximum number of records in each request, up to the MaxPayloadInMB limit. If the value of BatchStrategy is SingleRecord , Amazon SageMaker sends individual records in each request.

      Some data formats represent a record as a binary payload wrapped with extra padding bytes. When splitting is applied to a binary data format, padding is removed if the value of BatchStrategy is set to SingleRecord . Padding is not removed if the value of BatchStrategy is set to MultiRecord .

      For more information about RecordIO , see Create a Dataset Using RecordIO in the MXNet documentation. For more information about TFRecord , see Consuming TFRecord data in the TensorFlow documentation.

    • builder

      @Stability(Stable) static CfnModelPackage.TransformInputProperty.Builder builder()
      Returns:
      a CfnModelPackage.TransformInputProperty.Builder of CfnModelPackage.TransformInputProperty