From 75801d219c7f08c55b4b83f80135428faab006e2 Mon Sep 17 00:00:00 2001
From: Prashant Srivastava <prashant.srivastava@xebia.com>
Date: Thu, 21 Aug 2025 09:40:23 +0200
Subject: [PATCH] Add details about setting up AWS

---
 .env.example           |  2 ++
 .gitignore             |  5 ++++-
 README.md              | 15 ++++++++++++---
 supervised/params.yaml |  2 +-
 zero_shot/params.yaml  |  2 +-
 5 files changed, 20 insertions(+), 6 deletions(-)
 create mode 100644 .env.example

diff --git a/.env.example b/.env.example
new file mode 100644
index 00000000..adf04d7e
--- /dev/null
+++ b/.env.example
@@ -0,0 +1,2 @@
+AWS_ACCOUNT_ID=
+AWS_PROFILE=
\ No newline at end of file
diff --git a/.gitignore b/.gitignore
index 97480ba7..cc111cd6 100644
--- a/.gitignore
+++ b/.gitignore
@@ -15,4 +15,7 @@ wheels/
 .DS_Store
 
 # Git
-git-auth.txt
\ No newline at end of file
+git-auth.txt
+
+# Environment variables
+.env
\ No newline at end of file
diff --git a/README.md b/README.md
index b31eabfe..a941e68f 100644
--- a/README.md
+++ b/README.md
@@ -56,9 +56,18 @@ The difference of the AWS environment is that:
 > In order to use the AWS environment, you need to set up your AWS profile with the below steps:
 > 1. Execute `aws configure sso`.
 > 2. Fill in the required fields, especially: "Default client Region" is "us-east-1".
-> 3. You can find your account ID and profile by executing `cat ~/.aws/config`.
-> 4. Finally, you can run `dvc repro` with environment variables in each game: `AWS_ACCOUNT_ID=xxx AWS_PROFILE=yyy dvc repro`.
-> 5. Before you run `dvc repro`, you need to change the filename of `dvc.aws.yaml` to `dvc.yaml`.
+>   a. SSO session name: `pg2benchmark`.
+>   b. SSO start URL: https://d-90674355f1.awsapps.com/start
+>   c. SSO region: `us-east-1`.
+>   d. SSO registration scopes: Leave empty.
+>   e. Login via browser.
+> 2. Select the account: `ifflabdev`.
+>   a. Default client Region is `us-east-1`.
+>   b. CLI default ouptut: Leave empty.
+>   c. Profile name: `pg2benchmark`.
+> 4. You can find your account ID and profile by executing `cat ~/.aws/config`.
+> 5. Finally, you can run `dvc repro` with environment variables in each game: `AWS_ACCOUNT_ID=xxx AWS_PROFILE=yyy dvc repro`
+> 6. Before you run `dvc repro`, you need to change the filename of `dvc.aws.yaml` to `dvc.yaml`.
 
 #### Supervised
 
diff --git a/supervised/params.yaml b/supervised/params.yaml
index 61ea5976..cb7ed7b4 100644
--- a/supervised/params.yaml
+++ b/supervised/params.yaml
@@ -1,7 +1,7 @@
 aws:
   account_id: ${AWS_ACCOUNT_ID}
   region_name: "us-east-1"
-  sagemaker_role_name: "rnd-dev-sagemakerexecutionrole "
+  sagemaker_role_name: "rnd-dev-sagemakerexecutionrole"
   s3_output_prefix: "mango-pe/pg2-benchmark-output"
   s3_training_data_prefix: "mango-pe/pg2-benchmark-training-data"
   instance_type: "ml.m5.xlarge"
diff --git a/zero_shot/params.yaml b/zero_shot/params.yaml
index 61ea5976..cb7ed7b4 100644
--- a/zero_shot/params.yaml
+++ b/zero_shot/params.yaml
@@ -1,7 +1,7 @@
 aws:
   account_id: ${AWS_ACCOUNT_ID}
   region_name: "us-east-1"
-  sagemaker_role_name: "rnd-dev-sagemakerexecutionrole "
+  sagemaker_role_name: "rnd-dev-sagemakerexecutionrole"
   s3_output_prefix: "mango-pe/pg2-benchmark-output"
   s3_training_data_prefix: "mango-pe/pg2-benchmark-training-data"
   instance_type: "ml.m5.xlarge"