Skip to content

Commit 4a6c179

Browse files
authored
Merge pull request #325 from gridai/dev
0.8.75 Docs Release
2 parents 5367c60 + afe27c2 commit 4a6c179

File tree

3 files changed

+30
-54
lines changed

3 files changed

+30
-54
lines changed

docs/features/datastores/2_Using Datastores/2_creating-datastores.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -113,15 +113,14 @@ grid datastore create s3://ryft-public-sample-data/esRedditJson/ --name lightnin
113113
Example:
114114
`grid datastore create S3://ruff-public-sample-data/esRedditJson --no-copy`
115115

116-
In certain cases, your S3 bucket may fit one (or both) of the following criteria:
116+
Use --no-copy when you want to avoid creating a duplicate copy of the data in your cluster account. Using this flag can significantly speed up Datastore creation time by preventing the copy process.
117117

118-
(1) the bucket is continually updating with new data which you want included in a Grid Datastore
119-
(2) the bucket is particularly large (leading to long Datastore creation times)
118+
:::info
119+
We recommend that you use this flag when creating a private S3 Datastore within a BYOC cluster.
120120

121-
In these cases, you can pass the `--no-copy` flag to the `grid datastore create` command. This flag will
122-
prevent Grid from making a copy of the dataset, which significantly speeds up Datastore creation time.
121+
Also consider using this option when the your dataset size is greater than `500 GB`.
123122

124-
:::info
123+
If your Datastore was from a public S3 bucket, having a copy in the cluster can be advantageous if someone deletes or modifys the public bucket. `--no-copy` does not prevent you from deleting the file in S3 as thats managed by the user. If thats done the Datastore will show that the file still exists since the metadata is cached, On access S3 will indicate that the file does not exist anymore.
125124

126125
When using this flag, you cannot remove files from your bucket. If you'd like to add files, please create a new version of the Datastore after you've added files to your bucket.
127126

docs/getting-started/typical-workflow-cli-user.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -325,7 +325,7 @@ cd grid-tutorials/getting-started
325325
pip install -r requirements.txt
326326
```
327327

328-
now run the following command to train a resnet18 on 2 GPUs
328+
now run the following command to train a resnet18 on 1 GPU
329329

330330
```bash
331331
python flash-image-classifier.py \
@@ -387,6 +387,11 @@ Make sure you are in the /grid-tutorials/getting-started directory for the tutor
387387

388388
Now kick off the run with grid run
389389

390+
:::note
391+
To convert the below run into a multi-gpu Run please set the `--instance_type` parameter to a machine with multiple gpus
392+
and update the `--gpus` argument to the desired number of GPUs. See [here](../platform/4_machines.md) for a table of machine types and their hardware specs.
393+
:::
394+
390395
```bash
391396
grid run --dependency_file ./requirements.txt \
392397
--name cifar-tut-hpo \

docs/platform/3_credentials.md

Lines changed: 19 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -135,65 +135,37 @@ When complete, please enter the role ARN:
135135

136136
The `grid credential create` command will output the required trust and permission policies.
137137

138-
a. Leave the command prompt open while visiting the [AWS IAM Role
139-
Console](https://us-east-1.console.aws.amazon.com/iamv2/home?region=us-east-1#/roles)
138+
a. Naviagte to AWS WebUI -> IAM -> [Role](https://us-east-1.console.aws.amazon.com/iamv2/home?region=us-east-1#/roles)
140139

141-
b. Click "Create Role"
140+
b. Create Role -> Custom trust policy
142141

143142
![](../../static/images/credentials/role-console.png)
144143

145-
c. Select the "custom trust policy" setting, and copy/paste the trust policy output
146-
from the CLI into the `json` editor:
144+
c. Paste the output of the `trust policy` from the CLI into the `json` editor and click Next
147145

148146
![](../../static/images/credentials/select_trusted_entity.png)
149147

150-
d. When prompted with the "add permissions to role" tab, click "Create Policy" to create a new permission
151-
policy
148+
d. In the `Add permissions` page click Next
149+
150+
e. The role name must begin with `grid-s3-access-` and click on Create role
151+
152+
![](../../static/images/credentials/role_naming.png)
153+
154+
f. You will be redirected to IAM -> Roles. Select your just created
155+
156+
g. Click on Add Permissions -> Create Inline Policy. Paste the output `permission policy` from the CLI output after replacing your bucket name and click on Review Policy
157+
158+
![](../../static/images/credentials/permission_policy_naming.png)
152159

153-
![](../../static/images/credentials/add_permissions_to_role.png)
154-
155-
e. A new tab will open. Select the `json` tab, and
156-
copy/paste the permission policy into the editor. Also replace the text
157-
`<replace-with-bucket-name>` with the name of the private bucket to provide access to
158-
(i.e. `gridai-demo-bucket`).
159-
160-
![](../../static/images/credentials/aws_permission_policy.png)
161-
162-
f. Click "next" until reaching the "permission policy naming" tab. Enter an appropriate
163-
name, for example: `my-permission-policy-for-grid`.
164-
165-
![](../../static/images/credentials/permission_policy_naming.png)
166-
167-
g. Click "create policy".
168-
169-
![](../../static/images/credentials/permission_policy_created.png)
170-
171-
h. Go back to the previous tab for attaching a permission policy to the role
172-
173-
i. Refresh the list of policies by clicking the refresh symbol
160+
h. Enter an appropriate name, for example: my-permission-policy-for-grid
174161

175-
j. Select the `my-permission-policy-for-grid` policy name and click "next".
176-
177-
![](../../static/images/credentials/attach_permission_policy.png)
178-
179-
### 3. Create AWS Role Name
180-
181-
I then navigate through the prompts until I am presented with the "role naming" screen. At
182-
this point, I create a role name **keeping in mind that the role must begin with the
183-
prefix: `grid-s3-access-`**. In this case I name the role
184-
`grid-s3-access-for-my-demo-bucket` and click create.
185-
186-
![](../../static/images/credentials/role_naming.png)
187-
188-
189-
I am then presented with a success screen! The role has been created.
162+
![](../../static/images/credentials/add_permissions_to_role.png)
163+
190164

191165
### 4. Input role ARN in Grid
192166

193-
![](../../static/images/credentials/role_created.png)
194-
195-
I select the role and click on the icon next to the "role ARN" in order to
196-
copy the value to my clipboard:
167+
Within Roles -> Search for the role you created that began with `grid-s3-access-` and click on it
168+
Click on the icon next to the "role ARN" in order to copy the value to my clipboard:
197169

198170
![](../../static/images/credentials/arn_copy.png)
199171

0 commit comments

Comments
 (0)