Skip to content

Commit bd4ca66

Browse files
committed
Reference tutorial in doc strings
1 parent daa33b6 commit bd4ca66

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

src/torchcodec/decoders/_audio_decoder.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,9 @@ class AudioDecoder:
3232
- If ``Pathlib.path``: a path to a local video or audio file.
3333
- If ``bytes`` object or ``torch.Tensor``: the raw encoded audio data.
3434
- If file-like object: we read video data from the object on demand. The object must
35-
expose the methods ``read(self, size: int) -> bytes`` and
36-
``seek(self, offset: int, whence: int) -> bytes``. Read more in TODO_FILE_LIKE_TUTORIAL.
35+
expose the methods `read(self, size: int) -> bytes` and
36+
`seek(self, offset: int, whence: int) -> bytes`. Read more in:
37+
:ref:`sphx_glr_generated_examples_file_like.py`.
3738
stream_index (int, optional): Specifies which stream in the file to decode samples from.
3839
Note that this index is absolute across all media types. If left unspecified, then
3940
the :term:`best stream` is used.

src/torchcodec/decoders/_video_decoder.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,9 @@ class VideoDecoder:
2828
- If ``Pathlib.path``: a path to a local video file.
2929
- If ``bytes`` object or ``torch.Tensor``: the raw encoded video data.
3030
- If file-like object: we read video data from the object on demand. The object must
31-
expose the methods ``read(self, size: int) -> bytes`` and
32-
``seek(self, offset: int, whence: int) -> bytes``. Read more in TODO_FILE_LIKE_TUTORIAL.
31+
expose the methods `read(self, size: int) -> bytes` and
32+
`seek(self, offset: int, whence: int) -> bytes`. Read more in:
33+
:ref:`sphx_glr_generated_examples_file_like.py`.
3334
stream_index (int, optional): Specifies which stream in the video to decode frames from.
3435
Note that this index is absolute across all media types. If left unspecified, then
3536
the :term:`best stream` is used.

0 commit comments

Comments
 (0)