Skip to content

Commit

Permalink
[Doc] Fix wrong default value for flatten_tensordicts in ReplayBuffer…
Browse files Browse the repository at this point in the history
…Trainer (#2502)
  • Loading branch information
vmoens authored Oct 18, 2024
1 parent 815eece commit 30df6d9
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions torchrl/trainers/trainers.py
Original file line number Diff line number Diff line change
Expand Up @@ -633,14 +633,14 @@ class ReplayBufferTrainer(TrainerHookBase):
the replay buffer batch-size will be used (preferred option for
unchanged batch-sizes).
memmap (bool, optional): if ``True``, a memmap tensordict is created.
Default is False.
Default is ``False``.
device (device, optional): device where the samples must be placed.
Default is cpu.
Default is ``cpu``.
flatten_tensordicts (bool, optional): if ``True``, the tensordicts will be
flattened (or equivalently masked with the valid mask obtained from
the collector) before being passed to the replay buffer. Otherwise,
no transform will be achieved other than padding (see :obj:`max_dims` arg below).
Defaults to True
Defaults to ``False``.
max_dims (sequence of int, optional): if :obj:`flatten_tensordicts` is set to False,
this will be a list of the length of the batch_size of the provided
tensordicts that represent the maximum size of each. If provided,
Expand Down

0 comments on commit 30df6d9

Please sign in to comment.