Skip to content

Commit

Permalink
Merge pull request #329 from gridai/dev
Browse files Browse the repository at this point in the history
Docs Update
  • Loading branch information
oojo12 authored Jul 22, 2022
2 parents 4a6c179 + 5b62910 commit e4e1a0f
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 16 deletions.
4 changes: 3 additions & 1 deletion docs/features/runs/2_Analyzing Runs/3_artifacts.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ Artifacts are the output produced by the training process.

## Saving artifacts

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.
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.

Grid only saves new artifacts. Any file that existed before training starts, even if modified during training, will not be saved.

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.

Expand Down
18 changes: 9 additions & 9 deletions docs/features/sessions/8_how-to-ssh-into-a-session.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,22 @@ Create an SSH key from the computer you'd like to connect from (skip this step i

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

## Step 1: Add the SSH key

Here we assume to have SSH keys named _ed25519.pub_, which are the default used by the command above.

We're going to add the key and name it _lit_key_
Here we use the ssh-agent to manage the keys and will add them to Grid.

```yaml
# add the key to the ssh-agent (to avoid having to explicitly state key on each connection)
# to start the agent, run the following
eval $(ssh-agent)
# then add the key
ssh-add ~/.ssh/grid_ssh_creds

# add the keys to grid
grid ssh-keys add lit_key ~/.ssh/id_ed25519.pub
or
grid ssh-keys add key_1 ~/.ssh/id_rsa.pub
grid ssh-keys add key_1 ~/.ssh/grid_ssh_creds.pub
```

If you go to [Grid settings](https://platform.grid.ai/#/settings?tabId=ssh), you'll see SSH keys you've added to Grid
Expand Down
10 changes: 8 additions & 2 deletions docs/features/sessions/9_vscode-with-sessions.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,16 @@ Create an ssh key from the computer you'd like to connect from (skip this step i

```yaml
# make the ssh key (if you don't have one)
ssh-keygen -t ed25519 -C "[email protected]"
ssh-keygen -b 2048 -t rsa -f ~/.ssh/grid_ssh_creds -q -N ""

# add the key to the ssh-agent (to avoid having to explicitly state key on each connection)
# to start the agent, run the following
eval $(ssh-agent)
# then add the key
ssh-add ~/.ssh/grid_ssh_creds

# add the keys to grid
grid ssh-keys add lit_key ~/.ssh/id_ed25519.pub
grid ssh-keys add key_1 ~/.ssh/grid_ssh_creds.pub
```

## Step 1: Launch a session
Expand Down
5 changes: 1 addition & 4 deletions docs/getting-started/typical-workflow-cli-user.md
Original file line number Diff line number Diff line change
Expand Up @@ -291,10 +291,7 @@ grid session ssh resnet-debugging
```

Now link up VSCode with the Session

```yaml
grid session ssh vscode
```
![](/images/sessions/vscode-remote.gif)

**The model**

Expand Down

0 comments on commit e4e1a0f

Please sign in to comment.