Skip to content

Commit 60ff6f6

Browse files
authored
Clarify ratio in controller doc
1 parent 33520d1 commit 60ff6f6

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/controllers.jl

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ export InsertSampleRatioController, AsyncInsertSampleRatioController
55
66
Used in [`Trajectory`](@ref). The `threshold` means the minimal number of
77
insertings before sampling. The `ratio` balances the number of insertings and
8-
the number of samplings.
8+
the number of samplings. For example a ratio of 1/10 will sample once every 10
9+
insertings in the trajectory.
910
"""
1011
Base.@kwdef mutable struct InsertSampleRatioController
1112
ratio::Float64 = 1.0
@@ -57,4 +58,4 @@ function AsyncInsertSampleRatioController(
5758
Channel(ch_in_sz),
5859
Channel(ch_out_sz)
5960
)
60-
end
61+
end

0 commit comments

Comments
 (0)