AI/rocm-systems
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update docs (#56)

Browse Source 
* update docs

* remove extra line

* clean up

[ROCm/rocjpeg commit: c0ce1e45b0]
This commit is contained in:
Aryan Salmanpour
2024-09-18 12:56:20 -04:00
committed by GitHub
parent dd860bbe26
commit 094386c727
3 changed files with 42 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files
projects/rocjpeg/docs/index.rst
+15 -11
View File
@@ -10,9 +10,7 @@ rocJPEG provides APIs and samples that you can use to easily access the JPEG dec
features of your media engines (VCNs). It also allows interoperability with other compute engines on
the GPU using Video Acceleration API (VA-API)/HIP. To learn more, see :doc:`what-is-rocJPEG`
You can access rocJPEG code on our `GitHub repository <https://github.com/ROCm/rocJPEG>`_.
Our documentation is structured as follows:
The code is open and hosted at `GitHub repository <https://github.com/ROCm/rocJPEG>`_.
.. grid:: 2
:gutter: 3
@@ -22,22 +20,28 @@ Our documentation is structured as follows:
* :doc:`Quick-start <./install/quick-start>`
* :doc:`rocJPEG installation <./install/install>`
The documentation is structured as follows:
.. grid:: 2
:gutter: 3
.. grid-item-card:: Tutorials
* `GitHub samples <https://github.com/ROCm/rocJPEG/tree/develop/samples>`_
.. grid-item-card:: How to
* :doc:`Use rocJPEG <how-to/using-rocjpeg>`
.. grid-item-card:: API reference
* :doc:`API library <../doxygen/html/files>`
* :doc:`Functions <../doxygen/html/globals>`
* :doc:`Data structures <../doxygen/html/annotated>`
.. grid-item-card:: How to
* :doc:`Use rocJPEG <how-to/using-rocjpeg>`
.. grid-item-card:: Tutorials
* `GitHub samples <https://github.com/ROCm/rocJPEG/tree/develop/samples>`_
To contribute to the documentation, refer to
`Contributing to ROCm <https://rocm.docs.amd.com/en/latest/contribute/contributing.html>`_.
You can find licensing information on the
`Licensing <https://rocm.docs.amd.com/en/latest/about/license.html>`_ page.
`Licensing <https://rocm.docs.amd.com/en/latest/about/license.html>`_ page.
projects/rocjpeg/docs/install/install.rst
+8 -23
View File
@@ -9,15 +9,6 @@ Installation
rocJPEG is a high performance JPEG decode SDK for AMD GPUs. Using the rocJPEG API,
you can access the JPEG decoding features available on your GPU.
Supported JPEG chroma subsampling
========================================
* YUV 4:4:4
* YUV 4:4:0
* YUV 4:2:2
* YUV 4:2:0
* YUV 4:0:0
Prerequisites
========================================
@@ -196,23 +187,17 @@ Docker
You can find rocJPEG Docker containers in our
`GitHub repository <https://github.com/ROCm/rocJPEG/tree/develop/docker>`_.
Documentation
========================================
Run the following code to build our documentation locally.
.. code:: shell
cd docs
pip3 install -r sphinx/requirements.txt
python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
For more information on documentation builds, refer to the
:doc:`Building documentation <rocm:contribute/building>` page.
Hardware capabilities
===================================================
* Supported JPEG chroma subsampling
* YUV 4:4:4
* YUV 4:4:0
* YUV 4:2:2
* YUV 4:2:0
* YUV 4:0:0
The following table shows the capabilities of the VCN and total number of JPEG cores for each supported GPU
architecture.