Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 1 addition & 5 deletions docs/how-to/rocPyDecode-wheel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,7 @@ Create a rocPyDecode wheel file

A wheel distribution file for rocPyDecode can be created using a Python script located in the root of the `rocPyDecode GitHub repository <https://github.com/ROCm/rocPyDecode/blob/develop/>`_.

Use the develop branch if you want to preview new features or contribute to the rocPyDecode and rocPyJpegDecode code base. If you don't intend to preview new features or contribute to the codebase, clone the branch that corresponds to your version of ROCm.

.. note::

To include rocPyJpegDecode in the wheel file, install `rocJPEG <https://rocm.docs.amd.com/projects/rocJPEG/en/latest/index.html>`_ before running the wheel generation script.
Use the develop branch if you want to preview new features or contribute to the rocPyDecode code base. If you don't intend to preview new features or contribute to the codebase, clone the branch that corresponds to your version of ROCm.

Before running the wheel generation script, run `rocPyDecode-requirements.py <https://github.com/ROCm/rocPyDecode/blob/develop/rocPyDecode-requirements.py>`_ from the ``rocPyDecode`` root directory:

Expand Down
6 changes: 1 addition & 5 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ rocPyDecode provides Python bindings for the `rocDecode <https://rocm.docs.amd.c

rocPyDecode uses the rocDecode C++ SDK library to decode video streams based on the number of available media engines (VCNs) on the GPU.

rocPyJpegDecode provides Python bindings for the rocJPEG APIs and is installed as part of rocPyDecode when `rocJPEG <https://rocm.docs.amd.com/projects/rocJPEG/en/latest/>`_ is already installed on the system.

The rocPyDecode public repository is located at `https://github.com/ROCm/rocPyDecode <https://github.com/ROCm/rocPyDecode>`_.


Expand All @@ -21,8 +19,7 @@ The rocPyDecode public repository is located at `https://github.com/ROCm/rocPyDe
.. grid-item-card:: Install

* :doc:`rocPyDecode prerequisites <./install/rocPyDecode-prerequisites>`
* :doc:`rocPyDecode installation overview <./install/rocPyDecode-install>`
* :doc:`rocPyDecode CMake installation <./install/rocPyDecode-cmake-install>`
* :doc:`rocPyDecode installation <./install/rocPyDecode-cmake-install>`

.. grid:: 2
:gutter: 3
Expand All @@ -49,7 +46,6 @@ The rocPyDecode public repository is located at `https://github.com/ROCm/rocPyDe
* :doc:`rocPyDecode structures <./reference/structures>`
* :doc:`rocPyDecode decoder class <./reference/decoderClass>`
* :doc:`rocPyDecode demuxer class <./reference/demuxerClass>`
* :doc:`rocPyJpegDecode decoder class <./reference/rocPyJPEGDecode-api>`


To contribute to the documentation, refer to
Expand Down
20 changes: 7 additions & 13 deletions docs/install/rocPyDecode-cmake-install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,13 @@
Building and installing rocPyDecode with CMake
********************************************************************

.. note::

sudo access might be required to build and install with CMake.

rocPyDecode can be built using CMake. rocPyJpegDecode will only be built if `rocJPEG <https://rocm.docs.amd.com/projects/rocJPEG/en/latest/index.html>`_ is already installed. If rocJPEG isn't installed, rocPyJpegDecode will be omitted from the installation.
rocPyDecode is built and installed using CMake.

Once rocPyDecode has been built and installed, tar and deb packages can be generated for distribution. :doc:`Wheel distribution files can also be created <../how-to/rocPyDecode-wheel>`.

The rocPyDecode source code and installation scripts are available from the `rocPyDecode GitHub Repository <https://github.com/ROCm/rocPyDecode>`_.

The develop branch is the default branch and is intended for users who want to preview new features or contribute to the rocPyDecode or rocPyJpegDecode code base. If you don't intend to preview new features or contribute to the codebase, clone the branch that corresponds to your version of ROCm.
The develop branch is the default branch and is intended for users who want to preview new features or contribute to the rocPyDecode code base. If you don't intend to preview new features or contribute to the codebase, clone the branch that corresponds to your version of ROCm.

Before building and installing rocPyDecode, run `rocPyDecode-requirements.py <https://github.com/ROCm/rocPyDecode/blob/develop/rocPyDecode-requirements.py>`_ from the ``rocPyDecode`` root directory:

Expand All @@ -43,17 +39,17 @@ Change directory to ``build``, then use ``cmake`` to generate a makefile.
cd build
cmake ../

By default rocPyDecode and rocPyJpegDecode will be built and installed for all versions of Python available on the system. In some instances, such as when rocPyDecode and rocPyJpegDecode are being built and installed in a conda environment in a Docker container, there may be a hidden Python installation. rocPyDecode and rocPyJpegDecode won't be built or installed for this version of Python unless the ``-DPYTHON_FOLDER_SUGGESTED=path_to_python_installation`` cmake directive is used. This will add the hidden Python installation to the list of targets.
By default rocPyDecode will be built and installed for all versions of Python available on the system. In some instances, such as when rocPyDecode is being built and installed in a conda environment in a Docker container, there may be a hidden Python installation. rocPyDecode won't be built or installed for this version of Python unless the ``-DPYTHON_FOLDER_SUGGESTED=path_to_python_installation`` cmake directive is used. This will add the hidden Python installation to the list of targets.

For example, this will add the version of Python installed at ``/opt/miniconda3/bin/python`` to the target list:

.. code:: shell

cmake -DPYTHON_FOLDER_SUGGESTED=/opt/miniconda3/bin/python3 ../

You can also build and install rocPyDecode and rocPyJpegDecode for a specific Python version. Use the ``-DPYTHON_VERSION_SUGGESTED=version_num`` cmake directive to build and install only for the specified Python version.
You can also build and install rocPyDecode for a specific Python version. Use the ``-DPYTHON_VERSION_SUGGESTED=version_num`` cmake directive to build and install only for the specified Python version.

For example, the following command will build rocPyDecode and rocPyJpegDecode only for Python 3.12:
For example, the following command will build rocPyDecode only for Python 3.12:

.. code:: shell

Expand All @@ -64,7 +60,7 @@ For example, the following command will build rocPyDecode and rocPyJpegDecode on

``PYTHON_VERSION_SUGGESTED`` and ``PYTHON_FOLDER_SUGGESTED`` are mutually exclusive and can't be used together.

Once the makefile has been generated, make and install rocPyDecodee:
Once the makefile has been generated, make and install rocPyDecode:

.. code::

Expand All @@ -85,6 +81,4 @@ You can then install the deb packages with ``apt install``. For example:
sudo apt install ./rocpydecode_0.8.0-local_amd64.deb
sudo apt install ./rocpydecode-test_0.8.0-local_amd64.deb

.. note::

The deb files and tar files will include rocPyJpegDecode if rocJPEG was installed on the system before rocPyDecode was installed.

25 changes: 0 additions & 25 deletions docs/install/rocPyDecode-install.rst

This file was deleted.

3 changes: 1 addition & 2 deletions docs/install/rocPyDecode-prerequisites.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ rocPyDecode has the following prerequisites:
* `DLPack <https://dmlc.github.io/dlpack/latest/>`_
* `NumPy, for running tests and samples <https://numpy.org/>`_

rocPyJpegDecode additionally requires `rocJPEG <https://rocm.docs.amd.com/projects/rocJPEG/en/latest/index.html>`_.

All prerequisites except for rocJPEG are installed with the `rocPyDecode-requirements.py <https://github.com/ROCm/rocPyDecode/blob/develop/rocPyDecode-requirements.py>`_ script.
All prerequisites except for NumPy are installed with the `rocPyDecode-requirements.py <https://github.com/ROCm/rocPyDecode/blob/develop/rocPyDecode-requirements.py>`_ script.

39 changes: 0 additions & 39 deletions docs/reference/rocPyJPEGDecode-api.rst

This file was deleted.

12 changes: 4 additions & 8 deletions docs/sphinx/_toc.yml.in
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,14 @@ subtrees:
- caption: Install
entries:
- file: install/rocPyDecode-prerequisites
title: rocPyDecode prerequisites
- file: install/rocPyDecode-install
title: Installing rocPyDecode
title: Prerequisites
- file: install/rocPyDecode-cmake-install
title: Installing rocPyDecode with CMake
title: Installing with CMake

- caption: Conceptual
entries:
- file: conceptual/rocPyDecode-mem-types
title: rocPyDecode surface data memory locations
title: Surface data memory locations

- caption: How to
entries:
Expand All @@ -31,7 +29,7 @@ subtrees:
- caption: Tutorials
entries:
- file: tutorials/rocPyDecode-samples
title: rocPyDecode samples
title: Samples

- caption: Reference
entries:
Expand All @@ -45,8 +43,6 @@ subtrees:
title: rocPyDecode Structures
- file: reference/decoderClass
- file: reference/demuxerClass
- file: reference/rocPyJPEGDecode-api
title: rocPyJpegDecode decoder class

- caption: About
entries:
Expand Down
9 changes: 1 addition & 8 deletions docs/tutorials/rocPyDecode-samples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,7 @@
rocPyDecode samples and tests
*************************************************************

rocPyDecode and rocPyJpegDecode samples are located in the |samples|_ directory of the rocPyDecode GitHub repository.

The rocPyDecode samples are located in |rocpydecode|_ and rocPyJpegDecode samples are located in |rocpyjpeg|_. Jupyter notebooks are also available for rocPyJpegDecode.

rocPyDecode tests are located in |tests|_.
rocPyDecode samples and tests are located in |samples|_ and |tests|_ in the rocPyDecode GitHub repository.

.. |samples| replace:: ``samples``
.. _samples: https://github.com/ROCm/rocPyDecode/tree/develop/samples
Expand All @@ -20,6 +16,3 @@ rocPyDecode tests are located in |tests|_.

.. |rocpydecode| replace:: ``samples/rocdecode``
.. _rocpydecode: https://github.com/ROCm/rocPyDecode/tree/develop/samples/rocdecode

.. |rocpyjpeg| replace:: ``samples/rocjpeg``
.. _rocpyjpeg: https://github.com/ROCm/rocPyDecode/tree/develop/samples/rocjpeg