Skip to content

Commit 0a27ae0

Browse files
committed
add a warning to sampler docs
1 parent bc245a8 commit 0a27ae0

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/samplers.jl

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,10 @@ export MetaSampler
5555
Wraps a NamedTuple containing multiple samplers. When sampled, returns a named tuple with a
5656
batch from each sampler.
5757
Used internally for algorithms that sample multiple times per epoch.
58+
Note that a single "sampling" with a MetaSampler only increases the Trajectory controler
59+
count by 1, not by the number of internal samplers. This should be taken into account when
60+
initializing an agent.
61+
5862
5963
# Example
6064
```
@@ -80,6 +84,9 @@ export MultiBatchSampler
8084
8185
Wraps a sampler. When sampled, will sample n batches using sampler. Useful in combination
8286
with MetaSampler to allow different sampling rates between samplers.
87+
Note that a single "sampling" with a MultiBatchSampler only increases the Trajectory
88+
controler count by 1, not by `n`. This should be taken into account when
89+
initializing an agent.
8390
8491
# Example
8592
```

0 commit comments

Comments
 (0)