From 834c750d9fa1d39fbb869308ef1e7c04577976eb Mon Sep 17 00:00:00 2001 From: Scott Schneider Date: Mon, 3 Mar 2025 06:35:07 -0800 Subject: [PATCH] Update docs to indicate we handle URLs. --- src/torchcodec/decoders/_video_decoder.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/torchcodec/decoders/_video_decoder.py b/src/torchcodec/decoders/_video_decoder.py index 6ab59e0c2..0b51a3544 100644 --- a/src/torchcodec/decoders/_video_decoder.py +++ b/src/torchcodec/decoders/_video_decoder.py @@ -26,7 +26,8 @@ class VideoDecoder: Args: source (str, ``Pathlib.path``, ``torch.Tensor``, or bytes): The source of the video. - - If ``str`` or ``Pathlib.path``: a path to a local video file. + - If ``str``: a local path or a URL to a video file. + - If ``Pathlib.path``: a path to a local video file. - If ``bytes`` object or ``torch.Tensor``: the raw encoded video data. stream_index (int, optional): Specifies which stream in the video to decode frames from. Note that this index is absolute across all media types. If left unspecified, then