Skip to content

Rework README example - #1425

Merged
NicolasHug merged 3 commits into
meta-pytorch:mainfrom
NicolasHug:rework-readme-example
May 21, 2026
Merged

Rework README example#1425
NicolasHug merged 3 commits into
meta-pytorch:mainfrom
NicolasHug:rework-readme-example

Conversation

@NicolasHug

Copy link
Copy Markdown
Contributor

Our README.md had an example about clip sampling, which isn't irrelevant, but less important than encoding.

Also remove the benchmarking section because it's mostly outdated by now, and it compares against torchaudio and torchvision which don't have decoders anymore.

@pytorch-bot

pytorch-bot Bot commented May 19, 2026

Copy link
Copy Markdown

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/meta-pytorch/torchcodec/1425

Note: Links to docs will display an error until the docs builds have been completed.

❗ 1 Active SEVs

There are 1 currently active SEVs. If your PR is affected, please view them below:

❌ 1 New Failure

As of commit 07bc410 with merge base 66ad118 (image):

NEW FAILURE - The following job has failed:

This comment was automatically generated by Dr. CI and updates every 15 minutes.

@meta-cla meta-cla Bot added the CLA Signed This label is managed by the Meta Open Source bot. label May 19, 2026
Comment thread README.md Outdated
# [0.0334, 0.0334, 0.0334, 0.0334],
# ... (truncated), dtype=torch.float64)
frames = decoder[:] # uint8 tensor of shape [N, C, H, W]
VideoEncoder(frames, frame_rate=decoder.metadata.average_fps).to_file("output.mp4")

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO: this should be the multi-stream encoder. Merge just before 0.13 only.

@NicolasHug
NicolasHug merged commit 95e2728 into meta-pytorch:main May 21, 2026
81 of 82 checks passed
@NicolasHug
NicolasHug deleted the rework-readme-example branch May 21, 2026 11:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Meta Open Source bot.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant