Skip to content
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

Document DALI video plugin #5461

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Document DALI video plugin #5461

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
33 changes: 31 additions & 2 deletions docs/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,34 @@ Installing this package will install ``nvidia-dali-cudaXXX`` and its dependencie
Therefore, installing the latest ``nvidia-dali-tf-plugin-cudaXXX``, will replace any older ``nvidia-dali-cudaXXX`` version already installed.
To work with older versions of DALI, provide the version explicitly to the ``pip install`` command.

nvidia-dali-video
^^^^^^^^^^^^^^^^^

DALI now ships its new video decoding functionality as a separate DALI plugin distributed as a source distribution.
Copy link
Contributor

Choose a reason for hiding this comment

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

now ships its new - I'm not sure if we will remember to change this to once the plugin is well established.

To install it, first install NVIDIA DALI, then:

.. code-block:: bash

pip install scikit-build cmake ninja # dependencies to be able to build the plugin
JanuszL marked this conversation as resolved.
Show resolved Hide resolved
pip install --extra-index-url https://pypi.nvidia.com --upgrade nvidia-dali-video


nvidia-dali-video uses NVIDIA VideoCodecSDK and FFmpeg to implement its decoding functionality.
The plugin installation is able to detect FFmpeg installed in the system, provide a prebuilt version
if not found, or build from source if explicitly requested. This behavior can be controlled via
environment variables:

.. code-block:: bash
# Default: try finding FFmpeg in the system, or use prebuilt if not found
pip install --extra-index-url https://pypi.nvidia.com --upgrade nvidia-dali-video
# Force building FFmpeg from source
BUILD_FFMPEG=1 pip install --extra-index-url https://pypi.nvidia.com --upgrade nvidia-dali-video
# Force using minimal prebuilt FFmpeg libraries
USE_PREBUILT_FFMPEG=1 pip install --extra-index-url https://pypi.nvidia.com --upgrade nvidia-dali-video


nvidia-dali-video is only available starting from DALI 1.39.

pip - Nightly and Weekly Releases
---------------------------------

Expand All @@ -140,14 +168,15 @@ To access most recent nightly builds please use flowing release channel:

pip install --extra-index-url https://developer.download.nvidia.com/compute/redist/nightly --upgrade nvidia-dali-nightly-cuda110
pip install --extra-index-url https://developer.download.nvidia.com/compute/redist/nightly --upgrade nvidia-dali-tf-plugin-nightly-cuda110
pip install --extra-index-url https://developer.download.nvidia.com/compute/redist/nightly --upgrade nvidia-dali-video-nightly

* for CUDA 12.0:

.. code-block:: bash

pip install --extra-index-url https://developer.download.nvidia.com/compute/redist/nightly --upgrade nvidia-dali-nightly-cuda120
pip install --extra-index-url https://developer.download.nvidia.com/compute/redist/nightly --upgrade nvidia-dali-tf-plugin-nightly-cuda120

pip install --extra-index-url https://developer.download.nvidia.com/compute/redist/nightly --upgrade nvidia-dali-video-nightly

Weekly Builds
^^^^^^^^^^^^^
Expand All @@ -159,7 +188,7 @@ builds please use the following release channel (available only for CUDA 12):

pip install --extra-index-url https://developer.download.nvidia.com/compute/redist/weekly --upgrade nvidia-dali-weekly-cuda120
pip install --extra-index-url https://developer.download.nvidia.com/compute/redist/weekly --upgrade nvidia-dali-tf-plugin-weekly-cuda120

pip install --extra-index-url https://developer.download.nvidia.com/compute/redist/weekly --upgrade nvidia-dali-video-weekly

pip - Legacy Releases
---------------------
Expand Down
Loading