comments v3

Author: mwfongAWS

src/sagemaker/inputs.py

@@ -162,7 +162,7 @@ class CreateModelInput(object):
 
 @attr.s
 class TransformInput(object):
-    """Create a class containing all the parameters.
+    """Creates a class containing parameters for configuring input data for a batch tramsform job.
 
     It can be used when calling ``sagemaker.transformer.Transformer.transform()``
 
@@ -180,14 +180,14 @@ class TransformInput(object):
             Valid values: ``'Line'``, ``RecordIO``, ``'TFRecord'``, None
             (default: None)
         input_filter (str): A JSONPath expression for selecting a portion of the input data to pass
-            to the algorithm. For example, you can use this parameter to exclude fields, such as an 
-            ID column, from the input. If you want SageMaker to pass the entire input dataset to the 
-            algorithm, accept the default value ``$``. For more information on batch transform data 
+            to the algorithm. For example, you can use this parameter to exclude fields, such as an
+            ID column, from the input. If you want SageMaker to pass the entire input dataset to the
+            algorithm, accept the default value ``$``. For more information on batch transform data
             processing, input, join, and output, see
             `Associate Prediction Results with Input Records
             <https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html?>`_
             in the *Amazon SageMaker developer guide*.
-            Example value: ``$``. For more information about valid values for this parameter, see 
+            Example value: ``$``. For more information about valid values for this parameter, see
             `JSONPath Operators
             <https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html#data-processing-operators>`_
             in the *Amazon SageMaker developer guide*.
@@ -196,7 +196,7 @@ class TransformInput(object):
             save in the output file for a batch transform job. If you want SageMaker to store the
             entire input dataset in the output file, leave the default value, $. If you specify
             indexes that aren't within the dimension size of the joined dataset, you get an error.
-            Example value: ``$``. For more information about valid values for this parameter, see 
+            Example value: ``$``. For more information about valid values for this parameter, see
             `JSONPath Operators
             <https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html#data-processing-operators>`_
             in the *Amazon SageMaker developer guide*.
@@ -216,9 +216,11 @@ class TransformInput(object):
                   requests are failing.
 
             (default: ``{600,3}``)
-        batch_data_capture_config (dict): Specifies configuration related to batch transform job
-            data capture for use with Amazon SageMaker Model Monitoring. For more information about
-            batch transform job data capture, see `Capture data from batch transform job
+        batch_data_capture_config (dict, an object of `BatchDataCaptureConfig 
+        <https://sagemaker.readthedocs.io/en/stable/api/utility/inputs.html#sagemaker.inputs.BatchDataCaptureConfig>`_)
+            Specifies configuration related to batch transform job
+            for use with Amazon SageMaker Model Monitoring. For more information,
+            see `Capture data from batch transform job
             <https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-data-capture-batch.html>`_
             in the *Amazon SageMaker developer guide*.
             (default: None)