Skip to content

Commit

Permalink
update docs re Warmup control
Browse files Browse the repository at this point in the history
  • Loading branch information
ablaom committed Jan 23, 2024
1 parent 51ed76e commit 418402f
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/src/controlling_iterative_models.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ control | description
[`GL`](@ref EarlyStopping.GL)`(alpha=2.0)` | † Stop after the "generalization loss (GL)" exceeds `alpha` | yes
[`PQ`](@ref EarlyStopping.PQ)`(alpha=0.75, k=5)` | † Stop after "progress-modified GL" exceeds `alpha` | yes
[`Patience`](@ref EarlyStopping.Patience)`(n=5)` | † Stop after `n` consecutive loss increases | yes
[`Warmup`](@ref EarlyStopping.Warmup)`(c; n=1)` | Wait for `n` loss updates before checking criteria `c` | no
[`Info`](@ref IterationControl.Info)`(f=identity)` | Log to `Info` the value of `f(mach)`, where `mach` is current machine | no
[`Warn`](@ref IterationControl.Warn)`(predicate; f="")` | Log to `Warn` the value of `f` or `f(mach)`, if `predicate(mach)` holds | no
[`Error`](@ref IterationControl.Error)`(predicate; f="")` | Log to `Error` the value of `f` or `f(mach)`, if `predicate(mach)` holds and then stop | yes
Expand Down

0 comments on commit 418402f

Please sign in to comment.