Skip to content

Commit 0d2918f

Browse files
authored
docs: fix up plateau schedule table (#933)
The table was partly 3 columns and partly 4 columns. Also extend the description of the `scale` argument while at it.
1 parent 934c536 commit 0d2918f

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

website/docs/api-schedules.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -413,9 +413,9 @@ rate = 1.0
413413

414414
</grid>
415415

416-
| Argument | Type | Description |
417-
| -------------- | ------------------------ | ------------------------------------------------------------------------------------- | ----------------------------------------------- |
418-
| `max_patience` | <tt>int</tt> | Number of evaluations without an improvement to consider the model to have plateaued. |
419-
| `scale` | <tt>float</tt> | | Scaling of the inner schedule after plateauing. |
420-
| `schedule` | <tt>Schedule[float]</tt> | | The schedule to wrap. |
421-
| **RETURNS** | <tt>Schedule[float]</tt> | |
416+
| Argument | Type | Description |
417+
| -------------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
418+
| `max_patience` | <tt>int</tt> | Number of evaluations without an improvement to consider the model to have plateaued. |
419+
| `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`. |
420+
| `schedule` | <tt>Schedule[float]</tt> | The schedule to wrap. |
421+
| **RETURNS** | <tt>Schedule[float]</tt> | |

0 commit comments

Comments
 (0)