Skip to content

Commit

Permalink
Update docs/src/getting_started/fit_simulation.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ChrisRackauckas authored Dec 25, 2023
1 parent 3f49783 commit 0026095
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/src/getting_started/fit_simulation.md
Original file line number Diff line number Diff line change
Expand Up @@ -305,8 +305,9 @@ callback(
)
```

In this case, we will provide the callback the arguments `(_, l, sol)`,
since there are no additional optimization function parameters.
In this case, we will provide the callback the arguments `(p, l, sol)`,
since it always takes the current state of the optimization first (`p`)
then the returns from the loss function (`l, sol`).
The return value of the callback function should default to `false`.
`Optimization.solve` will halt if/when the callback function returns `true` instead.
Typically the `return` statement would monitor the loss value
Expand Down

0 comments on commit 0026095

Please sign in to comment.