fixed docstring and not exporting stop

This commit is contained in:
Dhairya Gandhi 2018-08-22 00:29:07 +05:30
parent ed044e2df7
commit 3d11322d37
2 changed files with 4 additions and 3 deletions

View File

@ -21,7 +21,8 @@ include("optimise/Optimise.jl")
using .Optimise
using .Optimise: @epochs
export SGD, ADAM, ADAMW, AdaMax, Momentum, Nesterov,
RMSProp, ADAGrad, ADADelta, AMSGrad, NADAM, stop
RMSProp, ADAGrad, ADADelta, AMSGrad, NADAM
include("utils.jl")
include("onehot.jl")

View File

@ -18,7 +18,7 @@ struct StopException <: Exception end
"""
stop()
Call `stop()` in a callback to indicate when a callback condition is met.
Call `Flux.stop()` in a callback to indicate when a callback condition is met.
This would trigger the train loop to stop and exit.
```julia
@ -89,4 +89,4 @@ macro epochs(n, ex)
@info "Epoch $i"
$(esc(ex))
end)
end
end