Skip to content

Commit 1db422f

Browse files
Merge pull request #293 from gridai/dev
Docs Release
2 parents a75bb66 + b5dd08b commit 1db422f

File tree

3 files changed

+14
-7
lines changed

3 files changed

+14
-7
lines changed

docs/features/runs/1_Creating Runs/1_Basic Runs/3_sweep-syntax.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ Check the [Runs FAQ](https://docs.grid.ai/features/runs/faq.md) for common quest
99

1010
# Hyperparameter Sweeps
1111

12-
Grid Runs offer the abilty to launch [hyperparameter sweeps](https://www.grid.ai/what-are-hyperparameter-sweeps-and-why-are-they-important-to-production-machine-learning) without changing a single line of code! Just make sure your script can take arguments from the CLI:
12+
Grid Runs offer the abilty to launch [hyperparameter sweeps](https://www.grid.ai/what-are-hyperparameter-sweeps-and-why-are-they-important-to-production-machine-learning) without changing a single line of code!
13+
This feature will allow you to run multiple permutations of your training script (i.e. an experiment) on different machines in parallel.
14+
Just make sure your training script can take arguments from the CLI:
1315

1416
```bash
1517
grid run main.py --layers 32 --learning_rate 0.01

docs/features/runs/1_README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -80,14 +80,16 @@ grid run hello.py --number "[1, 2]" --food_item "['pizza', 'hotdog']"
8080
The above is equivalent to running each of the following lines on a separate machine:
8181

8282
```bash
83-
python hello.py --number 1 --food_item 'pizza'
84-
python hello.py --number 2 --food_item 'pizza'
85-
python hello.py --number 1 --food_item 'hotdog'
86-
python hello.py --number 2 --food_item 'hotdog'
83+
python hello.py --number 1 --food_item 'pizza' # will run on machine 1
84+
python hello.py --number 2 --food_item 'pizza' # will run on machine 2
85+
python hello.py --number 1 --food_item 'hotdog' # will run on machine 3
86+
python hello.py --number 2 --food_item 'hotdog' # will run on machine 4
8787
```
8888

8989
:::note
90-
A RUN is a collection of experiments (the run has 4 experiments in this example).
90+
A RUN is a collection of EXPERIMENTS (the run has 4 experiments in this example).
91+
92+
Each experiment will execute on it's own machine!
9193
:::
9294

9395
To see the status of your Run and all associated experiments, run the `grid status <my-run-name>` command. (More details can be found [here](https://docs.grid.ai/cli#grid-status)).

docs/platform/10_known-issues.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ sidebar_label: Known Issues
99

1010
### [BYOC](https://docs.grid.ai/platform/custom-cloud-credentials/byoc)
1111
* Creating runs with the same name across two cluster is currenly supported, but prohibits certain operations against runs/experiments.
12-
* BYOC can only support instance types with the x86_64 architecture. The instance families of the following instance types are known to not be supported due to their architecture: A1, T4g, M6g, C6g, and R6g.
12+
* BYOC can only support instance types with the x86_64 architecture. The instance families of the following instance types are known to not be supported due to their architecture: A1, T4g, M6g, C6g, G5g, and R6g.
1313

1414
### [Collaboration](https://docs.grid.ai/platform/collaboration)
1515
* Downloading artifacts from a teammate's experiments is not supported from the CLI. Please use the UI as a workaround.
@@ -27,3 +27,6 @@ sidebar_label: Known Issues
2727

2828
### [Session](https://docs.grid.ai/features/sessions)
2929
* Cloning a Github repo with SSH is currenlty not supported. Insead, use Github's HTTPS clone method.
30+
31+
### [Artifacts](https://docs.grid.ai/features/runs/Analyzing%20Runs/artifacts)
32+
* Currently, artifact downloads are not optimized for a large number of files. This can lead to excessively long download times.

0 commit comments

Comments
 (0)