Skip to content

Commit 93a1048

Browse files
committed
Update: update README.md
1 parent 6d3e468 commit 93a1048

File tree

1 file changed

+19
-17
lines changed

1 file changed

+19
-17
lines changed

README.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This solution refers to [amazon-sagemaker-examples: automate_model_retraining_wo
2525
- [Amazon SageMaker Built-in Algorithms Docker Path](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html)
2626
- [Amazon SageMaker Built-in Algorithms Data Format](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-common-data-formats.html)
2727

28-
Note that using SageMaker built-in algorithms is very convenient because we only need to focus on the data.
28+
Note that using SageMaker built-in algorithms is very convenient because we only need to focus on a data, not model.
2929

3030
## CDK-Project Build & Deploy
3131

@@ -47,12 +47,12 @@ Because this solusion is implemented in CDK, we can deploy these cloud resources
4747

4848
First of all, AWS Account and IAM User is required. And then the following modules must be installed.
4949

50-
- AWS CLI: aws configure --profile [profile name]
50+
- AWS CLI: aws --version
5151
- Node.js: node --version
5252
- AWS CDK: cdk --version
5353
- [jq](https://stedolan.github.io/jq/): jq --version
5454

55-
Please refer to the kind guide in [CDK Workshop](https://cdkworkshop.com/15-prerequisites.html).
55+
Please refer to a kind guide in [CDK Workshop](https://cdkworkshop.com/15-prerequisites.html).
5656

5757
### **Configure AWS Credential**
5858

@@ -75,37 +75,39 @@ aws sts get-caller-identity --profile [your-profile]
7575

7676
### **Check CDK project's entry-point**
7777

78-
In this CDK project, a entry-point file is **infra/app-main.ts** which is described in `cdk.json`.
78+
In this CDK project, a entry-point file is **infra/app-main.ts** which is described in `cdk.json`.
7979

80-
### **Set up deploy config**
80+
### **Set up deploy configuration**
8181

82-
The `config/app-config-demo.json` file describes how to configure deploy condition & stack condition. First of all, change project configurations(Account, Profile are essential) in ```config/app-config-demo.json```.
82+
This project is based on [aws-cdk-project-template-for-devops](https://github.com/aws-samples/aws-cdk-project-template-for-devops), which adopts configuration driven development(CDD). So let's set up configuration file(`config/app-config-demo.json`), which describes deployment target information(account/region) and how to configure each stack properties.
83+
84+
First of all, change deployment target information(account/region) in ```config/app-config-demo.json``` according to your AWS accout environment.
8385

8486
```json
8587
{
8688
"Project": {
87-
"Name": "MLOpsPipeline", <----- Optional: your project name, all stacks wil be prefixed with [Project.Name+Project.Stage]
88-
"Stage": "Demo", <----- Optional: your project stage, all stacks wil be prefixed with [Project.Name+Project.Stage]
89-
"Account": "75157*******", <----- Essential: update according to your AWS Account
90-
"Region": "us-east-2", <----- Essential: update according to your target resion
91-
"Profile": "cdk-demo" <----- Essential: AWS Profile, keep empty string if no profile configured
89+
"Name": "MLOpsPipeline", <----- your project name, all stacks wil be prefixed with [Project.Name+Project.Stage]
90+
"Stage": "Demo", <----- your project stage, all stacks wil be prefixed with [Project.Name+Project.Stage]
91+
"Account": "75157*******", <----- update according to your AWS Account
92+
"Region": "us-east-2", <----- update according to your target resion
93+
"Profile": "cdk-demo" <----- AWS Profile, keep empty string if no profile configured
9294
},
9395
...
9496
...
9597
}
9698
```
9799

98-
And then set the path of this json configuration file through an environment variable.
100+
And then set the path of this json configuration file through setting up environment variable.
99101

100102
```bash
101103
export APP_CONFIG=config/app-config-demo.json
102104
```
103105

104-
Through this external configuration injection, multiple deployments(multiple account, multiple region, multiple stage) are possible without code modification.
106+
Through this external configuration injection, multiple deployments(multiple account, multiple region, multiple stage) are possible without code modification. For example, we can maintain a variety of configuration files such as `app-config-dev.json`, `app-config-test.json` and `app-config-prod.json` at the same time.
105107

106108
### **Install dependecies & Bootstrap**
107109

108-
For more details, open `script/setup_initial.sh` file.
110+
Execute the following command, which will check versions and install dependencies intead of us. For more details, open `script/setup_initial.sh` file.
109111

110112
```bash
111113
sh script/setup_initial.sh config/app-config-demo.json
@@ -157,13 +159,13 @@ Many resources such as Lambda/SageMakerTrainingJob/GlueETLJob have been deployed
157159

158160
### **Prepare a input data**
159161

160-
Download sample data by running the following command:
162+
Download sample data by running the following command, where `sed` command is used to remove `"` character in each line.
161163

162164
```bash
163165
sh codes/glue/churn-xgboost/script/download_data.sh
164166
```
165167

166-
A sample data will be downloaded in `codes/glue/churn-xgboost/data/input.csv`, and double quotes in this file will be removded to format `csv`.
168+
A sample data will be downloaded in `codes/glue/churn-xgboost/data/input.csv`.
167169

168170
### **Trigger the StateMachine in Step Functions**
169171

@@ -233,7 +235,7 @@ Amazon SageMaker Training Job Result in AWS S3 Bucket
233235

234236
### **How to invoke SageMaker-Endpoint**
235237

236-
Finally, let's inovoke `SageMaker Endpoint` to make sure it works well.
238+
Finally, let's invoke `SageMaker Endpoint` to make sure it works well.
237239

238240
Before invocation, open `codes/glue/churn-xgboost/script/test_invoke.py` file, and update `profile name` and `endpoint name` according to your configuration.
239241

0 commit comments

Comments
 (0)