Skip to content

Commit e4e1a0f

Browse files
authored
Merge pull request #329 from gridai/dev
Docs Update
2 parents 4a6c179 + 5b62910 commit e4e1a0f

File tree

4 files changed

+21
-16
lines changed

4 files changed

+21
-16
lines changed

docs/features/runs/2_Analyzing Runs/3_artifacts.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ Artifacts are the output produced by the training process.
1212

1313
## Saving artifacts
1414

15-
Anytime your script saves artifacts, Grid captures those for you. It does not matter which folder you save artifacts to... Grid will automatically detect them.
15+
Anytime your script saves new artifacts, Grid captures those for you. It does not matter which folder you save artifacts to... Grid will automatically detect them.
16+
17+
Grid only saves new artifacts. Any file that existed before training starts, even if modified during training, will not be saved.
1618

1719
Grid uploads your artifacts to long-term storage while your experiment is running *and* at the end of your experiment. This is to ensure that even if your experiment crashes, your artifacts will be saved.
1820

docs/features/sessions/8_how-to-ssh-into-a-session.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,22 @@ Create an SSH key from the computer you'd like to connect from (skip this step i
1212

1313
```yaml
1414
# make the ssh key (if you don't have one)
15-
ssh-keygen -t ed25519 -C "[email protected]"
16-
or
17-
ssh-keygen -b 2048 -t rsa -q -N ""
15+
ssh-keygen -b 2048 -t rsa -f ~/.ssh/grid_ssh_creds -q -N ""
1816
```
1917

2018
## Step 1: Add the SSH key
2119

22-
Here we assume to have SSH keys named _ed25519.pub_, which are the default used by the command above.
23-
24-
We're going to add the key and name it _lit_key_
20+
Here we use the ssh-agent to manage the keys and will add them to Grid.
2521

2622
```yaml
23+
# add the key to the ssh-agent (to avoid having to explicitly state key on each connection)
24+
# to start the agent, run the following
25+
eval $(ssh-agent)
26+
# then add the key
27+
ssh-add ~/.ssh/grid_ssh_creds
28+
2729
# add the keys to grid
28-
grid ssh-keys add lit_key ~/.ssh/id_ed25519.pub
29-
or
30-
grid ssh-keys add key_1 ~/.ssh/id_rsa.pub
30+
grid ssh-keys add key_1 ~/.ssh/grid_ssh_creds.pub
3131
```
3232

3333
If you go to [Grid settings](https://platform.grid.ai/#/settings?tabId=ssh), you'll see SSH keys you've added to Grid

docs/features/sessions/9_vscode-with-sessions.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,16 @@ Create an ssh key from the computer you'd like to connect from (skip this step i
1212

1313
```yaml
1414
# make the ssh key (if you don't have one)
15-
ssh-keygen -t ed25519 -C "[email protected]"
15+
ssh-keygen -b 2048 -t rsa -f ~/.ssh/grid_ssh_creds -q -N ""
16+
17+
# add the key to the ssh-agent (to avoid having to explicitly state key on each connection)
18+
# to start the agent, run the following
19+
eval $(ssh-agent)
20+
# then add the key
21+
ssh-add ~/.ssh/grid_ssh_creds
1622

1723
# add the keys to grid
18-
grid ssh-keys add lit_key ~/.ssh/id_ed25519.pub
24+
grid ssh-keys add key_1 ~/.ssh/grid_ssh_creds.pub
1925
```
2026

2127
## Step 1: Launch a session

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

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -291,10 +291,7 @@ grid session ssh resnet-debugging
291291
```
292292

293293
Now link up VSCode with the Session
294-
295-
```yaml
296-
grid session ssh vscode
297-
```
294+
![](/images/sessions/vscode-remote.gif)
298295

299296
**The model**
300297

0 commit comments

Comments
 (0)