torchrl 0.11.0__cp314-cp314t-macosx_11_0_arm64.whl

torchrl/objectives/value/utils.py

@@ -0,0 +1,360 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+from __future__ import annotations
+
+import torch
+
+from tensordict import TensorDictBase
+from tensordict.utils import expand_right
+
+
+def _custom_conv1d(tensor: torch.Tensor, filter: torch.Tensor):
+    """Computes a conv1d filter over a value.
+
+    This is usually used to compute a discounted return:
+
+    Tensor:                         Filter                      Result (discounted return)
+    [ r_0,                          [ 1.0,                      [ r_0 + g r_1 + g^2 r_2 + r^3 r_3,
+      r_1,                            g,                          r_1 + g r_2 + g^2 r_3,
+      r_2,                            g^2,                        r_2 + g r_3,
+      r_3,                            g^3 ]                       r_3 ]
+      0,      |                        |
+      0,      |  zero padding          | direction of filter
+      0 ]     |                        v
+
+    This function takes care of applying the one-sided zero padding. In this example,
+    `Filter_dim` = :obj:`Time` = 4, but in practice Filter_dim can be <= to :obj:`Time`.
+
+    Args:
+        tensor (torch.Tensor): a [ Batch x 1 x Time ] floating-point tensor
+        filter (torch.Tensor): a [ Filter_dim x 1 ] floating-point filter
+
+    Returns: a filtered tensor of the same shape as the input tensor.
+
+    """
+    if filter.ndimension() > 2:
+        # filter will have shape batch_dims x timesteps x filter_dim x 1
+        # reshape to batch_dims x timesteps x 1 x filter_dim ready for convolving
+        filter = filter.view(*filter.shape[:-2], 1, filter.shape[-2])
+
+        # because time is represented on two different dimensions, we don't
+        # need all convolutions, just those lying along a diagonal
+        # rather than compute them all and discard, we stack just the slices
+        # of val_pad that we care about, and apply the filter manually
+
+        # STACK VERSION: val_pad is computed as in the block below
+        # batched_val_pad = torch.stack(
+        #     [val_pad[..., i : i + filter.shape[-1]] for i in range(tensor.shape[-1])],
+        #     dim=1,
+        # )
+
+        # roll version
+        T = tensor.shape[-1]
+        device = tensor.device
+        batched_val_pad = (
+            roll_by_gather(
+                tensor.expand(tensor.shape[0], filter.shape[-1], T).transpose(-2, -1),
+                0,
+                -torch.arange(filter.shape[-1], device=device),
+            )
+            .flip(-1)
+            .triu(filter.shape[-1] - T)
+            .flip(-1)
+            .unsqueeze(-2)
+        )
+
+        # this is just a batched matrix multiplication, but einsum makes it
+        # easy to keep the many dimensions under control. Here b = batch,
+        # t = timestep, s = singleton, j is the filter dimension that should
+        # get summed out. we swap the order of s and t here rather than
+        # reshape / create a view later.
+        # this is essentially identical to (batched_val_pad @ filter.transpose(-2, -1)).squeeze().unsqueeze(-2)
+        # out = (batched_val_pad @ filter.transpose(-2, -1)).squeeze().unsqueeze(-2)
+        out = torch.einsum("btsj,btsj->bst", batched_val_pad, filter)
+    else:
+        val_pad = torch.nn.functional.pad(tensor, [0, filter.shape[-2] - 1])
+
+        # shape = val.shape
+        filter = filter.squeeze(-1).unsqueeze(0).unsqueeze(0)  # 1 x 1 x T
+        out = torch.conv1d(val_pad, filter)
+    # out = out.view(shape)
+    if out.shape != tensor.shape:
+        raise RuntimeError(
+            f"wrong output shape: input shape: {tensor.shape}, output shape: {out.shape}"
+        )
+    return out
+
+
+def roll_by_gather(mat: torch.Tensor, dim: int, shifts: torch.LongTensor):
+    """Rolls a batched matrix along the last or last but one dimension.
+
+    Args:
+        mat (torch.Tensor): A batched matrix to roll
+        dim (int): 0 or -2 indicates the last but one dimension,
+            1 or -1 the last dimension.
+        shifts (torch.LongTensor): A tensor containing the shifts. Must have the same number of
+            elements as the unchosen dimension.
+
+    Examples:
+        >>> x = torch.arange(12).view(3, 4)
+        >>> roll_by_gather(x, 0, -torch.arange(4))  # shifts the values in each column
+        tensor([[ 0,  5, 10,  3],
+                [ 4,  9,  2,  7],
+                [ 8,  1,  6, 11]])
+        >>> roll_by_gather(x, 1, -torch.arange(3))  # shifts the values in each row
+        tensor([[ 0,  1,  2,  3],
+                [ 5,  6,  7,  4],
+                [10, 11,  8,  9]])
+
+    """
+    # assumes 2D array
+    *batch, n_rows, n_cols = mat.shape
+    device = mat.device
+
+    if dim in (0, -2):
+        arange1 = (
+            torch.arange(n_rows, device=device).unsqueeze(-1).expand((n_rows, n_cols))
+        )
+        arange2 = (arange1 - shifts) % n_rows
+        return torch.gather(mat, -2, arange2.expand(*batch, *arange2.shape))
+    elif dim in (1, -1):
+        arange1 = torch.arange(n_cols, device=device).expand((n_rows, n_cols))
+        arange2 = (arange1 - shifts.unsqueeze(-1)) % n_cols
+        return torch.gather(mat, -1, arange2.expand(*batch, n_rows, n_cols))
+    else:
+        raise NotImplementedError(f"dim {dim} is not supported.")
+
+
+def _make_gammas_tensor(gamma: torch.Tensor, T: int, rolling_gamma: bool):
+    """Prepares a decay tensor for a matrix multiplication.
+
+    Given a tensor gamma of size [*batch, T, D],
+    it will return a new tensor with size [*batch, T, T+1, D].
+    In the rolling_gamma case, a rolling of the gamma values will be performed
+    along the T axis, e.g.:
+    [[ 1, g1, g2, g3],
+    [ 1, g2, g3, 0],
+    [ 1, g3, 0, 0]]
+
+    Args:
+        gamma (torch.tensor): the gamma tensor to be prepared.
+        T (int): the time length
+        rolling_gamma (bool): if ``True``, the gamma value is set for each step
+            independently. If False, the gamma value at (i, t) will be used for the
+            trajectory following (i, t).
+
+    Returns: the prepared gamma decay tensor
+
+    """
+    # some reshaping code vendored from vec_td_lambda_return_estimate
+    gamma = gamma.transpose(-2, -1).contiguous()
+    gamma = gamma.view(-1, T)
+    dtype = gamma.dtype
+    device = gamma.device
+    if rolling_gamma:
+        # # loop
+        # gammas = gamma.unsqueeze(-2).expand(gamma.shape[0], T, T).contiguous()
+        # for i in range(1, T):
+        #     s = gammas[:, i].clone()
+        #     gammas[:, i] = 0
+        #     gammas[:, i, :-i] = s[:, i:]
+        # gammas = torch.cumprod(gammas.unsqueeze(-1), -2)
+        # gammas_cont = torch.ones(gammas.shape[0], T, T, 1)
+        # gammas_cont[..., 1:, :] = gammas[..., :-1, :]
+        # gammas = gammas_cont
+
+        # vectorized version
+        gammas = torch.ones(gamma.shape[0], T, T + 1, 1, dtype=dtype, device=device)
+        s0 = gamma.unsqueeze(-1).expand(gamma.shape[0], T, T)
+        s1 = roll_by_gather(s0, 0, shifts=-torch.arange(T, device=device))
+
+        # we should triu here, but it's useless since there is a triu on the values
+        # happening in _custom_conv1d
+        # s2 = s1.flip(-1).triu().flip(-1).transpose(-2, -1)
+        s2 = s1.transpose(-2, -1)
+        gammas[..., 1:, :] = s2.unsqueeze(-1)
+    else:
+        gammas = torch.ones(*gamma.shape, T + 1, 1, device=device, dtype=dtype)
+        gammas[..., 1:, :] = gamma[..., None, None]
+    return gammas
+
+
+def _flatten_batch(tensor, time_dim=-1):
+    """Because we mark the end of each batch with a truncated signal, we can concatenate them.
+
+    Args:
+        tensor (torch.Tensor): a tensor of shape [*B, T, *F]
+        time_dim (int, optional): the time dimension T. Defaults to -1.
+
+    """
+    return tensor.flatten(0, time_dim)
+
+
+def _get_num_per_traj(done):
+    """Because we mark the end of each batch with a truncated signal, we can concatenate them.
+
+    Args:
+        done (torch.Tensor): A done or truncated mark of shape [*B, T]
+
+    Returns:
+        A list of integers representing the number of steps in each trajectory
+
+    """
+    done = done.clone()
+    done[..., -1] = True
+    # TODO: find a way of copying once only, eg not using reshape
+    num_per_traj = torch.where(done.reshape(-1))[0] + 1
+    num_per_traj[1:] = num_per_traj[1:] - num_per_traj[:-1]
+    return num_per_traj
+
+
+def _split_and_pad_sequence(
+    tensor: torch.Tensor | TensorDictBase,
+    splits: torch.Tensor,
+    return_mask=False,
+    time_dim=-1,
+):
+    """Given a tensor of size [*B, T, F] and the corresponding traj lengths (flattened), returns the padded trajectories [NPad, Tmax, *other].
+
+    Compatible with tensordict inputs.
+
+    Examples:
+        >>> from tensordict import TensorDict
+        >>> is_init = torch.zeros(4, 5, dtype=torch.bool)
+        >>> is_init[:, 0] = True
+        >>> is_init[0, 3] = True
+        >>> is_init[1, 2] = True
+        >>> tensordict = TensorDict({
+        ...     "is_init": is_init,
+        ...     "obs": torch.arange(20).view(4, 5).unsqueeze(-1).expand(4, 5, 3),
+        ... }, [4, 5])
+        >>> splits = _get_num_per_traj_init(is_init)
+        >>> print(splits)
+        tensor([3, 2, 2, 3, 5, 5])
+        >>> td = _split_and_pad_sequence(tensordict, splits)
+        >>> print(td)
+        TensorDict(
+            fields={
+                is_init: Tensor(shape=torch.Size([6, 5]), device=cpu, dtype=torch.bool, is_shared=False),
+                obs: Tensor(shape=torch.Size([6, 5, 3]), device=cpu, dtype=torch.int64, is_shared=False)},
+            batch_size=torch.Size([6, 5]),
+            device=None,
+            is_shared=False)
+        >>> print(td["obs"])
+        tensor([[[ 0,  0,  0],
+                 [ 1,  1,  1],
+                 [ 2,  2,  2],
+                 [ 0,  0,  0],
+                 [ 0,  0,  0]],
+        <BLANKLINE>
+                [[ 3,  3,  3],
+                 [ 4,  4,  4],
+                 [ 0,  0,  0],
+                 [ 0,  0,  0],
+                 [ 0,  0,  0]],
+        <BLANKLINE>
+                [[ 5,  5,  5],
+                 [ 6,  6,  6],
+                 [ 0,  0,  0],
+                 [ 0,  0,  0],
+                 [ 0,  0,  0]],
+        <BLANKLINE>
+                [[ 7,  7,  7],
+                 [ 8,  8,  8],
+                 [ 9,  9,  9],
+                 [ 0,  0,  0],
+                 [ 0,  0,  0]],
+        <BLANKLINE>
+                [[10, 10, 10],
+                 [11, 11, 11],
+                 [12, 12, 12],
+                 [13, 13, 13],
+                 [14, 14, 14]],
+        <BLANKLINE>
+                [[15, 15, 15],
+                 [16, 16, 16],
+                 [17, 17, 17],
+                 [18, 18, 18],
+                 [19, 19, 19]]])
+
+    """
+    max_seq_len = torch.max(splits)
+    shape = (len(splits), max_seq_len)
+
+    # int16 supports length up to 32767
+    dtype = (
+        torch.int16
+        if tensor.size(time_dim) < torch.iinfo(torch.int16).max
+        else torch.int32
+    )
+    arange = torch.arange(max_seq_len, device=tensor.device, dtype=dtype).unsqueeze(0)
+    mask = arange < splits.unsqueeze(1)
+
+    tensor = _flatten_batch(tensor, time_dim=time_dim)
+
+    def _fill_tensor(tensor):
+        empty_tensor = torch.zeros(
+            *shape,
+            *tensor.shape[1:],
+            dtype=tensor.dtype,
+            device=tensor.device,
+        )
+        mask_expand = expand_right(mask, (*mask.shape, *tensor.shape[1:]))
+        # We need to use masked-scatter to accommodate vmap
+        return torch.masked_scatter(empty_tensor, mask_expand, tensor.reshape(-1))
+        # empty_tensor[mask_expand] = tensor.reshape(-1)
+        # return empty_tensor
+
+    if isinstance(tensor, TensorDictBase):
+        tensor = tensor.apply(_fill_tensor, batch_size=list(shape))
+    else:
+        tensor = _fill_tensor(tensor)
+    if return_mask:
+        return tensor, mask
+    return tensor
+
+
+def _inv_pad_sequence(
+    tensor: torch.Tensor | TensorDictBase,
+    splits: torch.Tensor,
+    mask: torch.Tensor = None,
+):
+    """Inverse a pad_sequence operation.
+
+    If tensor is of shape [B, T], than splits must be of of shape [B] with all elements
+    and integer between [1, T].
+    The result will be flattened along the batch dimension(s) and must be reshaped into
+    the original shape (if necessary).
+
+    Examples:
+        >>> rewards = torch.randn(100, 20)
+        >>> num_per_traj = _get_num_per_traj(torch.zeros(100, 20).bernoulli_(0.1))
+        >>> padded = _split_and_pad_sequence(rewards, num_per_traj)
+        >>> reconstructed = _inv_pad_sequence(padded, num_per_traj)
+        >>> assert (reconstructed==rewards).all()
+    """
+    if splits.numel() == 1:
+        return tensor
+
+    if mask is None:
+        # int16 supports length up to 32767
+        dtype = (
+            torch.int16
+            if tensor.shape[-1] < torch.iinfo(torch.int16).max
+            else torch.int32
+        )
+        arange = torch.arange(
+            tensor.shape[-1], device=tensor.device, dtype=dtype
+        ).unsqueeze(0)
+        mask = arange < splits.unsqueeze(1)
+
+    return tensor[mask]
+
+
+def _get_num_per_traj_init(is_init):
+    """Like _get_num_per_traj, but with is_init signal."""
+    done = torch.zeros_like(is_init)
+    done[..., :-1][is_init[..., 1:]] = 1
+    return _get_num_per_traj(done)

torchrl/record/__init__.py

@@ -0,0 +1,17 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+
+from .loggers import CSVLogger, MLFlowLogger, TensorboardLogger, WandbLogger
+from .recorder import PixelRenderTransform, TensorDictRecorder, VideoRecorder
+
+__all__ = [
+    "CSVLogger",
+    "MLFlowLogger",
+    "TensorboardLogger",
+    "WandbLogger",
+    "PixelRenderTransform",
+    "TensorDictRecorder",
+    "VideoRecorder",
+]

torchrl/record/loggers/__init__.py

@@ -0,0 +1,23 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+
+from .common import Logger
+
+from .csv import CSVLogger
+from .mlflow import MLFlowLogger
+from .tensorboard import TensorboardLogger
+from .utils import generate_exp_name, get_logger
+
+from .wandb import WandbLogger
+
+__all__ = [
+    "Logger",
+    "CSVLogger",
+    "MLFlowLogger",
+    "TensorboardLogger",
+    "generate_exp_name",
+    "get_logger",
+    "WandbLogger",
+]

torchrl/record/loggers/common.py

@@ -0,0 +1,48 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+from __future__ import annotations
+
+import abc
+from collections.abc import Sequence
+
+from torch import Tensor
+
+
+__all__ = ["Logger"]
+
+
+class Logger:
+    """A template for loggers."""
+
+    def __init__(self, exp_name: str, log_dir: str) -> None:
+        self.exp_name = exp_name
+        self.log_dir = log_dir
+        self.experiment = self._create_experiment()
+
+    @abc.abstractmethod
+    def _create_experiment(self) -> Experiment:  # noqa: F821
+        ...
+
+    @abc.abstractmethod
+    def log_scalar(self, name: str, value: float, step: int | None = None) -> None:
+        ...
+
+    @abc.abstractmethod
+    def log_video(
+        self, name: str, video: Tensor, step: int | None = None, **kwargs
+    ) -> None:
+        ...
+
+    @abc.abstractmethod
+    def log_hparams(self, cfg: DictConfig | dict) -> None:  # noqa: F821
+        ...
+
+    @abc.abstractmethod
+    def __repr__(self) -> str:
+        ...
+
+    @abc.abstractmethod
+    def log_histogram(self, name: str, data: Sequence, **kwargs):
+        ...

torchrl/record/loggers/csv.py

@@ -0,0 +1,226 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+from __future__ import annotations
+
+import os
+from collections import defaultdict
+from collections.abc import Sequence
+from pathlib import Path
+
+import tensordict.utils
+import torch
+from tensordict import MemoryMappedTensor
+from torch import Tensor
+
+from .common import Logger
+
+
+class CSVExperiment:
+    """A CSV logger experiment class."""
+
+    def __init__(self, log_dir: str, *, video_format="pt", video_fps: int = 30):
+        self.scalars = defaultdict(list)
+        self.videos_counter = defaultdict(int)
+        self.text_counter = defaultdict(int)
+        self.log_dir = log_dir
+        self.video_format = video_format
+        self.video_fps = video_fps
+        os.makedirs(self.log_dir, exist_ok=True)
+        os.makedirs(os.path.join(self.log_dir, "scalars"), exist_ok=True)
+        os.makedirs(os.path.join(self.log_dir, "videos"), exist_ok=True)
+        os.makedirs(os.path.join(self.log_dir, "texts"), exist_ok=True)
+
+        self.files = {}
+
+    def add_scalar(self, name: str, value: float, global_step: int | None = None):
+        if global_step is None:
+            global_step = len(self.scalars[name])
+        value = float(value)
+        self.scalars[name].append((global_step, value))
+        filepath = os.path.join(self.log_dir, "scalars", "".join([name, ".csv"]))
+        if not os.path.isfile(filepath):
+            os.makedirs(Path(filepath).parent, exist_ok=True)
+        if filepath not in self.files:
+            os.makedirs(Path(filepath).parent, exist_ok=True)
+            self.files[filepath] = open(filepath, "a+")
+        fd = self.files[filepath]
+        fd.write(",".join([str(global_step), str(value)]) + "\n")
+        fd.flush()
+
+    def add_video(self, tag, vid_tensor, global_step: int | None = None, **kwargs):
+        """Writes a video on a file on disk.
+
+        The video format can be one of
+
+        - `"pt"`: uses :func:`~torch.save` to save the video tensor);
+        - `"memmap"`: saved the file as memory-mapped array (reading this file will require
+          the dtype and shape to be known at read time);
+        - `"mp4"`: saves the file as an `.mp4` file using torchvision :func:`~torchvision.io.write_video`
+          API. Any ``kwargs`` passed to ``add_video`` will be transmitted to ``write_video``.
+          These include ``preset``, ``crf`` and others.
+          See ffmpeg's doc (https://trac.ffmpeg.org/wiki/Encode/H.264) for some more information of the video format options.
+
+        """
+        if global_step is None:
+            global_step = self.videos_counter[tag]
+            self.videos_counter[tag] += 1
+        if self.video_format == "pt":
+            extension = ".pt"
+        elif self.video_format == "memmap":
+            extension = ".memmap"
+        elif self.video_format == "mp4":
+            extension = ".mp4"
+        else:
+            raise ValueError(
+                f"Unknown video format {self.video_format}. Must be one of 'pt', 'memmap' or 'mp4'."
+            )
+
+        filepath = os.path.join(
+            self.log_dir, "videos", "_".join([tag, str(global_step)]) + extension
+        )
+        path_to_create = Path(str(filepath)).parent
+        os.makedirs(path_to_create, exist_ok=True)
+        if self.video_format == "pt":
+            torch.save(vid_tensor, filepath)
+        elif self.video_format == "memmap":
+            MemoryMappedTensor.from_tensor(vid_tensor, filename=filepath)
+        elif self.video_format == "mp4":
+            import torchvision
+
+            if vid_tensor.shape[-3] not in (3, 1):
+                raise RuntimeError(
+                    "expected the video tensor to be of format [T, C, H, W] but the third channel "
+                    f"starting from the end isn't in (1, 3) but is {vid_tensor.shape[-3]}."
+                )
+            if vid_tensor.ndim > 4:
+                vid_tensor = vid_tensor.flatten(0, vid_tensor.ndim - 4)
+            vid_tensor = vid_tensor.permute((0, 2, 3, 1))
+            vid_tensor = vid_tensor.expand(*vid_tensor.shape[:-1], 3)
+            kwargs.setdefault("fps", self.video_fps)
+            torchvision.io.write_video(filepath, vid_tensor, **kwargs)
+        else:
+            raise ValueError(
+                f"Unknown video format {self.video_format}. Must be one of 'pt', 'memmap' or 'mp4'."
+            )
+
+    def add_text(self, tag, text, global_step: int | None = None):
+        if global_step is None:
+            global_step = self.videos_counter[tag]
+            self.videos_counter[tag] += 1
+        filepath = os.path.join(
+            self.log_dir, "texts", "".join([tag, str(global_step)]) + ".txt"
+        )
+        if not os.path.isfile(filepath):
+            os.makedirs(Path(filepath).parent, exist_ok=True)
+        if filepath not in self.files:
+            self.files[filepath] = open(filepath, "w+")
+        fd = self.files[filepath]
+        fd.writelines(text)
+        fd.flush()
+
+    def __repr__(self) -> str:
+        return f"CSVExperiment(log_dir={self.log_dir})"
+
+    def __del__(self):
+        for val in getattr(self, "files", {}).values():
+            val.close()
+
+
+class CSVLogger(Logger):
+    """A minimal-dependency CSV logger.
+
+    Args:
+        exp_name (str): The name of the experiment.
+        log_dir (str or Path, optional): where the experiment should be saved.
+            Defaults to ``<cur_dir>/csv_logs``.
+        video_format (str, optional): how videos should be saved when calling :meth:`~torchrl.record.loggers.csv.CSVExperiment.add_video`. Must be one of
+            ``"pt"`` (video saved as a `video_<tag>_<step>.pt` file with torch.save),
+            ``"memmap"`` (video saved as a `video_<tag>_<step>.memmap` file with :class:`~tensordict.MemoryMappedTensor`),
+            ``"mp4"`` (video saved as a `video_<tag>_<step>.mp4` file, requires torchvision to be installed).
+            Defaults to ``"pt"``.
+        video_fps (int, optional): the video frames-per-seconds if `video_format="mp4"`. Defaults to 30.
+
+    """
+
+    experiment: CSVExperiment
+
+    def __init__(
+        self,
+        exp_name: str,
+        log_dir: str | None = None,
+        video_format: str = "pt",
+        video_fps: int = 30,
+    ) -> None:
+        if log_dir is None:
+            log_dir = "csv_logs"
+        self.video_format = video_format
+        self.video_fps = video_fps
+        super().__init__(exp_name=exp_name, log_dir=log_dir)
+        self._has_imported_moviepy = False
+
+    def _create_experiment(self) -> CSVExperiment:
+        """Creates a CSV experiment."""
+        log_dir = str(os.path.join(self.log_dir, self.exp_name))
+        return CSVExperiment(
+            log_dir, video_format=self.video_format, video_fps=self.video_fps
+        )
+
+    def log_scalar(self, name: str, value: float, step: int | None = None) -> None:
+        """Logs a scalar value to the tensorboard.
+
+        Args:
+            name (str): The name of the scalar.
+            value (float): The value of the scalar.
+            step (int, optional): The step at which the scalar is logged. Defaults to None.
+        """
+        self.experiment.add_scalar(name, value, global_step=step)
+
+    def log_video(
+        self, name: str, video: Tensor, step: int | None = None, **kwargs
+    ) -> None:
+        """Log videos inputs to a .pt (or other format) file.
+
+        Args:
+            name (str): The name of the video.
+            video (Tensor): The video to be logged.
+            step (int, optional): The step at which the video is logged. Defaults to None.
+            **kwargs: other kwargs passed to the underlying video logger.
+
+        .. note:: If the video format is `mp4`, many more arguments can be passed to the :meth:`~torchvision.io.write_video`
+            function.
+            For more information on video logging with :class:`~torchrl.record.loggers.csv.CSVLogger`,
+            see the :meth:`~torchrl.record.loggers.csv.CSVExperiment.add_video` documentation.
+        """
+        # check for correct format of the video tensor ((N), T, C, H, W)
+        # check that the color channel (C) is either 1 or 3
+        if video.dim() != 5 or video.size(dim=2) not in {1, 3}:
+            raise Exception(
+                "Wrong format of the video tensor. Should be ((N), T, C, H, W)"
+            )
+        self.experiment.add_video(
+            tag=name,
+            vid_tensor=video,
+            global_step=step,
+            **kwargs,
+        )
+
+    def log_hparams(self, cfg: DictConfig | dict) -> None:  # noqa: F821
+        """Logs the hyperparameters of the experiment.
+
+        Args:
+            cfg (DictConfig or dict): The configuration of the experiment.
+        """
+        txt = "\n".join([f"{k}: {val}" for k, val in sorted(cfg.items())])
+        self.experiment.add_text("hparams", txt)
+
+    def __repr__(self) -> str:
+        return f"CSVLogger(exp_name={self.exp_name}, experiment={self.experiment.__repr__()})"
+
+    def log_histogram(self, name: str, data: Sequence, **kwargs):
+        raise NotImplementedError("Logging histograms in cvs is not permitted.")
+
+    def print_log_dir(self):
+        """Prints the log directory content."""
+        tensordict.utils.print_directory_tree(self.log_dir)