CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
111 lines
3.4 KiB
ReStructuredText
111 lines
3.4 KiB
ReStructuredText
.. meta::
|
|
:description: Install hipFile
|
|
:keywords: hipFile, install, ROCm, build, CMake, GPU I/O, AMD, direct storage
|
|
|
|
.. _hipfile-installation:
|
|
|
|
****************
|
|
Install hipFile
|
|
****************
|
|
|
|
Before you begin, verify that your system is supported. For more information,
|
|
see :doc:`Install AMD ROCm <rocm:install/rocm>`.
|
|
|
|
For source builds, CMake options, and sparse-checkout layout from ``rocm-systems``,
|
|
see :doc:`./build-from-source`. For the Python bindings after the C library is on
|
|
the machine, see :doc:`./python-bindings`.
|
|
|
|
.. _hipfile-install-rocm:
|
|
|
|
Install the ROCm Core SDK
|
|
=========================
|
|
|
|
hipFile ships with the ROCm Core SDK on Linux. For the broadest set of
|
|
components in one step, install the ``amdrocm-core-sdk`` meta package.
|
|
|
|
For instructions, see :doc:`Install AMD ROCm <rocm:install/rocm>`. Use the
|
|
selector panel on that page to match your distribution and hardware.
|
|
|
|
.. _hipfile-install-linux:
|
|
|
|
Install hipFile on Linux
|
|
========================
|
|
|
|
If you want hipFile as a smaller ``amdrocm-*`` group instead of installing the full
|
|
``amdrocm-core-sdk`` stack, install the group that carries the hipFile runtime and
|
|
headers for your ROCm release. Package names follow this pattern:
|
|
|
|
.. code-block:: shell-session
|
|
|
|
amdrocm-<group><-dev/-devel><rocm_version><-llvm_target>
|
|
|
|
Where:
|
|
|
|
* ``<-dev/-devel>`` selects library files and headers. Omit the suffix for
|
|
runtime-only packages.
|
|
|
|
* ``-dev`` applies on Debian-based distributions, including Ubuntu.
|
|
|
|
* ``-devel`` applies on RPM-based distributions, including RHEL and SLES.
|
|
|
|
* ``<rocm_version>`` pins the ROCm Core SDK version. Omit it to track the latest
|
|
release your repository publishes.
|
|
|
|
* ``<-llvm_target>`` starting with ``gfx`` limits the install to one AMD GPU
|
|
architecture. Omit it to pull every supported architecture at higher disk
|
|
cost.
|
|
|
|
1. Complete the :doc:`ROCm installation prerequisites <rocm:install/rocm>` so
|
|
dependencies and GPU access permissions are in place.
|
|
|
|
2. Install the ``amdrocm-*`` group that matches your ROCm version, development
|
|
package needs, and GPU architecture. The exact ``<group>`` string for hipFile
|
|
can change between ROCm releases. Confirm the name in the release notes for
|
|
your target version before you run the package manager.
|
|
|
|
3. Run the install command for your distribution. Replace ``<group>`` with the
|
|
value from step 2.
|
|
|
|
.. tab-set::
|
|
|
|
.. tab-item:: Debian-based distros
|
|
|
|
.. code:: shell
|
|
|
|
sudo apt update
|
|
sudo apt install amdrocm-<group>-dev
|
|
|
|
.. tab-item:: RHEL-based distros
|
|
|
|
.. code:: shell
|
|
|
|
sudo dnf install amdrocm-<group>-devel
|
|
|
|
.. tab-item:: SLES
|
|
|
|
.. code:: shell
|
|
|
|
sudo zypper install amdrocm-<group>-devel
|
|
|
|
|
|
.. note::
|
|
|
|
hipFile has experimental support for NVMeoF and NFSoRDMA on Linux.
|
|
|
|
``amdgpu-dkms`` version 31.40 or later must be installed to use NVMeoF and NFSoRDMA.
|
|
|
|
NFSoRDMA requires ``HIPFILE_UNSUPPORTED_FILE_SYSTEMS=true``.
|
|
|
|
See :doc:`/reference/hipFile-io-backends` for information on file type rules.
|
|
|
|
|
|
.. _hipfile-install-nightly:
|
|
|
|
Install a nightly build
|
|
=======================
|
|
|
|
The `TheRock <https://github.com/ROCm/TheRock>`__ build system publishes nightly
|
|
builds for the ROCm Core SDK and its components. See `Nightly release status
|
|
<https://github.com/ROCm/TheRock#nightly-release-status>`__ for download links and
|
|
support notes.
|