« blib/lib/Paws/SageMaker/CreateArtifactResponse.pm
↑ Summary
blib/lib/Paws/SageMaker/CreateAutoMLJobResponse.pm »
| 1 | |||
| 2 | package Paws::SageMaker::CreateAutoMLJob; | ||
| 3 | use Moose; | ||
| 4 | has AutoMLJobConfig => (is => 'ro', isa => 'Paws::SageMaker::AutoMLJobConfig'); | ||
| 5 | has AutoMLJobName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has AutoMLJobObjective => (is => 'ro', isa => 'Paws::SageMaker::AutoMLJobObjective'); | ||
| 7 | has GenerateCandidateDefinitionsOnly => (is => 'ro', isa => 'Bool'); | ||
| 8 | has InputDataConfig => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::AutoMLChannel]', required => 1); | ||
| 9 | has ModelDeployConfig => (is => 'ro', isa => 'Paws::SageMaker::ModelDeployConfig'); | ||
| 10 | has OutputDataConfig => (is => 'ro', isa => 'Paws::SageMaker::AutoMLOutputDataConfig', required => 1); | ||
| 11 | has ProblemType => (is => 'ro', isa => 'Str'); | ||
| 12 | has RoleArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 13 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::Tag]'); | ||
| 14 | |||
| 15 | use MooseX::ClassAttribute; | ||
| 16 | |||
| 17 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateAutoMLJob'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::CreateAutoMLJobResponse'); | ||
| 19 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::SageMaker::CreateAutoMLJob - Arguments for method CreateAutoMLJob on L<Paws::SageMaker> | ||
| 27 | |||
| 28 | =head1 DESCRIPTION | ||
| 29 | |||
| 30 | This class represents the parameters used for calling the method CreateAutoMLJob on the | ||
| 31 | L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class | ||
| 32 | as arguments to method CreateAutoMLJob. | ||
| 33 | |||
| 34 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateAutoMLJob. | ||
| 35 | |||
| 36 | =head1 SYNOPSIS | ||
| 37 | |||
| 38 | my $api.sagemaker = Paws->service('SageMaker'); | ||
| 39 | my $CreateAutoMLJobResponse = $api . sagemaker->CreateAutoMLJob( | ||
| 40 | AutoMLJobName => 'MyAutoMLJobName', | ||
| 41 | InputDataConfig => [ | ||
| 42 | { | ||
| 43 | DataSource => { | ||
| 44 | S3DataSource => { | ||
| 45 | S3DataType => 'ManifestFile', # values: ManifestFile, S3Prefix | ||
| 46 | S3Uri => 'MyS3Uri', # max: 1024 | ||
| 47 | |||
| 48 | }, | ||
| 49 | |||
| 50 | }, | ||
| 51 | TargetAttributeName => 'MyTargetAttributeName', # min: 1 | ||
| 52 | CompressionType => 'None', # values: None, Gzip; OPTIONAL | ||
| 53 | }, | ||
| 54 | ... | ||
| 55 | ], | ||
| 56 | OutputDataConfig => { | ||
| 57 | S3OutputPath => 'MyS3Uri', # max: 1024 | ||
| 58 | KmsKeyId => 'MyKmsKeyId', # max: 2048; OPTIONAL | ||
| 59 | }, | ||
| 60 | RoleArn => 'MyRoleArn', | ||
| 61 | AutoMLJobConfig => { | ||
| 62 | CompletionCriteria => { | ||
| 63 | MaxAutoMLJobRuntimeInSeconds => 1, # min: 1; OPTIONAL | ||
| 64 | MaxCandidates => 1, # min: 1; OPTIONAL | ||
| 65 | MaxRuntimePerTrainingJobInSeconds => 1, # min: 1; OPTIONAL | ||
| 66 | }, # OPTIONAL | ||
| 67 | SecurityConfig => { | ||
| 68 | EnableInterContainerTrafficEncryption => 1, # OPTIONAL | ||
| 69 | VolumeKmsKeyId => 'MyKmsKeyId', # max: 2048; OPTIONAL | ||
| 70 | VpcConfig => { | ||
| 71 | SecurityGroupIds => [ | ||
| 72 | 'MySecurityGroupId', ... # max: 32 | ||
| 73 | ], # min: 1, max: 5 | ||
| 74 | Subnets => [ | ||
| 75 | 'MySubnetId', ... # max: 32 | ||
| 76 | ], # min: 1, max: 16 | ||
| 77 | |||
| 78 | }, # OPTIONAL | ||
| 79 | }, # OPTIONAL | ||
| 80 | }, # OPTIONAL | ||
| 81 | AutoMLJobObjective => { | ||
| 82 | MetricName => 'Accuracy', # values: Accuracy, MSE, F1, F1macro, AUC | ||
| 83 | |||
| 84 | }, # OPTIONAL | ||
| 85 | GenerateCandidateDefinitionsOnly => 1, # OPTIONAL | ||
| 86 | ModelDeployConfig => { | ||
| 87 | AutoGenerateEndpointName => 1, # OPTIONAL | ||
| 88 | EndpointName => 'MyEndpointName', # max: 63; OPTIONAL | ||
| 89 | }, # OPTIONAL | ||
| 90 | ProblemType => 'BinaryClassification', # OPTIONAL | ||
| 91 | Tags => [ | ||
| 92 | { | ||
| 93 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 94 | Value => 'MyTagValue', # max: 256 | ||
| 95 | |||
| 96 | }, | ||
| 97 | ... | ||
| 98 | ], # OPTIONAL | ||
| 99 | ); | ||
| 100 | |||
| 101 | # Results: | ||
| 102 | my $AutoMLJobArn = $CreateAutoMLJobResponse->AutoMLJobArn; | ||
| 103 | |||
| 104 | # Returns a L<Paws::SageMaker::CreateAutoMLJobResponse> object. | ||
| 105 | |||
| 106 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 107 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/CreateAutoMLJob> | ||
| 108 | |||
| 109 | =head1 ATTRIBUTES | ||
| 110 | |||
| 111 | |||
| 112 | =head2 AutoMLJobConfig => L<Paws::SageMaker::AutoMLJobConfig> | ||
| 113 | |||
| 114 | Contains C<CompletionCriteria> and C<SecurityConfig> settings for the | ||
| 115 | AutoML job. | ||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | =head2 B<REQUIRED> AutoMLJobName => Str | ||
| 120 | |||
| 121 | Identifies an Autopilot job. The name must be unique to your account | ||
| 122 | and is case-insensitive. | ||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | =head2 AutoMLJobObjective => L<Paws::SageMaker::AutoMLJobObjective> | ||
| 127 | |||
| 128 | Defines the objective metric used to measure the predictive quality of | ||
| 129 | an AutoML job. You provide an AutoMLJobObjective$MetricName and | ||
| 130 | Autopilot infers whether to minimize or maximize it. | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | =head2 GenerateCandidateDefinitionsOnly => Bool | ||
| 135 | |||
| 136 | Generates possible candidates without training the models. A candidate | ||
| 137 | is a combination of data preprocessors, algorithms, and algorithm | ||
| 138 | parameter settings. | ||
| 139 | |||
| 140 | |||
| 141 | |||
| 142 | =head2 B<REQUIRED> InputDataConfig => ArrayRef[L<Paws::SageMaker::AutoMLChannel>] | ||
| 143 | |||
| 144 | An array of channel objects that describes the input data and its | ||
| 145 | location. Each channel is a named input source. Similar to | ||
| 146 | C<InputDataConfig> supported by . Format(s) supported: CSV. Minimum of | ||
| 147 | 500 rows. | ||
| 148 | |||
| 149 | |||
| 150 | |||
| 151 | =head2 ModelDeployConfig => L<Paws::SageMaker::ModelDeployConfig> | ||
| 152 | |||
| 153 | Specifies how to generate the endpoint name for an automatic one-click | ||
| 154 | Autopilot model deployment. | ||
| 155 | |||
| 156 | |||
| 157 | |||
| 158 | =head2 B<REQUIRED> OutputDataConfig => L<Paws::SageMaker::AutoMLOutputDataConfig> | ||
| 159 | |||
| 160 | Provides information about encryption and the Amazon S3 output path | ||
| 161 | needed to store artifacts from an AutoML job. Format(s) supported: CSV. | ||
| 162 | |||
| 163 | |||
| 164 | |||
| 165 | =head2 ProblemType => Str | ||
| 166 | |||
| 167 | Defines the type of supervised learning available for the candidates. | ||
| 168 | Options include: C<BinaryClassification>, C<MulticlassClassification>, | ||
| 169 | and C<Regression>. For more information, see Amazon SageMaker Autopilot | ||
| 170 | problem types and algorithm support | ||
| 171 | (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development-problem-types.html). | ||
| 172 | |||
| 173 | Valid values are: C<"BinaryClassification">, C<"MulticlassClassification">, C<"Regression"> | ||
| 174 | |||
| 175 | =head2 B<REQUIRED> RoleArn => Str | ||
| 176 | |||
| 177 | The ARN of the role that is used to access the data. | ||
| 178 | |||
| 179 | |||
| 180 | |||
| 181 | =head2 Tags => ArrayRef[L<Paws::SageMaker::Tag>] | ||
| 182 | |||
| 183 | Each tag consists of a key and an optional value. Tag keys must be | ||
| 184 | unique per resource. | ||
| 185 | |||
| 186 | |||
| 187 | |||
| 188 | |||
| 189 | =head1 SEE ALSO | ||
| 190 | |||
| 191 | This class forms part of L<Paws>, documenting arguments for method CreateAutoMLJob in L<Paws::SageMaker> | ||
| 192 | |||
| 193 | =head1 BUGS and CONTRIBUTIONS | ||
| 194 | |||
| 195 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 196 | |||
| 197 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 198 | |||
| 199 | =cut | ||
| 200 |