Files
TheRock/rocm-libraries/projects/hipsparselt/docs/conceptual/storage-format.rst
T
derek.holloway 7502bf64a4
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
Flatten subprojects into a single base monorepo
2026-09-02 16:34:47 -07:00

49 lines
1.6 KiB
ReStructuredText

.. meta::
:description: hipSPARSELt storage formats
:keywords: hipSPARSELt, ROCm, API library, API reference, storage formats
.. _storage-format:
********************************
hipSPARSELt storage format
********************************
hipSPARSELt uses a structured sparsity storage format, which is represented by an
:math:`m \times n` matrix, where:
* **m** = number of rows (integer)
* **n** = number of columns (integer)
* **sparsity** = 50%, the ratio of ``nnz`` elements in every 2:1 (int) or 4:2 (others) element along the row
(4:2 means every 4 continuous elements only has 2 ``nnz`` elements)
* **compressed matrix** = matrix of ``nnz`` elements containing data
* **metadata** = matrix of ``nnz`` elements containing the element indices in every 4:2 or 2:1 array
along the row (the contents or structure of the metadata is dependent on the chosen solution by the backend
implementation)
Consider the following :math:`4 \times 4` matrix and the structured sparsity structures using
:math:`m = 4, n = 4`:
.. math::
A = \begin{pmatrix}
1.0 & 2.0 & 0.0 & 0.0 \\
0.0 & 0.0 & 3.0 & 4.0 \\
0.0 & 6.0 & 7.0 & 0.0 \\
0.0 & 6.0 & 0.0 & 8.0 \\
\end{pmatrix}
where
.. math::
Compressed A = \begin{pmatrix}
1.0 & 2.0 \\
3.0 & 4.0 \\
6.0 & 7.0 \\
6.0 & 8.0 \\
\end{pmatrix}
metadata = \begin{pmatrix}
0 & 1 \\
2 & 3 \\
1 & 2 \\
1 & 3 \\
\end{pmatrix}