Skip to content

Commit

Permalink
fix documentation for optimize
Browse files Browse the repository at this point in the history
  • Loading branch information
Red-Portal committed Oct 24, 2023
1 parent a764d9b commit 8af8a5f
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/optimize.jl
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The variational approximation can be constructed by passing the variational para
- `optimizer::Optimisers.AbstractRule`: Optimizer used for inference. (Default: `Adam`.)
- `rng::AbstractRNG`: Random number generator. (Default: `Random.default_rng()`.)
- `show_progress::Bool`: Whether to show the progress bar. (Default: `true`.)
- `callback!`: Callback function called after every iteration. See further information below. (Default: `nothing`.)
- `callback`: Callback function called after every iteration. See further information below. (Default: `nothing`.)
- `prog`: Progress bar configuration. (Default: `ProgressMeter.Progress(n_max_iter; desc="Optimizing", barlen=31, showspeed=true, enabled=prog)`.)
- `state::NamedTuple`: Initial value for the internal state of optimization. Used to warm-start from the state of a previous run. (See the returned values below.)
Expand Down

0 comments on commit 8af8a5f

Please sign in to comment.