Docs - Updates for 6.3 (#81)

This commit is contained in:
Kiriti Gowda
2024-11-22 10:52:10 -08:00
gecommit door GitHub
bovenliggende fd32c06049
commit 241f9d731c
2 gewijzigde bestanden met toevoegingen van 19 en 17 verwijderingen
+15 -14
Bestand weergeven
@@ -18,7 +18,7 @@ rocJPEG is a high performance JPEG decode SDK for AMD GPUs. Using the rocJPEG AP
## Prerequisites
* Linux distribution
* Ubuntu - `20.04` / `22.04` / `24.04`
* Ubuntu - `22.04` / `24.04`
* RHEL - `8` / `9`
* SLES - `15-SP5`
@@ -32,19 +32,20 @@ rocJPEG is a high performance JPEG decode SDK for AMD GPUs. Using the rocJPEG AP
> [!IMPORTANT]
> `sudo amdgpu-install --usecase=rocm`
* Video Acceleration API (VA-API) Version `2.16.0+` - `Libva` is an implementation for VA-API
```shell
sudo apt install libva-amdgpu-dev
```
> [!NOTE]
> RPM Packages for `RHEL`/`SLES` - `libva-amdgpu-devel`
* Video Acceleration API - `libva-amdgpu-dev` is an AMD implementation for VA-API
```shell
sudo apt install libva-amdgpu-dev
```
> [!NOTE]
> * RPM Packages for `RHEL`/`SLES` - `libva-amdgpu-devel`
> * `libva-amdgpu` is strongly recommended over system `libva` as it is used for building mesa-amdgpu-va-driver
* AMD VA Drivers
```shell
sudo apt install libva2-amdgpu libva-amdgpu-drm2 libva-amdgpu-wayland2 libva-amdgpu-x11-2 mesa-amdgpu-va-drivers
```
> [!NOTE]
> RPM Packages for `RHEL`/`SLES` - `libva-amdgpu mesa-amdgpu-va-drivers`
```shell
sudo apt install libva2-amdgpu libva-amdgpu-drm2 libva-amdgpu-wayland2 libva-amdgpu-x11-2 mesa-amdgpu-va-drivers
```
> [!NOTE]
> RPM Packages for `RHEL`/`SLES` - `libva-amdgpu mesa-amdgpu-va-drivers`
* CMake `3.10` or later
@@ -72,7 +73,6 @@ rocJPEG is a high performance JPEG decode SDK for AMD GPUs. Using the rocJPEG AP
>[!NOTE]
>
> * All package installs are shown with the `apt` package manager. Use the appropriate package manager for your operating system.
> * To install rocJPEG with minimum requirements, follow the [quick-start](./docs/install/quick-start.rst) instructions
### Prerequisites setup script for Linux
@@ -95,7 +95,8 @@ The installation process uses the following steps:
* Install ROCm `6.3.0` or later with [amdgpu-install](https://rocm.docs.amd.com/projects/install-on-linux/en/latest/how-to/amdgpu-install.html) with `--usecase=rocm`
* Use either [Package install](#package-install) or [Source install](#source-install) as described below.
>[!IMPORTANT]
> Use **either** [package install](#package-install) **or** [source install](#source-install) as described below.
### Package install
@@ -12,14 +12,15 @@ ROCm 6.3.0 or later must be installed before installing rocJPEG. See `Quick star
rocJPEG can be installed on the following Linux environments:
* Ubuntu 20.04, 22.04, 24.04
* Ubuntu 22.04 or 24.04
* RHEL 8 or 9
* SLES: 15-SP5
The following prerequisites are installed by the package installer. If you are building and installing using the source code, use the `rocJPEG-setup.py <https://github.com/ROCm/rocJPEG/blob/develop/rocJPEG-setup.py>`_ setup script available in the rocJPEG GitHub repository to install these prerequisites.
* Libva, an implementation for Video Acceleration API (VA-API), version 1.16 or later
* Video Acceleration API (VA-API) - libva-amdgpu-dev is an AMD implementation for VA-API
* AMD VA Drivers
* CMake version 3.5 or later
* CMake version 3.10 or later
* AMD Clang++
* pkg-config
* libstdc++-12-dev for installations on Ubuntu 22.04