Skip to content

Commit fda585b

Browse files
documentation: add additional information to Transformer class transform function doc string (#1243)
* doc: add additional information to Transformer class transform function doc string Co-authored-by: Lauren Yu <[email protected]>
1 parent 1c28a79 commit fda585b

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

src/sagemaker/transformer.py

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ def __init__(
6868
max_payload (int): Maximum size of the payload in a single HTTP
6969
request to the container in MB.
7070
tags (list[dict]): List of tags for labeling a transform job
71-
(default: None). For more, see
72-
https://docs.aws.amazon.com/sagemaker/latest/dg/API_Tag.html.
71+
(default: None). For more, see the SageMaker API documentation for
72+
`Tag <https://docs.aws.amazon.com/sagemaker/latest/dg/API_Tag.html>`_.
7373
env (dict): Environment variables to be set for use during the
7474
transform job (default: None).
7575
base_transform_job_name (str): Prefix for the transform job when the
@@ -146,11 +146,21 @@ def transform(
146146
input_filter (str): A JSONPath to select a portion of the input to
147147
pass to the algorithm container for inference. If you omit the
148148
field, it gets the value '$', representing the entire input.
149-
For more information, see https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateTransformJob.html.
149+
For CSV data, each row is taken as a JSON array,
150+
so only index-based JSONPaths can be applied, e.g. $[0], $[1:].
151+
CSV data should follow the `RFC format <https://tools.ietf.org/html/rfc4180>`_.
152+
See `Supported JSONPath Operators
153+
<https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html#data-processing-operators>`_
154+
for a table of supported JSONPath operators.
155+
For more information, see the SageMaker API documentation for
156+
`CreateTransformJob
157+
<https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateTransformJob.html>`_.
150158
Some examples: "$[1:]", "$.features" (default: None).
151159
output_filter (str): A JSONPath to select a portion of the
152160
joined/original output to return as the output.
153-
For more information, see https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateTransformJob.html.
161+
For more information, see the SageMaker API documentation for
162+
`CreateTransformJob
163+
<https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateTransformJob.html>`_.
154164
Some examples: "$[1:]", "$.prediction" (default: None).
155165
join_source (str): The source of data to be joined to the transform
156166
output. It can be set to 'Input' meaning the entire input record

0 commit comments

Comments
 (0)