Skip to content

[torchcodec] rename deprecated sampler #906

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −19
Open

[torchcodec] rename deprecated sampler #906

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 4 additions & 17 deletions src/torchcodec/_samplers/video_clip_sampler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,25 +105,12 @@ class IndexBasedSamplerArgs(SamplerArgs):
sample_step: int = 1


class VideoClipSampler(nn.Module):
class DEPRECATED_VideoClipSampler(nn.Module):
"""
VideoClipSampler will do video clip sampling with given video args and sampler args.
The video args contains video related information, frames_per_clip, dimensions etc.
The sampler args can be either time-based or index-based, it will be used to decide clip start time pts or index.
ClipSampling support, random, uniform, periodic, target, keyframe sampling etc.
DEPRECATED: Do not use. The supported samplers are in `torchcodec.samplers`. See:

Args:
video_args (`VideoArgs`): The video args
sampler_args (`SamplerArgs`): The sampler args. Can be TimeBasedSamplerArgs or IndexBasedSamplerArgs
decoder_args (`DecoderArgs`): Decoder args contain value needs for decoder, for example, thread count

Example:
>>> video_args = VideoArgs(desired_width=224, desired_height=224)
>>> time_based_sampler_args = TimeBasedSamplerArgs(sampler_type="random", clips_per_video=1, frames_per_clip=4)
>>> video_decoder_args = DecoderArgs(num_threads=1)
>>> video_clip_sampler = VideoClipSampler(video_args, time_based_sampler_args, decoder_args)
>>> clips = video_clip_sampler(video_data)
clips now contains a list of clip, where clip is a list of frame tensors, each tensor represents a frame image.
* https://docs.pytorch.org/torchcodec/stable/api_ref_torchcodec.html
* https://docs.pytorch.org/torchcodec/stable/generated_examples/decoding/sampling.html
"""

def __init__(
Expand Down
4 changes: 2 additions & 2 deletions test/test_video_clip_sampler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
import pytest
import torch
from torchcodec._samplers import (
DEPRECATED_VideoClipSampler,
IndexBasedSamplerArgs,
TimeBasedSamplerArgs,
VideoArgs,
VideoClipSampler,
)

from .utils import NASA_VIDEO
Expand All @@ -34,7 +34,7 @@ def test_sampler(sampler_args):
torch.manual_seed(0)
desired_width, desired_height = 320, 240
video_args = VideoArgs(desired_width=desired_width, desired_height=desired_height)
sampler = VideoClipSampler(video_args, sampler_args)
sampler = DEPRECATED_VideoClipSampler(video_args, sampler_args)
clips = sampler(NASA_VIDEO.to_tensor())
assert len(clips) == sampler_args.clips_per_video
clip = clips[0]
Expand Down
Loading