Skip to content

Commit

Permalink
fix documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Red-Portal committed Dec 24, 2024
1 parent 7868317 commit 04db344
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/AdvancedVI.jl
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ Initialize the state of the averaging strategy `avg` with the initial parameters
init(::AbstractAverager, ::Any) = nothing

"""
apply(avg, avg_st, params)
average(avg, avg_st, params)
Apply averaging strategy `avg` on `params` given the state `avg_st`.
Expand All @@ -196,7 +196,7 @@ Apply averaging strategy `avg` on `params` given the state `avg_st`.
- `avg_st`: Previous state of the averaging strategy.
- `params`: Initial variational parameters.
"""
function apply(::AbstractAverager, ::Any, ::Any) end
function average(::AbstractAverager, ::Any, ::Any) end

"""
value(avg, avg_st)
Expand Down Expand Up @@ -230,7 +230,7 @@ Apply operator `op` on the variational parameters `params`. For instance, `op` c
# Returns
- `oped_params`: Parameters resulting from applying the operator.
"""
function operate end
function operate(::AbstractOperator, ::Type, ::Any, ::Any) end

"""
IdentityOperator()
Expand Down

0 comments on commit 04db344

Please sign in to comment.