Skip to content

Commit

Permalink
docs: fix up plateau schedule table (explosion#933)
Browse files Browse the repository at this point in the history 
The table was partly 3 columns and partly 4 columns. Also extend the
description of the `scale` argument while at it.
  • Loading branch information
@danieldk
danieldk authored Apr 19, 2024
1 parent 934c536 commit 0d2918f
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions website/docs/api-schedules.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -413,9 +413,9 @@ rate = 1.0

</grid>

| Argument | Type | Description |
| -------------- | ------------------------ | ------------------------------------------------------------------------------------- | ----------------------------------------------- |
| `max_patience` | <tt>int</tt> | Number of evaluations without an improvement to consider the model to have plateaued. |
| `scale` | <tt>float</tt> | | Scaling of the inner schedule after plateauing. |
| `schedule` | <tt>Schedule[float]</tt> | | The schedule to wrap. |
| **RETURNS** | <tt>Schedule[float]</tt> | |
| Argument | Type | Description |
| -------------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `max_patience` | <tt>int</tt> | Number of evaluations without an improvement to consider the model to have plateaued. |
| `scale` | <tt>float</tt> | Scale to apply to the learning rate when the model has plateaued. This scale is cumulative -- if the model plateaued `n` times, the effective scale is `scale**n`. |
| `schedule` | <tt>Schedule[float]</tt> | The schedule to wrap. |
| **RETURNS** | <tt>Schedule[float]</tt> | |

0 comments on commit 0d2918f

Please sign in to comment.