Skip to content

Commit 2b84efc

Browse files
[float8] update float8 training benchmark readme (#1872)
update float8 training bench readme
1 parent dfe72c4 commit 2b84efc

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

benchmarks/float8/training/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ The `float8_training_benchmark.sh` script in this directory can be used to launc
44

55
## Usage
66

7-
Example: `TORCHTITAN_ROOT=${HOME}/torchtitan FLOAT8_RECIPE=rowwise ./float8_training_benchmark.sh`
7+
Example: `TORCHTITAN_ROOT=${HOME}/torchtitan FLOAT8_RECIPE_WITH_BEST_SETTINGS=rowwise ./float8_training_benchmark.sh`
88

99
Training parameters can be configured via environment variables.
1010

1111
- Required:
12-
- `TORCHTITAN_ROOT`
12+
- `TORCHTITAN_ROOT`: Root directory of torchtitan in your local filesystem
1313
- Optional:
14-
- `RECIPE`: rowwise|tensorwise. defaults to tensorwise.
15-
- `BATCH_SIZE`: defaults to 1.
16-
- `STEPS`: defaults to 100.
14+
- `FLOAT8_RECIPE_WITH_BEST_SETTINGS`: "rowwise" or "tensorwise". Applies float8 training with the specified scaling recipe, as well as additional training configs which are optimal for that scaling recipe. See `float8_training_benchmark.sh` for more details.
15+
- `BATCH_SIZE`: Defaults to 1.
16+
- `STEPS`: Defaults to 100.
1717

1818
**NOTE**: `torch.compile` and FSDP2 are always used. Other forms of parallelism supported in torchtitan are not yet supported in this script.

0 commit comments

Comments
 (0)