Skip to content

Commit 93f8034

Browse files
authored
docs: installation, CARM, CRM and adopted resource (#35)
1 parent c2bb2f4 commit 93f8034

File tree

13 files changed

+522
-15
lines changed

13 files changed

+522
-15
lines changed

README.md

Lines changed: 496 additions & 0 deletions
Large diffs are not rendered by default.

samples/README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,23 @@ This sample demonstrates how to start jobs using your own script, packaged in a
44

55
## Prerequisites
66

7-
This sample assumes that you have already configured an Kubernetes cluster with the ACK operator. It also assumes that you have installed `kubectl` - you can find a link on our [installation page](To do).
7+
Follow the instructions on our [installation page](/README.md#getting-started) to create a Kubernetes cluster and install sagemaker controller.
88

9-
You will also need an IAM role which has permissions to access your S3 resources and SageMaker. If you have not yet created a role with these permissions, you can find an example policy at [Amazon SageMaker Roles](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html#sagemaker-roles-createtrainingjob-perms).
9+
Run the following commands to create a SageMaker execution IAM role which is used by SageMaker service to access AWS resources.
1010

11+
```
12+
export SAGEMAKER_EXECUTION_ROLE_NAME=ack-sagemaker-execution-role-$CLUSTER_NAME
13+
14+
TRUST="{ \"Version\": \"2012-10-17\", \"Statement\": [ { \"Effect\": \"Allow\", \"Principal\": { \"Service\": \"sagemaker.amazonaws.com\" }, \"Action\": \"sts:AssumeRole\" } ] }"
15+
aws iam create-role --role-name ${SAGEMAKER_EXECUTION_ROLE_NAME} --assume-role-policy-document "$TRUST"
16+
aws iam attach-role-policy --role-name ${SAGEMAKER_EXECUTION_ROLE_NAME} --policy-arn arn:aws:iam::aws:policy/AmazonSageMakerFullAccess
17+
aws iam attach-role-policy --role-name ${SAGEMAKER_EXECUTION_ROLE_NAME} --policy-arn arn:aws:iam::aws:policy/AmazonS3FullAccess
18+
19+
SAGEMAKER_EXECUTION_ROLE_ARN=$(aws iam get-role --role-name ${SAGEMAKER_EXECUTION_ROLE_NAME} --output text --query 'Role.Arn')
20+
21+
echo $SAGEMAKER_EXECUTION_ROLE_ARN
22+
```
23+
Note down the execution role ARN to use in samples
1124
### Creating your first Job
1225

1326
The easiest way to start is taking a look at the sample training jobs and its corresponding [README](/samples/training/README.md)

samples/batch_transform/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This sample demonstrates how to start batch transform jobs using your own batch-
44

55
## Prerequisites
66

7-
This sample assumes that you have already configured an Kubernetes cluster with the ACK operator. It also assumes that you have installed `kubectl` - you can find a link on our [installation page](To do).
7+
This sample assumes that you have completed the [common prerequisties](/samples/README.md).
88

99
You will also need a model in SageMaker for this sample. If you do not have one you must first create a [model](/samples/model/README.md).
1010

samples/endpoint/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This sample demonstrates how to create Endpoints using your own Endpoint_base/co
44

55
## Prerequisites
66

7-
This sample assumes that you have already configured an Kubernetes cluster with the ACK operator. It also assumes that you have installed `kubectl` - you can find a link on our [installation page](To do).
7+
This sample assumes that you have completed the [common prerequisties](/samples/README.md).
88

99
You will also need a model in SageMaker for this sample. If you do not have one you must first create a [model](/samples/model/README.md)
1010

samples/hyperparameter_tuning/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@ This sample demonstrates how to start hyperparameter jobs using your own hyperpa
44

55
## Prerequisites
66

7-
This sample assumes that you have already configured an Kubernetes cluster with the ACK operator. It also assumes that you have installed `kubectl` - you can find a link on our [installation page](To do).
8-
9-
In order to follow this script, you must first create a hyperparameter script packaged in a Dockerfile that is [compatible with Amazon SageMaker](https://docs.aws.amazon.com/sagemaker/latest/dg/amazon-sagemaker-containers.html). Here is a list of available [containers](https://github.com/aws/deep-learning-containers/blob/master/available_images.md)
7+
This sample assumes that you have completed the [common prerequisties](/samples/README.md).
108

119
### Get an Image
1210

samples/job_definitions/data_quality/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This sample demonstrates how to start data quality job definitions using your ow
44

55
## Prerequisites
66

7-
This sample assumes that you have already configured an Kubernetes cluster with the ACK operator. It also assumes that you have installed `kubectl` - you can find a link on our [installation page](To do).
7+
This sample assumes that you have completed the [common prerequisties](/samples/README.md).
88

99
You will need an [Endpoint](/samples/endpoint/README.md) configured in SageMaker and you will need to run a baselining job to generate baseline statistics and constraints.
1010

samples/job_definitions/model_bias/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This sample demonstrates how to start model-bias job definitions using your own
44

55
## Prerequisites
66

7-
This sample assumes that you have already configured an Kubernetes cluster with the ACK operator. It also assumes that you have installed `kubectl` - you can find a link on our [installation page](To do).
7+
This sample assumes that you have completed the [common prerequisties](/samples/README.md).
88

99
You will also need an [Endpoint](/samples/endpoint/README.md) configured in SageMaker and you will need to run a baselining job to generate baseline constraints only.
1010

samples/job_definitions/model_explainability/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This sample demonstrates how to start model-explainability job definitions using
44

55
## Prerequisites
66

7-
This sample assumes that you have already configured an Kubernetes cluster with the ACK operator. It also assumes that you have installed `kubectl` - you can find a link on our [installation page](To do).
7+
This sample assumes that you have completed the [common prerequisties](/samples/README.md).
88

99
You will also need an [Endpoint](/samples/endpoint/README.md) configured in SageMaker and you will need to run a baselining job to generate baseline constraints only.
1010

samples/job_definitions/model_quality/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This sample demonstrates how to start model-quality job definitions using your o
44

55
## Prerequisites
66

7-
This sample assumes that you have already configured an Kubernetes cluster with the ACK operator. It also assumes that you have installed `kubectl` - you can find a link on our [installation page](To do).
7+
This sample assumes that you have completed the [common prerequisties](/samples/README.md).
88

99
You will also need an [Endpoint](/samples/endpoint/README.md) configured in SageMaker and you will need to run a baselining job to generate baseline constraints only.
1010

samples/model/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This sample demonstrates how to start models/create a model using your own model
44

55
## Prerequisites
66

7-
This sample assumes that you have already configured an Kubernetes cluster with the ACK operator. It also assumes that you have installed `kubectl` - you can find a link on our [installation page](To do).
7+
This sample assumes that you have completed the [common prerequisties](/samples/README.md).
88

99
### Get an Image
1010

0 commit comments

Comments
 (0)