diff --git a/docs/how-to/rocPyDecode-wheel.rst b/docs/how-to/rocPyDecode-wheel.rst index 070d3ffc..4ef42dfc 100644 --- a/docs/how-to/rocPyDecode-wheel.rst +++ b/docs/how-to/rocPyDecode-wheel.rst @@ -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 `_. -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 `_ 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 `_ from the ``rocPyDecode`` root directory: diff --git a/docs/index.rst b/docs/index.rst index 88650fdc..2e29c3ca 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,8 +10,6 @@ rocPyDecode provides Python bindings for the `rocDecode `_ is already installed on the system. - The rocPyDecode public repository is located at `https://github.com/ROCm/rocPyDecode `_. @@ -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 @@ -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 diff --git a/docs/install/rocPyDecode-cmake-install.rst b/docs/install/rocPyDecode-cmake-install.rst index 6a20dc1b..93f8994a 100644 --- a/docs/install/rocPyDecode-cmake-install.rst +++ b/docs/install/rocPyDecode-cmake-install.rst @@ -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 `_ 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 `_. -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 `_ from the ``rocPyDecode`` root directory: @@ -43,7 +39,7 @@ 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: @@ -51,9 +47,9 @@ For example, this will add the version of Python installed at ``/opt/miniconda3/ 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 @@ -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:: @@ -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. + diff --git a/docs/install/rocPyDecode-install.rst b/docs/install/rocPyDecode-install.rst deleted file mode 100644 index a67b52ce..00000000 --- a/docs/install/rocPyDecode-install.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. meta:: - :description: rocPyDecode Installation - :keywords: install, rocPyDecode, rocPyJpegDecode, AMD, ROCm, wheel, docker, bare metal - -******************************************************************** -Installing rocPyDecode -******************************************************************** - -The rocPyDecode source code and its installation scripts are available from the `rocPyDecode GitHub Repository `_. - -rocPyJpegDecode is installed with rocPyDecode if `rocJPEG `_ is already installed on the system. If rocJPEG is not already installed, the rocPyJpegDecode libraries won't be installed. - -The full list of prerequisites for both rocPyDecode and rocPyJpegDecode can be found in :doc:`rocPyDecode prerequisites <./rocPyDecode-prerequisites>`. - -The develop branch is the default rocPyDecode branch. The develop branch 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 rocPyDecode branch that corresponds to your version of ROCm. - -rocPyDecode is installed with :doc:`CMake <./rocPyDecode-cmake-install>`. - -Cmake can be used to created deb files and zipped tar files for distribution. :docs:`Wheel distribution files can also be created <../how-to/rocPyDecode-wheel>` - -The pip installation method can be used to generate Python egg and wheel files for distribution. - -.. note:: - - The deb files, tar files, and wheel files will include rocPyJpegDecode if rocJPEG was installed on the system before installing rocPyDecode. diff --git a/docs/install/rocPyDecode-prerequisites.rst b/docs/install/rocPyDecode-prerequisites.rst index a5d84f0f..7c4bbc44 100644 --- a/docs/install/rocPyDecode-prerequisites.rst +++ b/docs/install/rocPyDecode-prerequisites.rst @@ -28,7 +28,6 @@ rocPyDecode has the following prerequisites: * `DLPack `_ * `NumPy, for running tests and samples `_ -rocPyJpegDecode additionally requires `rocJPEG `_. -All prerequisites except for rocJPEG are installed with the `rocPyDecode-requirements.py `_ script. +All prerequisites except for NumPy are installed with the `rocPyDecode-requirements.py `_ script. diff --git a/docs/reference/rocPyJPEGDecode-api.rst b/docs/reference/rocPyJPEGDecode-api.rst deleted file mode 100644 index 74abd176..00000000 --- a/docs/reference/rocPyJPEGDecode-api.rst +++ /dev/null @@ -1,39 +0,0 @@ -.. meta:: - :description: rocPyJpegDecode API documentation - :keywords: rocPyJpegDecode, rocDecode, rocJPEG, ROCm, API, documentation, video, decode, decoding, acceleration - -********************************* -rocPyJpegDecode Python API -********************************* - -The rocPyJpegDecode API is available in the rocDecode GitHub repository under the `pyRocJpegDecode `_ directory. - -The following rocPyJpegDecode API calls are used to decode a JPEG image. - -``initialize_hip()`` - Initializes the HIP device for decoding. The user can specify the device to use for decoding. By default device 0 is used. - - ``initialize_hip()`` must be called before any other call is made to the rocPyJpeg library. - -``decoder()`` - Constructor for the main decoding class. - -``decoder().set_output_image_format()`` - Passes the output image format to the decoder engine. The output image format can be set to ``ROCJPEG_OUTPUT_RGB`` or ``ROCJPEG_OUTPUT_RGB_PLANAR``. These types are defined in ``pyRocJpegDecode/types.py``. - -``decoder().read`` and ``decoder().decode`` - Both these functions read in a JPEG image or batch of JPEG images to be decoded and pass them to the decoder, then return the decoded images. - - If only one image is passed to the function, it will return one image tensor in the specified output format. If more than one image is passed to the function, it will return a list of image tensors in the specified output format. - - If any image fails to be decoded because it's in an unsupported format or is corrupted, no image will be returned and ``decode`` will produce an error message. - - Input can be any of the following: - - * The full path to one image. - * The full path to a folder containing multiple images. The batch size must also be passed to the function. - * One image stored as a memory buffer - * Multiple images stored as memory buffers. The batch size must also be passed to the function. - * One image stored as a NumPy array. - * Multiple images stored as NumPy arrays. The batch size must also be passed to the function. - \ No newline at end of file diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in index 9287d186..f38726e9 100644 --- a/docs/sphinx/_toc.yml.in +++ b/docs/sphinx/_toc.yml.in @@ -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: @@ -31,7 +29,7 @@ subtrees: - caption: Tutorials entries: - file: tutorials/rocPyDecode-samples - title: rocPyDecode samples + title: Samples - caption: Reference entries: @@ -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: diff --git a/docs/tutorials/rocPyDecode-samples.rst b/docs/tutorials/rocPyDecode-samples.rst index 5a2e66bc..a25a6610 100644 --- a/docs/tutorials/rocPyDecode-samples.rst +++ b/docs/tutorials/rocPyDecode-samples.rst @@ -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 @@ -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 \ No newline at end of file