Skip to content

Commit 5ad9258

Browse files
committed
edit docstring
1 parent fc9e022 commit 5ad9258

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

src/samplers.jl

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -303,9 +303,10 @@ end
303303
"""
304304
MultiStepSampler{names}(batchsize, stacksize, n, rng)
305305
306-
A sampler that returns n consecutive steps of each trace. The samples are
307-
returned in an array of batchsize elements. For each element, n is truncated by the end
308-
of its episode. This means that the dimensions of each sample are not the same.
306+
Sampler that fetches steps `[x, x+1, ..., x + n -1]` for each trace of each sampled index
307+
`x`. The samples are returned in an array of batchsize elements. For each element, n is
308+
truncated by the end of its episode. This means that the dimensions of each sample are not
309+
the same.
309310
"""
310311
struct MultiStepSampler{names, S <: Union{Nothing,Int}, R <: AbstractRNG}
311312
n::Int

0 commit comments

Comments
 (0)