« blib/lib/Paws/SageMaker/CreateCodeRepositoryOutput.pm
↑ Summary
blib/lib/Paws/SageMaker/CreateCompilationJobResponse.pm »
| 1 | |||
| 2 | package Paws::SageMaker::CreateCompilationJob; | ||
| 3 | use Moose; | ||
| 4 | has CompilationJobName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has InputConfig => (is => 'ro', isa => 'Paws::SageMaker::InputConfig', required => 1); | ||
| 6 | has OutputConfig => (is => 'ro', isa => 'Paws::SageMaker::OutputConfig', required => 1); | ||
| 7 | has RoleArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has StoppingCondition => (is => 'ro', isa => 'Paws::SageMaker::StoppingCondition', required => 1); | ||
| 9 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::Tag]'); | ||
| 10 | has VpcConfig => (is => 'ro', isa => 'Paws::SageMaker::NeoVpcConfig'); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateCompilationJob'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::CreateCompilationJobResponse'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::SageMaker::CreateCompilationJob - Arguments for method CreateCompilationJob on L<Paws::SageMaker> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method CreateCompilationJob on the | ||
| 28 | L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class | ||
| 29 | as arguments to method CreateCompilationJob. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateCompilationJob. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $api.sagemaker = Paws->service('SageMaker'); | ||
| 36 | my $CreateCompilationJobResponse = $api . sagemaker->CreateCompilationJob( | ||
| 37 | CompilationJobName => 'MyEntityName', | ||
| 38 | InputConfig => { | ||
| 39 | DataInputConfig => 'MyDataInputConfig', # min: 1, max: 1024 | ||
| 40 | Framework => 'TENSORFLOW' | ||
| 41 | , # values: TENSORFLOW, KERAS, MXNET, ONNX, PYTORCH, XGBOOST, TFLITE, DARKNET, SKLEARN | ||
| 42 | S3Uri => 'MyS3Uri', # max: 1024 | ||
| 43 | FrameworkVersion => 'MyFrameworkVersion', # min: 3, max: 10; OPTIONAL | ||
| 44 | }, | ||
| 45 | OutputConfig => { | ||
| 46 | S3OutputLocation => 'MyS3Uri', # max: 1024 | ||
| 47 | CompilerOptions => 'MyCompilerOptions', # min: 3, max: 1024; OPTIONAL | ||
| 48 | KmsKeyId => 'MyKmsKeyId', # max: 2048; OPTIONAL | ||
| 49 | TargetDevice => 'lambda' | ||
| 50 | , # values: lambda, ml_m4, ml_m5, ml_c4, ml_c5, ml_p2, ml_p3, ml_g4dn, ml_inf1, ml_eia2, jetson_tx1, jetson_tx2, jetson_nano, jetson_xavier, rasp3b, imx8qm, deeplens, rk3399, rk3288, aisage, sbe_c, qcs605, qcs603, sitara_am57x, amba_cv22, amba_cv25, x86_win32, x86_win64, coreml, jacinto_tda4vm; OPTIONAL | ||
| 51 | TargetPlatform => { | ||
| 52 | Arch => 'X86_64', # values: X86_64, X86, ARM64, ARM_EABI, ARM_EABIHF | ||
| 53 | Os => 'ANDROID', # values: ANDROID, LINUX | ||
| 54 | Accelerator => | ||
| 55 | 'INTEL_GRAPHICS', # values: INTEL_GRAPHICS, MALI, NVIDIA; OPTIONAL | ||
| 56 | }, # OPTIONAL | ||
| 57 | }, | ||
| 58 | RoleArn => 'MyRoleArn', | ||
| 59 | StoppingCondition => { | ||
| 60 | MaxRuntimeInSeconds => 1, # min: 1; OPTIONAL | ||
| 61 | MaxWaitTimeInSeconds => 1, # min: 1; OPTIONAL | ||
| 62 | }, | ||
| 63 | Tags => [ | ||
| 64 | { | ||
| 65 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 66 | Value => 'MyTagValue', # max: 256 | ||
| 67 | |||
| 68 | }, | ||
| 69 | ... | ||
| 70 | ], # OPTIONAL | ||
| 71 | VpcConfig => { | ||
| 72 | SecurityGroupIds => [ | ||
| 73 | 'MyNeoVpcSecurityGroupId', ... # max: 32 | ||
| 74 | ], # min: 1, max: 5 | ||
| 75 | Subnets => [ | ||
| 76 | 'MyNeoVpcSubnetId', ... # max: 32 | ||
| 77 | ], # min: 1, max: 16 | ||
| 78 | |||
| 79 | }, # OPTIONAL | ||
| 80 | ); | ||
| 81 | |||
| 82 | # Results: | ||
| 83 | my $CompilationJobArn = $CreateCompilationJobResponse->CompilationJobArn; | ||
| 84 | |||
| 85 | # Returns a L<Paws::SageMaker::CreateCompilationJobResponse> object. | ||
| 86 | |||
| 87 | 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. | ||
| 88 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/CreateCompilationJob> | ||
| 89 | |||
| 90 | =head1 ATTRIBUTES | ||
| 91 | |||
| 92 | |||
| 93 | =head2 B<REQUIRED> CompilationJobName => Str | ||
| 94 | |||
| 95 | A name for the model compilation job. The name must be unique within | ||
| 96 | the Amazon Web Services Region and within your Amazon Web Services | ||
| 97 | account. | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head2 B<REQUIRED> InputConfig => L<Paws::SageMaker::InputConfig> | ||
| 102 | |||
| 103 | Provides information about the location of input model artifacts, the | ||
| 104 | name and shape of the expected data inputs, and the framework in which | ||
| 105 | the model was trained. | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head2 B<REQUIRED> OutputConfig => L<Paws::SageMaker::OutputConfig> | ||
| 110 | |||
| 111 | Provides information about the output location for the compiled model | ||
| 112 | and the target device the model runs on. | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 B<REQUIRED> RoleArn => Str | ||
| 117 | |||
| 118 | The Amazon Resource Name (ARN) of an IAM role that enables Amazon | ||
| 119 | SageMaker to perform tasks on your behalf. | ||
| 120 | |||
| 121 | During model compilation, Amazon SageMaker needs your permission to: | ||
| 122 | |||
| 123 | =over | ||
| 124 | |||
| 125 | =item * | ||
| 126 | |||
| 127 | Read input data from an S3 bucket | ||
| 128 | |||
| 129 | =item * | ||
| 130 | |||
| 131 | Write model artifacts to an S3 bucket | ||
| 132 | |||
| 133 | =item * | ||
| 134 | |||
| 135 | Write logs to Amazon CloudWatch Logs | ||
| 136 | |||
| 137 | =item * | ||
| 138 | |||
| 139 | Publish metrics to Amazon CloudWatch | ||
| 140 | |||
| 141 | =back | ||
| 142 | |||
| 143 | You grant permissions for all of these tasks to an IAM role. To pass | ||
| 144 | this role to Amazon SageMaker, the caller of this API must have the | ||
| 145 | C<iam:PassRole> permission. For more information, see Amazon SageMaker | ||
| 146 | Roles. | ||
| 147 | (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html) | ||
| 148 | |||
| 149 | |||
| 150 | |||
| 151 | =head2 B<REQUIRED> StoppingCondition => L<Paws::SageMaker::StoppingCondition> | ||
| 152 | |||
| 153 | Specifies a limit to how long a model compilation job can run. When the | ||
| 154 | job reaches the time limit, Amazon SageMaker ends the compilation job. | ||
| 155 | Use this API to cap model training costs. | ||
| 156 | |||
| 157 | |||
| 158 | |||
| 159 | =head2 Tags => ArrayRef[L<Paws::SageMaker::Tag>] | ||
| 160 | |||
| 161 | An array of key-value pairs. You can use tags to categorize your Amazon | ||
| 162 | Web Services resources in different ways, for example, by purpose, | ||
| 163 | owner, or environment. For more information, see Tagging Amazon Web | ||
| 164 | Services Resources | ||
| 165 | (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). | ||
| 166 | |||
| 167 | |||
| 168 | |||
| 169 | =head2 VpcConfig => L<Paws::SageMaker::NeoVpcConfig> | ||
| 170 | |||
| 171 | A VpcConfig object that specifies the VPC that you want your | ||
| 172 | compilation job to connect to. Control access to your models by | ||
| 173 | configuring the VPC. For more information, see Protect Compilation Jobs | ||
| 174 | by Using an Amazon Virtual Private Cloud | ||
| 175 | (https://docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html). | ||
| 176 | |||
| 177 | |||
| 178 | |||
| 179 | |||
| 180 | =head1 SEE ALSO | ||
| 181 | |||
| 182 | This class forms part of L<Paws>, documenting arguments for method CreateCompilationJob in L<Paws::SageMaker> | ||
| 183 | |||
| 184 | =head1 BUGS and CONTRIBUTIONS | ||
| 185 | |||
| 186 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 187 | |||
| 188 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 189 | |||
| 190 | =cut | ||
| 191 |