Skip to content

Commit be63a86

Browse files
authored
fix(models): fix issue for python to synth Jumpstart and HuggingFace models constructs (#218)
1 parent 80231df commit be63a86

11 files changed

+172
-172
lines changed

apidocs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@
3131
- [AdapterProps](interfaces/AdapterProps.md)
3232
- [ContainerImageConfig](interfaces/ContainerImageConfig.md)
3333
- [CustomSageMakerEndpointProps](interfaces/CustomSageMakerEndpointProps.md)
34-
- [IHuggingFaceSageMakerEndpointProps](interfaces/IHuggingFaceSageMakerEndpointProps.md)
34+
- [HuggingFaceSageMakerEndpointProps](interfaces/HuggingFaceSageMakerEndpointProps.md)
3535
- [IInstanceAliase](interfaces/IInstanceAliase.md)
3636
- [IInstanceValiant](interfaces/IInstanceValiant.md)
3737
- [IJumpStartModelSpec](interfaces/IJumpStartModelSpec.md)
38-
- [IJumpStartSageMakerEndpointProps](interfaces/IJumpStartSageMakerEndpointProps.md)
38+
- [JumpStartSageMakerEndpointProps](interfaces/JumpStartSageMakerEndpointProps.md)
3939
- [LangchainLayerProps](interfaces/LangchainLayerProps.md)
4040
- [LangchainProps](interfaces/LangchainProps.md)
4141
- [QaAppsyncOpensearchProps](interfaces/QaAppsyncOpensearchProps.md)

apidocs/classes/HuggingFaceSageMakerEndpoint.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ The HuggingFaceSageMakerEndpoint class.
5757
| :------ | :------ |
5858
| `scope` | `Construct` |
5959
| `id` | `string` |
60-
| `props` | [`IHuggingFaceSageMakerEndpointProps`](../interfaces/IHuggingFaceSageMakerEndpointProps.md) |
60+
| `props` | [`HuggingFaceSageMakerEndpointProps`](../interfaces/HuggingFaceSageMakerEndpointProps.md) |
6161

6262
#### Returns
6363

apidocs/classes/JumpStartSageMakerEndpoint.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ The JumpStartSageMakerEndpoint class.
5959
| :------ | :------ |
6060
| `scope` | `Construct` |
6161
| `id` | `string` |
62-
| `props` | [`IJumpStartSageMakerEndpointProps`](../interfaces/IJumpStartSageMakerEndpointProps.md) |
62+
| `props` | [`JumpStartSageMakerEndpointProps`](../interfaces/JumpStartSageMakerEndpointProps.md) |
6363

6464
#### Returns
6565

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
[@cdklabs/generative-ai-cdk-constructs](../README.md) / HuggingFaceSageMakerEndpointProps
2+
3+
# Interface: HuggingFaceSageMakerEndpointProps
4+
5+
## Table of contents
6+
7+
### Properties
8+
9+
- [container](HuggingFaceSageMakerEndpointProps.md#container)
10+
- [endpointName](HuggingFaceSageMakerEndpointProps.md#endpointname)
11+
- [environment](HuggingFaceSageMakerEndpointProps.md#environment)
12+
- [instanceCount](HuggingFaceSageMakerEndpointProps.md#instancecount)
13+
- [instanceType](HuggingFaceSageMakerEndpointProps.md#instancetype)
14+
- [modelId](HuggingFaceSageMakerEndpointProps.md#modelid)
15+
- [role](HuggingFaceSageMakerEndpointProps.md#role)
16+
- [startupHealthCheckTimeoutInSeconds](HuggingFaceSageMakerEndpointProps.md#startuphealthchecktimeoutinseconds)
17+
- [vpcConfig](HuggingFaceSageMakerEndpointProps.md#vpcconfig)
18+
19+
## Properties
20+
21+
### container
22+
23+
`Readonly` **container**: [`ContainerImage`](../classes/ContainerImage.md)
24+
25+
___
26+
27+
### endpointName
28+
29+
`Optional` `Readonly` **endpointName**: `string`
30+
31+
___
32+
33+
### environment
34+
35+
`Optional` `Readonly` **environment**: `Object`
36+
37+
#### Index signature
38+
39+
[key: `string`]: `string`
40+
41+
___
42+
43+
### instanceCount
44+
45+
`Optional` `Readonly` **instanceCount**: `number`
46+
47+
___
48+
49+
### instanceType
50+
51+
`Readonly` **instanceType**: [`SageMakerInstanceType`](../classes/SageMakerInstanceType.md)
52+
53+
___
54+
55+
### modelId
56+
57+
`Readonly` **modelId**: `string`
58+
59+
___
60+
61+
### role
62+
63+
`Optional` `Readonly` **role**: `Role`
64+
65+
___
66+
67+
### startupHealthCheckTimeoutInSeconds
68+
69+
`Optional` `Readonly` **startupHealthCheckTimeoutInSeconds**: `number`
70+
71+
___
72+
73+
### vpcConfig
74+
75+
`Optional` `Readonly` **vpcConfig**: `VpcConfigProperty`

apidocs/interfaces/IHuggingFaceSageMakerEndpointProps.md

Lines changed: 0 additions & 75 deletions
This file was deleted.

apidocs/interfaces/IJumpStartSageMakerEndpointProps.md

Lines changed: 0 additions & 68 deletions
This file was deleted.
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
[@cdklabs/generative-ai-cdk-constructs](../README.md) / JumpStartSageMakerEndpointProps
2+
3+
# Interface: JumpStartSageMakerEndpointProps
4+
5+
## Table of contents
6+
7+
### Properties
8+
9+
- [endpointName](JumpStartSageMakerEndpointProps.md#endpointname)
10+
- [environment](JumpStartSageMakerEndpointProps.md#environment)
11+
- [instanceCount](JumpStartSageMakerEndpointProps.md#instancecount)
12+
- [instanceType](JumpStartSageMakerEndpointProps.md#instancetype)
13+
- [model](JumpStartSageMakerEndpointProps.md#model)
14+
- [role](JumpStartSageMakerEndpointProps.md#role)
15+
- [startupHealthCheckTimeoutInSeconds](JumpStartSageMakerEndpointProps.md#startuphealthchecktimeoutinseconds)
16+
- [vpcConfig](JumpStartSageMakerEndpointProps.md#vpcconfig)
17+
18+
## Properties
19+
20+
### endpointName
21+
22+
`Optional` `Readonly` **endpointName**: `string`
23+
24+
___
25+
26+
### environment
27+
28+
`Optional` `Readonly` **environment**: `Object`
29+
30+
#### Index signature
31+
32+
[key: `string`]: `string`
33+
34+
___
35+
36+
### instanceCount
37+
38+
`Optional` `Readonly` **instanceCount**: `number`
39+
40+
___
41+
42+
### instanceType
43+
44+
`Optional` `Readonly` **instanceType**: [`SageMakerInstanceType`](../classes/SageMakerInstanceType.md)
45+
46+
___
47+
48+
### model
49+
50+
`Readonly` **model**: [`JumpStartModel`](../classes/JumpStartModel.md)
51+
52+
___
53+
54+
### role
55+
56+
`Optional` `Readonly` **role**: `Role`
57+
58+
___
59+
60+
### startupHealthCheckTimeoutInSeconds
61+
62+
`Optional` `Readonly` **startupHealthCheckTimeoutInSeconds**: `number`
63+
64+
___
65+
66+
### vpcConfig
67+
68+
`Optional` `Readonly` **vpcConfig**: `VpcConfigProperty`

src/patterns/gen-ai/aws-model-deployment-sagemaker/README_hugging_face.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,14 +68,14 @@ new HuggingFaceSageMakerEndpoint(this, 'Mistral', {
6868
## Initializer
6969

7070
```
71-
new HuggingFaceSageMakerEndpoint(scope: Construct, id: string, props: IHuggingFaceSageMakerEndpointProps)
71+
new HuggingFaceSageMakerEndpoint(scope: Construct, id: string, props: HuggingFaceSageMakerEndpointProps)
7272
```
7373

7474
Parameters
7575

7676
- scope [Construct](https://docs.aws.amazon.com/cdk/api/v2/docs/constructs.Construct.html)
7777
- id string
78-
- props IHuggingFaceSageMakerEndpointProps
78+
- props HuggingFaceSageMakerEndpointProps
7979

8080
## Pattern Construct Props
8181

src/patterns/gen-ai/aws-model-deployment-sagemaker/README_jumpstart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,14 +61,14 @@ new JumpStartSageMakerEndpoint(this, 'LLAMA2', {
6161
## Initializer
6262

6363
```
64-
new JumpStartSageMakerEndpoint(scope: Construct, id: string, props: IJumpStartSageMakerEndpointProps)
64+
new JumpStartSageMakerEndpoint(scope: Construct, id: string, props: JumpStartSageMakerEndpointProps)
6565
```
6666

6767
Parameters
6868

6969
- scope [Construct](https://docs.aws.amazon.com/cdk/api/v2/docs/constructs.Construct.html)
7070
- id string
71-
- props IJumpStartSageMakerEndpointProps
71+
- props JumpStartSageMakerEndpointProps
7272

7373
## Pattern Construct Props
7474

src/patterns/gen-ai/aws-model-deployment-sagemaker/huggingface-sagemaker-endpoint.ts

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,16 @@ import { ContainerImage } from './container-image';
1818
import { SageMakerEndpointBase } from './sagemaker-endpoint-base';
1919
import { SageMakerInstanceType } from './sagemaker-instance-type';
2020

21-
export interface IHuggingFaceSageMakerEndpointProps {
22-
modelId: string;
23-
container: ContainerImage;
24-
endpointName?: string;
25-
instanceType: SageMakerInstanceType;
26-
instanceCount?: number;
27-
role?: iam.Role;
28-
environment?: { [key: string]: string };
29-
startupHealthCheckTimeoutInSeconds?: number;
30-
vpcConfig?: sagemaker.CfnModel.VpcConfigProperty | undefined;
21+
export interface HuggingFaceSageMakerEndpointProps {
22+
readonly modelId: string;
23+
readonly container: ContainerImage;
24+
readonly endpointName?: string;
25+
readonly instanceType: SageMakerInstanceType;
26+
readonly instanceCount?: number;
27+
readonly role?: iam.Role;
28+
readonly environment?: { [key: string]: string };
29+
readonly startupHealthCheckTimeoutInSeconds?: number;
30+
readonly vpcConfig?: sagemaker.CfnModel.VpcConfigProperty | undefined;
3131
}
3232

3333
/**
@@ -48,7 +48,7 @@ export class HuggingFaceSageMakerEndpoint extends SageMakerEndpointBase implemen
4848
private readonly startupHealthCheckTimeoutInSeconds: number;
4949
private readonly environment?: { [key: string]: string };
5050

51-
constructor(scope: Construct, id: string, props: IHuggingFaceSageMakerEndpointProps) {
51+
constructor(scope: Construct, id: string, props: HuggingFaceSageMakerEndpointProps) {
5252
super(scope, id);
5353

5454
this.modelId = props.modelId;

0 commit comments

Comments
 (0)