aws-cdk-neuronx-patterns 0.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,103 @@
+# Neuronx patterns Construct Library
+
+This library provides high-level architectural patterns using neuronx (e.g. Inferentia2 and Trainium1). It contains:
+
+- Neuronx Compile
+
+## Neuronx Compile
+
+:::note warn
+This construct uses an Inferentia2 instance on EC2. You may need to increase your request limit for your AWS account.
+:::
+
+This construct compiles models supported by Neuronx and uploads them to the specified S3 bucket.
+
+This is NeuronxCompile architecture.
+![NeuronxCompile architecture](./docs/neuronx-compile-architecture.png)
+
+To define
+
+```ts
+import { Vpc } from "aws-cdk-lib/aws-ec2";
+import { Bucket } from "aws-cdk-lib/aws-s3";
+
+declare const vpc: Vpc;
+declare const bucket: Bucket;
+const compile = new NeuronxCompile(stack, "NeuronxCompile", {
+  vpc,
+  bucket,
+  model: Model.fromHuggingFace("example/example-7b-chat", {
+    parameters: Parameters.billion(7),
+  }),
+});
+
+// Get the compiled artifacts from this S3 URL
+new CfnOutput(stack, "CompiledArtifact", {
+  value: compile.compiledArtifactS3Url,
+});
+```
+
+This construct assumes the required instance type depending on the number of model parameters.
+
+After compiled, you can see like the this file tree in the S3 bucket.
+
+```txt
+{compiledArtifactS3Url}/
+├── model
+│   ├── config.json
+│   ├── tokenizer_config.json
+│   ├── xxx.safetensors
+│   └── xxx.safetensors
+└── compiled
+    ├── xxx.neff
+    ├── xxx.neff
+    └── xxx.neff
+```
+
+### Spot Instance
+
+:::note warn
+If you use Spot Instances, check if the request limit for Spot has been increased.
+:::
+
+You can also use Spot Instances.
+
+```ts
+import { Vpc } from "aws-cdk-lib/aws-ec2";
+import { Bucket } from "aws-cdk-lib/aws-s3";
+
+declare const vpc: Vpc;
+declare const bucket: Bucket;
+new NeuronxCompile(stack, "NeuronxCompile", {
+  vpc,
+  bucket,
+  model: Model.fromHuggingFace("example/example-7b-chat", {
+    parameters: Parameters.billion(7),
+  }),
+  spot: true,
+});
+```
+
+### Compile Options
+
+If you are familiar with Neuronx, you can also specify compilation options to better meet your requirements.
+
+```ts
+import { Vpc } from "aws-cdk-lib/aws-ec2";
+import { Bucket } from "aws-cdk-lib/aws-s3";
+
+declare const vpc: Vpc;
+declare const bucket: Bucket;
+new NeuronxCompile(stack, "NeuronxCompile", {
+  vpc,
+  bucket,
+  model: Model.fromHuggingFace("example/example-22b-chat", {
+    parameters: Parameters.billion(22),
+  }),
+  compileOptions: {
+    nPositions: 1024,
+    quantDtype: QuantDtype.S8,
+    optLevel: OptLevel.MODEL_EXECUTION_PERFORMANCE,
+  },
+});
+```

package/lib/.types-compat/ts3.9/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./neuronx-compile";
+export * from "./neuronx-instance-type";

package/lib/.types-compat/ts3.9/neuronx-compile.d.ts

@@ -0,0 +1,166 @@
+import { Size } from "aws-cdk-lib";
+import * as ec2 from "aws-cdk-lib/aws-ec2";
+import { ContainerImage } from "aws-cdk-lib/aws-ecs";
+import { IBucket } from "aws-cdk-lib/aws-s3";
+import { Construct } from "constructs";
+import { NeuronxInstanceType } from "./neuronx-instance-type";
+/**
+ * Compile runtime.
+ */
+export interface CompileRuntime {
+    /**
+     * An image of the container where the compile job is executed.
+     */
+    readonly image: ContainerImage;
+    /**
+     * Neuronx version included in container image.
+     */
+    readonly neuronxVersion: string;
+}
+/**
+ * Quant data type.
+ */
+export declare enum QuantDtype {
+    /**
+     * int8 weight storage.
+     */
+    S8 = "s8"
+}
+/**
+ * Optimization level.
+ */
+export declare enum OptLevel {
+    /**
+     * enables the core performance optimizations in the compiler, while also minimizing compile time.
+     */
+    MINIMIZING_COMPILE_TIME = 1,
+    /**
+     * provides the best balance between model performance and compile time.
+     */
+    BEST_BALANCE = 2,
+    /**
+     * may provide additional model execution performance but may incur longer compile times and higher host memory usage during model compilation.
+     */
+    MODEL_EXECUTION_PERFORMANCE = 3
+}
+/**
+ * Compile options.
+ */
+export interface CompileOptions {
+    /**
+     * @default - calc from parameters and quantDtype
+     */
+    readonly tpDegree?: number;
+    /**
+     * @default - No quant
+     */
+    readonly quantDtype?: QuantDtype;
+    /**
+     * @default 4092
+     */
+    readonly nPositions?: number;
+    /**
+     * @default OptLevel.BEST_BALANCE
+     */
+    readonly optLevel?: OptLevel;
+}
+/**
+ * Represents the amount of parameters.
+ */
+export declare class Parameters {
+    private readonly billion;
+    /**
+     * Create a Parameters representing an amount bilion.
+     * @param parameters number of parameters bilionX
+     * @returns parameters
+     */
+    static billion(parameters: number): Parameters;
+    private constructor();
+    /**
+     * Return this number of parameters as bilion.
+     * @returns This number of parameters as bilion.
+     */
+    toBilion(): number;
+}
+/**
+ * Compile target model basic infromation
+ */
+export interface ModelOptions {
+    readonly parameters: Parameters;
+}
+/**
+ * Compile target model.
+ */
+export declare class Model {
+    readonly modelId: string;
+    readonly options: ModelOptions;
+    /**
+     * model informations at HuggingFace
+     * @param modelId model id on the HuggingFace
+     * @param options model basic infromation
+     * @returns model instance
+     */
+    static fromHuggingFace(modelId: string, options: ModelOptions): Model;
+    private constructor();
+}
+/**
+ * Props of NeuronxCompile.
+ */
+export interface NeuronxCompileProps {
+    /**
+     * VPC in which this will launch compile worker instance.
+     */
+    readonly vpc: ec2.IVpc;
+    /**
+     * The instance type of compile worker instance.
+     */
+    readonly instanceType?: NeuronxInstanceType;
+    /**
+     * The bucket to upload compiled artifacts.
+     */
+    readonly bucket: IBucket;
+    /**
+     * The model to be compiled.
+     */
+    readonly model: Model;
+    /**
+     * The root volume of worker instance.
+     * @default - N bilion parameters * 5GiB EBS
+     */
+    readonly volumeSize?: Size;
+    /**
+     * Compile runtime.
+     * @default { neuronxSdkVersion: "2.19.0", image: ContainerImage.fromRegistry("public.ecr.aws/neuron/pytorch-training-neuronx:2.1.2-neuronx-py310-sdk2.19.0-ubuntu20.04")}
+     */
+    readonly runtime?: CompileRuntime;
+    /**
+     * Neuronx compile options.
+     * @default - Each properties are set default.
+     */
+    readonly compileOptions?: CompileOptions;
+    /**
+     * Whether or not to use spot instances. Spot instances are less expensive EC2 instances that can be reclaimed by EC2 at any time; your job will be given two minutes of notice before reclamation.
+     *
+     * @default false
+     */
+    readonly spot?: boolean;
+    /**
+     * The VPC Subnets this Compute Environment will launch instances in.
+     *
+     * @default - new subnets will be created
+     */
+    readonly vpcSubnets?: ec2.SubnetSelection;
+}
+/**
+ * Neuronx compile construct. Compile the model to work with Inferentia2 and Trainium1 and upload it to an S3 bucket.
+ */
+export declare class NeuronxCompile extends Construct {
+    /**
+     * S3 URL that compiled artifact uploaded.
+     */
+    readonly compiledArtifactS3Url: string;
+    constructor(scope: Construct, id: string, props: NeuronxCompileProps);
+    private connectAcceleratorChips;
+    private calcTpDegree;
+    private selectInstanceTypeByTpDegree;
+}

package/lib/.types-compat/ts3.9/neuronx-instance-type.d.ts

@@ -0,0 +1,44 @@
+import { Size } from "aws-cdk-lib";
+import * as ec2 from "aws-cdk-lib/aws-ec2";
+/**
+ *
+ */
+export interface IAcceleratorChips {
+    readonly chips: number;
+    readonly neuronxCores: number;
+    readonly acceleratorMemory: Size;
+}
+export declare class Inferentia2Chips implements IAcceleratorChips {
+    readonly chips: number;
+    readonly neuronxCores: number;
+    readonly acceleratorMemory: Size;
+    constructor(chips: number);
+}
+export declare class NeuronxInstanceType {
+    readonly instanceType: ec2.InstanceType;
+    readonly vCpu: number;
+    readonly memory: Size;
+    readonly acceleratorChips: IAcceleratorChips;
+    /**
+     * ml.inf2.xlarge
+     */
+    static readonly INF2_XLARGE: NeuronxInstanceType;
+    /**
+     * ml.inf2.8xlarge
+     */
+    static readonly INF2_8XLARGE: NeuronxInstanceType;
+    /**
+     * ml.inf2.24xlarge
+     */
+    static readonly INF2_24XLARGE: NeuronxInstanceType;
+    /**
+     * ml.inf2.48xlarge
+     */
+    static readonly INF2_48XLARGE: NeuronxInstanceType;
+    private constructor();
+    /**
+     * Return the instance type as a string
+     * @returns The instance type as a string
+     */
+    toString(): string;
+}

package/lib/.types-compat/ts3.9/private/await-compile-job/index.d.ts

@@ -0,0 +1,4 @@
+import type { CdkCustomResourceHandler, CdkCustomResourceIsCompleteHandler } from "aws-lambda";
+export declare const onEvent: CdkCustomResourceHandler;
+export declare const onCreate: CdkCustomResourceHandler;
+export declare const isComplete: CdkCustomResourceIsCompleteHandler;

package/lib/.types-compat/ts3.9/private/neuron-optimized-machine-image.d.ts

@@ -0,0 +1,8 @@
+import { IMachineImage, MachineImageConfig } from "aws-cdk-lib/aws-ec2";
+import { Construct } from "constructs";
+export declare class NeuronOptimizedMachineImage extends Construct implements IMachineImage {
+    private readonly resource;
+    get imageId(): string;
+    constructor(scope: Construct, id: string);
+    getImage(_scope: Construct): MachineImageConfig;
+}

package/lib/.types-compat/ts3.9/private/neuronx-ami/index.d.ts

@@ -0,0 +1,2 @@
+import type { CdkCustomResourceHandler } from "aws-lambda";
+export declare const onEvent: CdkCustomResourceHandler;

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./neuronx-compile";
+export * from "./neuronx-instance-type";

package/lib/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./neuronx-compile"), exports);
+__exportStar(require("./neuronx-instance-type"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLG9EQUFrQztBQUNsQywwREFBd0MiLCJzb3VyY2VzQ29udGVudCI6WyJleHBvcnQgKiBmcm9tIFwiLi9uZXVyb254LWNvbXBpbGVcIjtcbmV4cG9ydCAqIGZyb20gXCIuL25ldXJvbngtaW5zdGFuY2UtdHlwZVwiO1xuIl19