« blib/lib/Paws/SageMaker/DataCatalogConfig.pm
↑ Summary
blib/lib/Paws/SageMaker/DataQualityAppSpecification.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SageMaker::DataProcessing; | ||
| 3 | use Moose; | ||
| 4 | has InputFilter => (is => 'ro', isa => 'Str'); | ||
| 5 | has JoinSource => (is => 'ro', isa => 'Str'); | ||
| 6 | has OutputFilter => (is => 'ro', isa => 'Str'); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::SageMaker::DataProcessing | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::SageMaker::DataProcessing object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { InputFilter => $value, ..., OutputFilter => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::SageMaker::DataProcessing object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->InputFilter | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | The data structure used to specify the data to be used for inference in | ||
| 39 | a batch transform job and to associate the data that is relevant to the | ||
| 40 | prediction results in the output. The input filter provided allows you | ||
| 41 | to exclude input data that is not needed for inference in a batch | ||
| 42 | transform job. The output filter provided allows you to include input | ||
| 43 | data relevant to interpreting the predictions in the output from the | ||
| 44 | job. For more information, see Associate Prediction Results with their | ||
| 45 | Corresponding Input Records | ||
| 46 | (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html). | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 InputFilter => Str | ||
| 52 | |||
| 53 | A JSONPath | ||
| 54 | (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html#data-processing-operators) | ||
| 55 | expression used to select a portion of the input data to pass to the | ||
| 56 | algorithm. Use the C<InputFilter> parameter to exclude fields, such as | ||
| 57 | an ID column, from the input. If you want Amazon SageMaker to pass the | ||
| 58 | entire input dataset to the algorithm, accept the default value C<$>. | ||
| 59 | |||
| 60 | Examples: C<"$">, C<"$[1:]">, C<"$.features"> | ||
| 61 | |||
| 62 | |||
| 63 | =head2 JoinSource => Str | ||
| 64 | |||
| 65 | Specifies the source of the data to join with the transformed data. The | ||
| 66 | valid values are C<None> and C<Input>. The default value is C<None>, | ||
| 67 | which specifies not to join the input with the transformed data. If you | ||
| 68 | want the batch transform job to join the original input data with the | ||
| 69 | transformed data, set C<JoinSource> to C<Input>. You can specify | ||
| 70 | C<OutputFilter> as an additional filter to select a portion of the | ||
| 71 | joined dataset and store it in the output file. | ||
| 72 | |||
| 73 | For JSON or JSONLines objects, such as a JSON array, Amazon SageMaker | ||
| 74 | adds the transformed data to the input JSON object in an attribute | ||
| 75 | called C<SageMakerOutput>. The joined result for JSON must be a | ||
| 76 | key-value pair object. If the input is not a key-value pair object, | ||
| 77 | Amazon SageMaker creates a new JSON file. In the new JSON file, and the | ||
| 78 | input data is stored under the C<SageMakerInput> key and the results | ||
| 79 | are stored in C<SageMakerOutput>. | ||
| 80 | |||
| 81 | For CSV data, Amazon SageMaker takes each row as a JSON array and joins | ||
| 82 | the transformed data with the input by appending each transformed row | ||
| 83 | to the end of the input. The joined data has the original input data | ||
| 84 | followed by the transformed data and the output is a CSV file. | ||
| 85 | |||
| 86 | For information on how joining in applied, see Workflow for Associating | ||
| 87 | Inferences with Input Records | ||
| 88 | (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html#batch-transform-data-processing-workflow). | ||
| 89 | |||
| 90 | |||
| 91 | =head2 OutputFilter => Str | ||
| 92 | |||
| 93 | A JSONPath | ||
| 94 | (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html#data-processing-operators) | ||
| 95 | expression used to select a portion of the joined dataset to save in | ||
| 96 | the output file for a batch transform job. If you want Amazon SageMaker | ||
| 97 | to store the entire input dataset in the output file, leave the default | ||
| 98 | value, C<$>. If you specify indexes that aren't within the dimension | ||
| 99 | size of the joined dataset, you get an error. | ||
| 100 | |||
| 101 | Examples: C<"$">, C<"$[0,5:]">, C<"$['id','SageMakerOutput']"> | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head1 SEE ALSO | ||
| 106 | |||
| 107 | This class forms part of L<Paws>, describing an object used in L<Paws::SageMaker> | ||
| 108 | |||
| 109 | =head1 BUGS and CONTRIBUTIONS | ||
| 110 | |||
| 111 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 112 | |||
| 113 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 114 | |||
| 115 | =cut | ||
| 116 |