-
Notifications
You must be signed in to change notification settings - Fork 59
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add website documentation site
- Loading branch information
1 parent
5f8b601
commit 802974a
Showing
98 changed files
with
28,614 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
.docusaurus | ||
build |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# Website | ||
|
||
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. | ||
|
||
### Installation | ||
|
||
``` | ||
$ yarn install | ||
``` | ||
|
||
### Local Development | ||
|
||
``` | ||
$ yarn run start | ||
``` | ||
|
||
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. | ||
|
||
### Build | ||
|
||
``` | ||
$ yarn run build | ||
``` | ||
|
||
This command generates static content into the `build` directory and can be served using any static contents hosting service. | ||
|
||
### Testing your Build Locally | ||
It is important to test your build locally before deploying it for production. Docusaurus provides a docusaurus serve command for that: | ||
|
||
``` | ||
$ yarn run serve | ||
``` | ||
|
||
By default, this will load your site at http://localhost:3000/. | ||
|
||
### Deployment | ||
|
||
Deployment of this site is done through GitHub workflows. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
module.exports = { | ||
presets: [require.resolve('@docusaurus/core/lib/babel/preset')], | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
[@cdklabs/generative-ai-cdk-constructs](/docs/api) / ContainerImage | ||
|
||
# Class: ContainerImage | ||
|
||
https://github.com/aws/deep-learning-containers/blob/master/available_images.md | ||
|
||
## Hierarchy | ||
|
||
- **`ContainerImage`** | ||
|
||
↳ [`DeepLearningContainerImage`](DeepLearningContainerImage.md) | ||
|
||
## Constructors | ||
|
||
### constructor | ||
|
||
• **new ContainerImage**(): [`ContainerImage`](ContainerImage.md) | ||
|
||
#### Returns | ||
|
||
[`ContainerImage`](ContainerImage.md) | ||
|
||
## Methods | ||
|
||
### bind | ||
|
||
▸ **bind**(`scope`, `grantable`): [`ContainerImageConfig`](/docs/api/interfaces/ContainerImageConfig.md) | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `scope` | `Construct` | | ||
| `grantable` | `IGrantable` | | ||
|
||
#### Returns | ||
|
||
[`ContainerImageConfig`](/docs/api/interfaces/ContainerImageConfig.md) | ||
|
||
___ | ||
|
||
### fromAsset | ||
|
||
▸ **fromAsset**(`directory`, `options?`): [`ContainerImage`](ContainerImage.md) | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `directory` | `string` | | ||
| `options` | `DockerImageAssetOptions` | | ||
|
||
#### Returns | ||
|
||
[`ContainerImage`](ContainerImage.md) | ||
|
||
___ | ||
|
||
### fromEcrRepository | ||
|
||
▸ **fromEcrRepository**(`repository`, `tag?`): [`ContainerImage`](ContainerImage.md) | ||
|
||
#### Parameters | ||
|
||
| Name | Type | Default value | | ||
| :------ | :------ | :------ | | ||
| `repository` | `IRepository` | `undefined` | | ||
| `tag` | `string` | `'latest'` | | ||
|
||
#### Returns | ||
|
||
[`ContainerImage`](ContainerImage.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,239 @@ | ||
[@cdklabs/generative-ai-cdk-constructs](/docs/api) / CustomSageMakerEndpoint | ||
|
||
# Class: CustomSageMakerEndpoint | ||
|
||
## Hierarchy | ||
|
||
- [`SageMakerEndpointBase`](SageMakerEndpointBase.md) | ||
|
||
↳ **`CustomSageMakerEndpoint`** | ||
|
||
## Implements | ||
|
||
- `IGrantable` | ||
|
||
## Constructors | ||
|
||
### constructor | ||
|
||
• **new CustomSageMakerEndpoint**(`scope`, `id`, `props`): [`CustomSageMakerEndpoint`](CustomSageMakerEndpoint.md) | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------ |:---------------------------------------------------------------------------------------| | ||
| `scope` | `Construct` | | ||
| `id` | `string` | | ||
| `props` | [`CustomSageMakerEndpointProps`](/docs/api/interfaces/CustomSageMakerEndpointProps.md) | | ||
|
||
#### Returns | ||
|
||
[`CustomSageMakerEndpoint`](/docs/api/classes/CustomSageMakerEndpoint) | ||
|
||
#### Overrides | ||
|
||
[SageMakerEndpointBase](SageMakerEndpointBase.md).[constructor](SageMakerEndpointBase.md#constructor) | ||
|
||
## Properties | ||
|
||
### cfnEndpoint | ||
|
||
• `Readonly` **cfnEndpoint**: `CfnEndpoint` | ||
|
||
___ | ||
|
||
### cfnEndpointConfig | ||
|
||
• `Readonly` **cfnEndpointConfig**: `CfnEndpointConfig` | ||
|
||
___ | ||
|
||
### cfnModel | ||
|
||
• `Readonly` **cfnModel**: `CfnModel` | ||
|
||
___ | ||
|
||
### endpointArn | ||
|
||
• `Readonly` **endpointArn**: `string` | ||
|
||
___ | ||
|
||
### environment | ||
|
||
• `Private` `Optional` `Readonly` **environment**: `Object` | ||
|
||
#### Index signature | ||
|
||
▪ [key: `string`]: `string` | ||
|
||
___ | ||
|
||
### grantPrincipal | ||
|
||
• `Readonly` **grantPrincipal**: `IPrincipal` | ||
|
||
#### Implementation of | ||
|
||
iam.IGrantable.grantPrincipal | ||
|
||
___ | ||
|
||
### instanceCount | ||
|
||
• `Readonly` **instanceCount**: `number` | ||
|
||
___ | ||
|
||
### instanceType | ||
|
||
• `Optional` `Readonly` **instanceType**: [`SageMakerInstanceType`](SageMakerInstanceType.md) | ||
|
||
___ | ||
|
||
### modelDataDownloadTimeoutInSeconds | ||
|
||
• `Readonly` **modelDataDownloadTimeoutInSeconds**: `number` | ||
|
||
___ | ||
|
||
### modelDataUrl | ||
|
||
• `Readonly` **modelDataUrl**: `string` | ||
|
||
___ | ||
|
||
### modelId | ||
|
||
• `Readonly` **modelId**: `string` | ||
|
||
___ | ||
|
||
### node | ||
|
||
• `Readonly` **node**: `Node` | ||
|
||
The tree node. | ||
|
||
#### Inherited from | ||
|
||
[SageMakerEndpointBase](SageMakerEndpointBase.md).[node](SageMakerEndpointBase.md#node) | ||
|
||
___ | ||
|
||
### role | ||
|
||
• `Readonly` **role**: `Role` | ||
|
||
___ | ||
|
||
### startupHealthCheckTimeoutInSeconds | ||
|
||
• `Private` `Readonly` **startupHealthCheckTimeoutInSeconds**: `number` | ||
|
||
___ | ||
|
||
### volumeSizeInGb | ||
|
||
• `Optional` `Readonly` **volumeSizeInGb**: `number` | ||
|
||
## Methods | ||
|
||
### addToRolePolicy | ||
|
||
▸ **addToRolePolicy**(`statement`): `void` | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `statement` | `PolicyStatement` | | ||
|
||
#### Returns | ||
|
||
`void` | ||
|
||
___ | ||
|
||
### createSageMakerRole | ||
|
||
▸ **createSageMakerRole**(): `Role` | ||
|
||
#### Returns | ||
|
||
`Role` | ||
|
||
#### Inherited from | ||
|
||
[SageMakerEndpointBase](SageMakerEndpointBase.md).[createSageMakerRole](SageMakerEndpointBase.md#createsagemakerrole) | ||
|
||
___ | ||
|
||
### grantInvoke | ||
|
||
▸ **grantInvoke**(`grantee`): `Grant` | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `grantee` | `IGrantable` | | ||
|
||
#### Returns | ||
|
||
`Grant` | ||
|
||
___ | ||
|
||
### toString | ||
|
||
▸ **toString**(): `string` | ||
|
||
Returns a string representation of this construct. | ||
|
||
#### Returns | ||
|
||
`string` | ||
|
||
#### Inherited from | ||
|
||
[SageMakerEndpointBase](SageMakerEndpointBase.md).[toString](SageMakerEndpointBase.md#tostring) | ||
|
||
___ | ||
|
||
### isConstruct | ||
|
||
▸ **isConstruct**(`x`): x is Construct | ||
|
||
Checks if `x` is a construct. | ||
|
||
Use this method instead of `instanceof` to properly detect `Construct` | ||
instances, even when the construct library is symlinked. | ||
|
||
Explanation: in JavaScript, multiple copies of the `constructs` library on | ||
disk are seen as independent, completely different libraries. As a | ||
consequence, the class `Construct` in each copy of the `constructs` library | ||
is seen as a different class, and an instance of one class will not test as | ||
`instanceof` the other class. `npm install` will not create installations | ||
like this, but users may manually symlink construct libraries together or | ||
use a monorepo tool: in those cases, multiple copies of the `constructs` | ||
library can be accidentally installed, and `instanceof` will behave | ||
unpredictably. It is safest to avoid using `instanceof`, and using | ||
this type-testing method instead. | ||
|
||
#### Parameters | ||
|
||
| Name | Type | Description | | ||
| :------ | :------ | :------ | | ||
| `x` | `any` | Any object | | ||
|
||
#### Returns | ||
|
||
x is Construct | ||
|
||
true if `x` is an object created from a class which extends `Construct`. | ||
|
||
#### Inherited from | ||
|
||
[SageMakerEndpointBase](SageMakerEndpointBase.md).[isConstruct](SageMakerEndpointBase.md#isconstruct) |
Oops, something went wrong.