Skip to content

Commit 07ace38

Browse files
mthrokfacebook-github-bot
authored andcommitted
Add tutorial to use NVDEC with Stream API (pytorch#2393)
Summary: This commit adds tutorial to enable/use NVDEC with Stream API. https://output.circle-artifacts.com/output/job/19e66a4b-1819-4804-8834-d38e6c80c4fd/artifacts/0/docs/hw_acceleration_tutorial.html Because the use of NVDEC requires build / install FFmpeg from source, this tutorial was authored on Google Colab, tailored to its environment. The tutorial here is the result of the notebook execution, with the link to the publicly accessible Google Colab notebook. Pull Request resolved: pytorch#2393 Reviewed By: hwangjeff Differential Revision: D36404408 Pulled By: mthrok fbshipit-source-id: 9c820d3db4d06c5b343ecad0708489125ca06948
1 parent 38cf5b7 commit 07ace38

File tree

6 files changed

+1334
-3
lines changed

6 files changed

+1334
-3
lines changed

.circleci/config.yml

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.circleci/config.yml.in

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -834,7 +834,7 @@ jobs:
834834
apt update && apt-get -qq install -y git make
835835
source /usr/local/etc/profile.d/conda.sh && conda activate python${PYTHON_VERSION}
836836
pip install -r requirements.txt -r requirements-tutorials.txt
837-
conda install -y 'ffmpeg<5'
837+
conda install -y pandoc 'ffmpeg<5'
838838
make 'SPHINXOPTS=-W' html
839839
environment:
840840
BUILD_GALLERY: 1
@@ -866,6 +866,7 @@ jobs:
866866
DONE
867867
- run:
868868
name: Upload docs
869+
no_output_timeout: 30m
869870
command: |
870871
# Don't use "checkout" step since it uses ssh, which cannot git push
871872
# https://circleci.com/docs/2.0/configuration-reference/#checkout

docs/requirements-tutorials.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,5 @@ pandas
55
librosa
66
numpy<=1.20
77
sentencepiece
8+
nbsphinx
9+
pandoc

docs/source/conf.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@
5151
"sphinxcontrib.katex",
5252
"sphinxcontrib.bibtex",
5353
"sphinx_gallery.gen_gallery",
54+
"nbsphinx",
5455
]
5556

5657
autodoc_member_order = "bysource"
@@ -169,7 +170,12 @@ def _get_pattern():
169170
# List of patterns, relative to source directory, that match files and
170171
# directories to ignore when looking for source files.
171172
# This patterns also effect to html_static_path and html_extra_path
172-
exclude_patterns = ["*/index.rst"]
173+
exclude_patterns = [
174+
"*/index.rst",
175+
"tutorials/*.md5",
176+
"tutorials/*.py",
177+
"tutorials/*.ipynb",
178+
]
173179

174180
# The name of the Pygments (syntax highlighting) style to use.
175181
pygments_style = "sphinx"

0 commit comments

Comments
 (0)