made changes to installation and landing pages (#445)
* initial commit of changes to the installation and landing pages
* deleted original install; fixed the toc; fixed typos
* fixed some wording issues; fixed some formatting issues
* adding back install.rst to try to fix the conflict
---------
Co-authored-by: Aryan Salmanpour <aryan.salmanpour@amd.com>
[ROCm/rocdecode commit: 6cc30f12a4]
此提交包含在：
spolifroni-amd和Aryan Salmanpour authored and 
GitHub committed
1 父節點
3344bee39d
當前提交
67052ff454
10 file changed
+271
-66
No files matched your search
@@ -1,42 +0,0 @@
|
||||
.. meta::
|
||||
:description: Install rocDecode
|
||||
:keywords: install, rocDecode, AMD, ROCm
|
||||
|
||||
********************************************************************
|
||||
rocDecode quick start installation
|
||||
********************************************************************
|
||||
|
||||
To install the rocDecode runtime with minimum requirements, follow these steps:
|
||||
|
||||
1. Install core ROCm components (ROCm 6.1.0 or later) using the
|
||||
:doc:`native package manager <rocm-install-on-linux:how-to/native-install/index>`
|
||||
installation instructions.
|
||||
|
||||
* Register repositories
|
||||
* Register kernel-mode driver
|
||||
* Register ROCm packages
|
||||
* Install kernel driver (``amdgpu-dkms``)--only required on bare metal install. Docker runtime uses the
|
||||
base ``dkms`` package irrespective of the version installed.
|
||||
|
||||
2. Install rocDecode runtime package. rocDecode only provides the ``librocdecode.so`` library (the
|
||||
runtime package only installs the required core dependencies).
|
||||
|
||||
.. tab-set::
|
||||
|
||||
.. tab-item:: Ubuntu
|
||||
|
||||
.. code:: shell
|
||||
|
||||
sudo apt install rocdecode
|
||||
|
||||
.. tab-item:: RHEL
|
||||
|
||||
.. code:: shell
|
||||
|
||||
sudo yum install rocdecode
|
||||
|
||||
.. tab-item:: SLES
|
||||
|
||||
.. code:: shell
|
||||
|
||||
sudo zypper install rocdecode
|
||||
@@ -0,0 +1,55 @@
|
||||
.. meta::
|
||||
:description: Build and install rocDecode with the source code
|
||||
:keywords: install, building, rocDecode, AMD, ROCm, source code, developer
|
||||
|
||||
********************************************************************
|
||||
Building and installing rocDecode from source code
|
||||
********************************************************************
|
||||
|
||||
If you will be contributing to the rocDecode code base, or if you want to preview new features, build rocDecode from its source code.
|
||||
|
||||
If you will not be previewing features or contributing to the code base, use the :doc:`package installers <./rocDecode-package-install>` to install rocDecode.
|
||||
|
||||
Before building rocDecode, use `rocDecode-setup.py <https://github.com/ROCm/rocDecode/blob/develop/rocDecode-setup.py>`_ to install all the required prerequisites:
|
||||
|
||||
.. code:: shell
|
||||
|
||||
python3 rocDecode-setup.py [--rocm_path ROCM_INSTALLATION_PATH; default=/opt/rocm]
|
||||
[--runtime {ON|OFF}; default=ON]
|
||||
[--developer {ON|OFF}; default=OFF]
|
||||
|
||||
.. note::
|
||||
|
||||
Never run ``rocDecode-setup.py`` with ``--runtime OFF``.
|
||||
|
||||
``--developer ON`` is required to use the code samples.
|
||||
|
||||
Build and install rocDecode using the following commands:
|
||||
|
||||
.. code:: shell
|
||||
|
||||
git clone https://github.com/ROCm/rocDecode.git
|
||||
cd rocDecode
|
||||
mkdir build && cd build
|
||||
cmake ../
|
||||
make -j8
|
||||
sudo make install
|
||||
|
||||
After installation, the rocDecode libraries will be copied to ``/opt/rocm/lib`` and the rocDecode header files will be copied to ``/opt/rocm/include/rocdecode``.
|
||||
|
||||
Build and install the rocDecode test module. This module is required if you'll be using the rocDecode samples, and can only be installed if ``rocDecode-setup.py`` was run with ``--developer ON``.
|
||||
|
||||
.. code:: shell
|
||||
|
||||
mkdir rocdecode-test && cd rocdecode-test
|
||||
cmake /opt/rocm/share/rocdecode/test/
|
||||
ctest -VV
|
||||
|
||||
Run ``make test`` to test your build. To run the test with the verbose option, run ``make test ARGS="-VV"``.
|
||||
|
||||
To create a package installer for rocDecode, run:
|
||||
|
||||
.. code:: shell
|
||||
|
||||
sudo make package
|
||||
|
||||
@@ -0,0 +1,67 @@
|
||||
.. meta::
|
||||
:description: Installing rocDecode with the package installer
|
||||
:keywords: install, rocDecode, AMD, ROCm, basic, development, package
|
||||
|
||||
********************************************************************
|
||||
Installing rocDecode with the package installer
|
||||
********************************************************************
|
||||
|
||||
Three rocDecode packages are available:
|
||||
|
||||
* ``rocdecode``: The rocDecode runtime package. This is the basic rocDecode package. It must always be installed.
|
||||
* ``rocdecode-dev``: The rocDecode development package. This package installs a full suite of libraries, header files, and samples. This package needs to be installed to use the rocDecode samples.
|
||||
* ``rocdecode-test``: A test package that provides a CTest to verify the installation. This package needs to be installed to use the rocDecode samples.
|
||||
|
||||
All the required prerequisites are installed when the package installation method is used.
|
||||
|
||||
|
||||
Basic installation
|
||||
========================================
|
||||
|
||||
Use the following commands to install only the rocDecode runtime package:
|
||||
|
||||
.. tab-set::
|
||||
|
||||
.. tab-item:: Ubuntu
|
||||
|
||||
.. code:: shell
|
||||
|
||||
sudo apt install rocdecode
|
||||
|
||||
.. tab-item:: RHEL
|
||||
|
||||
.. code:: shell
|
||||
|
||||
sudo yum install rocdecode
|
||||
|
||||
.. tab-item:: SLES
|
||||
|
||||
.. code:: shell
|
||||
|
||||
sudo zypper install rocdecode
|
||||
|
||||
|
||||
Complete installation
|
||||
========================================
|
||||
|
||||
Use the following commands to install ``rocdecode``, ``rocdecode-dev``, and ``rocdecode-test``:
|
||||
|
||||
.. tab-set::
|
||||
|
||||
.. tab-item:: Ubuntu
|
||||
|
||||
.. code:: shell
|
||||
|
||||
sudo apt install rocdecode rocdecode-dev rocdecode-test
|
||||
|
||||
.. tab-item:: RHEL
|
||||
|
||||
.. code:: shell
|
||||
|
||||
sudo yum install rocdecode rocdecode-devel rocdecode-test
|
||||
|
||||
.. tab-item:: SLES
|
||||
|
||||
.. code:: shell
|
||||
|
||||
sudo zypper install rocdecode rocdecode-devel rocdecode-test
|
||||
@@ -0,0 +1,37 @@
|
||||
.. meta::
|
||||
:description: rocDecode Installation Prerequisites
|
||||
:keywords: install, rocDecode, AMD, ROCm, prerequisites, dependencies, requirements
|
||||
|
||||
********************************************************************
|
||||
rocDecode prerequisites
|
||||
********************************************************************
|
||||
|
||||
rocDecode requires ROCm 6.1 or later running on `accelerators based on the CDNA architecture <https://rocm.docs.amd.com/projects/install-on-linux/en/latest/reference/system-requirements.html>`_.
|
||||
|
||||
ROCm must be installed using the [AMDGPU installer](https://rocm.docs.amd.com/projects/install-on-linux/en/latest/how-to/amdgpu-install.html) with the ``rocm`` usecase:
|
||||
|
||||
.. code:: shell
|
||||
|
||||
sudo amdgpu-install --usecase=rocm
|
||||
|
||||
rocDecode can be installed on the following Linux environments:
|
||||
|
||||
* Ubuntu 20.04, 22.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 `rocDecode-setup.py <https://github.com/ROCm/rocDecode/blob/develop/rocDecode-setup.py>`_ to install these prerequisites.
|
||||
|
||||
.. note::
|
||||
|
||||
To use the rocDecode samples, the ``rocdecode``, ``rocdecode-dev``, and ``rocdecode-test`` packages need to be installed.
|
||||
|
||||
If you're installing using the rocDecode source code, the ``rocDecode-setup.py`` script must be run with ``--developer`` set to ``ON``.
|
||||
|
||||
* Libva, an implementation for Video Acceleration API (VA-API)
|
||||
* AMD VA Drivers
|
||||
* CMake version 3.5 or later
|
||||
* Clang Version 5.0.1 or later
|
||||
* pkg-config
|
||||
* FFmpeg runtime and headers
|
||||
* libstdc++-12-dev for installations on Ubuntu 22.04
|
||||
Reference in new issue
封鎖使用者