« blib/lib/Paws/Forecast/FeaturizationConfig.pm
↑ Summary
blib/lib/Paws/Forecast/FeaturizationMethodParameters.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Forecast::FeaturizationMethod; | ||
| 3 | use Moose; | ||
| 4 | has FeaturizationMethodName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has FeaturizationMethodParameters => (is => 'ro', isa => 'Paws::Forecast::FeaturizationMethodParameters'); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::Forecast::FeaturizationMethod | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::Forecast::FeaturizationMethod object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { FeaturizationMethodName => $value, ..., FeaturizationMethodParameters => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::Forecast::FeaturizationMethod object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->FeaturizationMethodName | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Provides information about the method that featurizes (transforms) a | ||
| 38 | dataset field. The method is part of the C<FeaturizationPipeline> of | ||
| 39 | the Featurization object. | ||
| 40 | |||
| 41 | The following is an example of how you specify a C<FeaturizationMethod> | ||
| 42 | object. | ||
| 43 | |||
| 44 | C<{> | ||
| 45 | |||
| 46 | C<"FeaturizationMethodName": "filling",> | ||
| 47 | |||
| 48 | C<"FeaturizationMethodParameters": {"aggregation": "sum", "middlefill": | ||
| 49 | "zero", "backfill": "zero"}> | ||
| 50 | |||
| 51 | C<}> | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> FeaturizationMethodName => Str | ||
| 57 | |||
| 58 | The name of the method. The "filling" method is the only supported | ||
| 59 | method. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 FeaturizationMethodParameters => L<Paws::Forecast::FeaturizationMethodParameters> | ||
| 63 | |||
| 64 | The method parameters (key-value pairs), which are a map of override | ||
| 65 | parameters. Specify these parameters to override the default values. | ||
| 66 | Related Time Series attributes do not accept aggregation parameters. | ||
| 67 | |||
| 68 | The following list shows the parameters and their valid values for the | ||
| 69 | "filling" featurization method for a B<Target Time Series> dataset. | ||
| 70 | Bold signifies the default value. | ||
| 71 | |||
| 72 | =over | ||
| 73 | |||
| 74 | =item * | ||
| 75 | |||
| 76 | C<aggregation>: B<sum>, C<avg>, C<first>, C<min>, C<max> | ||
| 77 | |||
| 78 | =item * | ||
| 79 | |||
| 80 | C<frontfill>: B<none> | ||
| 81 | |||
| 82 | =item * | ||
| 83 | |||
| 84 | C<middlefill>: B<zero>, C<nan> (not a number), C<value>, C<median>, | ||
| 85 | C<mean>, C<min>, C<max> | ||
| 86 | |||
| 87 | =item * | ||
| 88 | |||
| 89 | C<backfill>: B<zero>, C<nan>, C<value>, C<median>, C<mean>, C<min>, | ||
| 90 | C<max> | ||
| 91 | |||
| 92 | =back | ||
| 93 | |||
| 94 | The following list shows the parameters and their valid values for a | ||
| 95 | B<Related Time Series> featurization method (there are no defaults): | ||
| 96 | |||
| 97 | =over | ||
| 98 | |||
| 99 | =item * | ||
| 100 | |||
| 101 | C<middlefill>: C<zero>, C<value>, C<median>, C<mean>, C<min>, C<max> | ||
| 102 | |||
| 103 | =item * | ||
| 104 | |||
| 105 | C<backfill>: C<zero>, C<value>, C<median>, C<mean>, C<min>, C<max> | ||
| 106 | |||
| 107 | =item * | ||
| 108 | |||
| 109 | C<futurefill>: C<zero>, C<value>, C<median>, C<mean>, C<min>, C<max> | ||
| 110 | |||
| 111 | =back | ||
| 112 | |||
| 113 | To set a filling method to a specific value, set the fill parameter to | ||
| 114 | C<value> and define the value in a corresponding C<_value> parameter. | ||
| 115 | For example, to set backfilling to a value of 2, include the following: | ||
| 116 | C<"backfill": "value"> and C<"backfill_value":"2">. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head1 SEE ALSO | ||
| 121 | |||
| 122 | This class forms part of L<Paws>, describing an object used in L<Paws::Forecast> | ||
| 123 | |||
| 124 | =head1 BUGS and CONTRIBUTIONS | ||
| 125 | |||
| 126 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 127 | |||
| 128 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 129 | |||
| 130 | =cut | ||
| 131 |