Skip to content

Align bfloat16 docs with 4912e0ad7efcaf97389ae944259aa0e9f331038a #1715

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jeffra merged 1 commit into from
Jan 21, 2022
Merged

Align bfloat16 docs with 4912e0ad7efcaf97389ae944259aa0e9f331038a #1715

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/_data/navigation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ lnav:
url: /docs/config-json/#communication-options
- title: "FP16"
url: /docs/config-json/#fp16-training-options
- title: "BFOAT16"
url: /docs/config-json/#bfloat16-training-options
- title: "Gradient Clipping"
url: /docs/config-json/#gradient-clipping
- title: "ZeRO optimizations"
Expand Down
15 changes: 6 additions & 9 deletions docs/_pages/config-json.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,18 +233,15 @@ Example of <i>**scheduler**</i>
| ----------------------------------------------------------------------------------------------------- | ------- |
| <i>**min_loss_scale**</i> is a **fp16** parameter representing the minimum dynamic loss scale value. | `1000` |

### BFLOAT16 options
### BFLOAT16 training options

**Note:** this mode cannot be combined with the `amp` mode described below.
{: .notice--warning}

**Note:** this mode cannot be combined with the `fp16` mode described above.
{: .notice--warning}

**Note:** this mode is only compatible with ZeRO stages 1 and 2.
{: .notice--warning}

<i>**bfloat16**</i>: [dictionary]
<i>**bf16**</i>: [dictionary]

| Description | Default |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
Expand All @@ -256,11 +253,11 @@ Example of <i>**scheduler**</i>
}
```

<i>**bfloat16:enabled**</i>: [boolean]
<i>**bf16:enabled**</i>: [boolean]

| Description | Default |
| ------------------------------------------------------------------------------------------- | ------- |
| <i>**enabled**</i> is a **bfloat16** parameter indicating whether or not BFLOAT16 training enabled. | `false` |
| Description | Default |
|--------------------------------------------------------------------| ------- |
| <i>**enabled**</i> indicates whether BFLOAT16 training is enabled. | `false` |


### Automatic mixed precision (AMP) training options
Expand Down