diff --git a/website/docs/api-schedules.md b/website/docs/api-schedules.md index c3837055b..51c945667 100644 --- a/website/docs/api-schedules.md +++ b/website/docs/api-schedules.md @@ -413,9 +413,9 @@ rate = 1.0 -| Argument | Type | Description | -| -------------- | ------------------------ | ------------------------------------------------------------------------------------- | ----------------------------------------------- | -| `max_patience` | int | Number of evaluations without an improvement to consider the model to have plateaued. | -| `scale` | float | | Scaling of the inner schedule after plateauing. | -| `schedule` | Schedule[float] | | The schedule to wrap. | -| **RETURNS** | Schedule[float] | | +| Argument | Type | Description | +| -------------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `max_patience` | int | Number of evaluations without an improvement to consider the model to have plateaued. | +| `scale` | float | 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` | Schedule[float] | The schedule to wrap. | +| **RETURNS** | Schedule[float] | |