Skip to content

Commit

Permalink
fix wrong argument name in docs for callback
Browse files Browse the repository at this point in the history
  • Loading branch information
Red-Portal committed Jun 4, 2024
1 parent 37e3cc5 commit 660f658
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/optimize.jl
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,12 @@ The variational approximation can be constructed by passing the variational para
# Callback
The callback function `callback` has a signature of
callback(; stat, state, param, restructure, gradient)
callback(; stat, state, params, restructure, gradient)
The arguments are as follows:
- `stat`: Statistics gathered during the current iteration. The content will vary depending on `objective`.
- `state`: Collection of the internal states used for optimization.
- `param`: Variational parameters.
- `params`: Variational parameters.
- `restructure`: Function that restructures the variational approximation from the variational parameters. Calling `restructure(param)` reconstructs the variational approximation.
- `gradient`: The estimated (possibly stochastic) gradient.
Expand Down

0 comments on commit 660f658

Please sign in to comment.