From 6a9da801aafcdeda9ef00038bb8f375be9720b2f Mon Sep 17 00:00:00 2001
From: Nicolas Hug <contact@nicolas-hug.com>
Date: Tue, 12 Nov 2024 11:51:08 +0000
Subject: [PATCH] Document that pts_seconds and duration_seconds are on GPU

---
 src/torchcodec/_frame.py | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/torchcodec/_frame.py b/src/torchcodec/_frame.py
index b9e0fd575..a8fc7f5ba 100644
--- a/src/torchcodec/_frame.py
+++ b/src/torchcodec/_frame.py
@@ -62,6 +62,10 @@ class FrameBatch(Iterable):
     or 5D for sequences of clips, as returned by the :ref:`samplers
     <sphx_glr_generated_examples_sampling.py>`. When ``data`` is 4D (resp.  5D)
     the ``pts_seconds`` and ``duration_seconds`` tensors are 1D (resp. 2D).
+
+    .. note::
+        The ``pts_seconds`` and ``duration_seconds`` Tensors are always returned
+        on CPU, even if ``data`` is on GPU.
     """
 
     data: Tensor