| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Forecast::IntegerParameterRange; | ||
| 3 | use Moose; | ||
| 4 | has MaxValue => (is => 'ro', isa => 'Int', required => 1); | ||
| 5 | has MinValue => (is => 'ro', isa => 'Int', required => 1); | ||
| 6 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has ScalingType => (is => 'ro', isa => 'Str'); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::Forecast::IntegerParameterRange | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::Forecast::IntegerParameterRange object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { MaxValue => $value, ..., ScalingType => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::Forecast::IntegerParameterRange object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->MaxValue | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | Specifies an integer hyperparameter and it's range of tunable values. | ||
| 40 | This object is part of the ParameterRanges object. | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 B<REQUIRED> MaxValue => Int | ||
| 46 | |||
| 47 | The maximum tunable value of the hyperparameter. | ||
| 48 | |||
| 49 | |||
| 50 | =head2 B<REQUIRED> MinValue => Int | ||
| 51 | |||
| 52 | The minimum tunable value of the hyperparameter. | ||
| 53 | |||
| 54 | |||
| 55 | =head2 B<REQUIRED> Name => Str | ||
| 56 | |||
| 57 | The name of the hyperparameter to tune. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 ScalingType => Str | ||
| 61 | |||
| 62 | The scale that hyperparameter tuning uses to search the hyperparameter | ||
| 63 | range. Valid values: | ||
| 64 | |||
| 65 | =over | ||
| 66 | |||
| 67 | =item Auto | ||
| 68 | |||
| 69 | Amazon Forecast hyperparameter tuning chooses the best scale for the | ||
| 70 | hyperparameter. | ||
| 71 | |||
| 72 | =item Linear | ||
| 73 | |||
| 74 | Hyperparameter tuning searches the values in the hyperparameter range | ||
| 75 | by using a linear scale. | ||
| 76 | |||
| 77 | =item Logarithmic | ||
| 78 | |||
| 79 | Hyperparameter tuning searches the values in the hyperparameter range | ||
| 80 | by using a logarithmic scale. | ||
| 81 | |||
| 82 | Logarithmic scaling works only for ranges that have values greater than | ||
| 83 | 0. | ||
| 84 | |||
| 85 | =item ReverseLogarithmic | ||
| 86 | |||
| 87 | Not supported for C<IntegerParameterRange>. | ||
| 88 | |||
| 89 | Reverse logarithmic scaling works only for ranges that are entirely | ||
| 90 | within the range 0 E<lt>= x E<lt> 1.0. | ||
| 91 | |||
| 92 | =back | ||
| 93 | |||
| 94 | For information about choosing a hyperparameter scale, see | ||
| 95 | Hyperparameter Scaling | ||
| 96 | (http://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type). | ||
| 97 | One of the following values: | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head1 SEE ALSO | ||
| 102 | |||
| 103 | This class forms part of L<Paws>, describing an object used in L<Paws::Forecast> | ||
| 104 | |||
| 105 | =head1 BUGS and CONTRIBUTIONS | ||
| 106 | |||
| 107 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 108 | |||
| 109 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 110 | |||
| 111 | =cut | ||
| 112 |