Skip to content

Commit 14aaf40

Browse files
committed
Indicate num_ffmpeg_threads is only relevant on CPU
1 parent c2bea4b commit 14aaf40

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/torchcodec/decoders/_video_decoder.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,11 @@ class VideoDecoder:
4343
cheap no-copy operation that allows these frames to be
4444
transformed using the `torchvision transforms
4545
<https://pytorch.org/vision/stable/transforms.html>`_.
46-
num_ffmpeg_threads (int, optional): The number of threads to use for decoding.
46+
num_ffmpeg_threads (int, optional): The number of threads to use for CPU decoding.
4747
Use 1 for single-threaded decoding which may be best if you are running multiple
4848
instances of ``VideoDecoder`` in parallel. Use a higher number for multi-threaded
4949
decoding which is best if you are running a single instance of ``VideoDecoder``.
50-
Default: 1.
50+
Default: 1. Ignored if ``device`` is not "cpu".
5151
device (str or torch.device, optional): The device to use for decoding. Default: "cpu".
5252
5353

0 commit comments

Comments
 (0)