FluxML / FluxTraining.jl

A flexible neural net training library inspired by fast.ai
https://fluxml.ai/FluxTraining.jl
MIT License
117 stars 25 forks source link

How not to print docstring #127

Closed KronosTheLate closed 2 years ago

KronosTheLate commented 2 years ago

This PR removes the star indicating default callbacks on SanityCheck, and adds it to StopOnNaNLoss, based on

(DennisBachelorProject) pkg> st FluxTraining
      Status `C:\Users\Dennis Bal\DennisBachelorProject\Project.toml`
  [7bf95e4d] FluxTraining v0.3.2

julia> lr = Learner(predict, lossfn)
Learner()

julia> lr.callbacks.cbs
5-element Vector{FluxTraining.SafeCallback}:
 ProgressPrinter()
 MetricsPrinter()
 StopOnNaNLoss()
 Recorder()
 Metrics(Loss())

, which is consistent with the automated output in the docs It also adds a sentence on constructing learners without default callbacks, and changed the order (and singltly wording) on the two paragraphs after the table.

Finally, it adds a sentence to "How to use callbacks" that makes more clear what goes on when the callbacks are printed.

lorenzoh commented 2 years ago

lgtm!