From 30df6d9b01938b74cee5a5feda8709b3edebfada Mon Sep 17 00:00:00 2001 From: Vincent Moens Date: Fri, 18 Oct 2024 12:54:20 +0100 Subject: [PATCH] [Doc] Fix wrong default value for flatten_tensordicts in ReplayBufferTrainer (#2502) --- torchrl/trainers/trainers.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/torchrl/trainers/trainers.py b/torchrl/trainers/trainers.py index 62ea4a4a109..f257a6c2173 100644 --- a/torchrl/trainers/trainers.py +++ b/torchrl/trainers/trainers.py @@ -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,