Files
TheRock/rocm-libraries/projects/rocblas/docs/reference/env-variables.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

74 lines
3.2 KiB
ReStructuredText

.. meta::
:description: rocBLAS environment variables
:keywords: AMD, rocBLAS, environment variables, environment
.. _env-variables:
********************************************************************
Environment variables
********************************************************************
The rocBLAS environment variables are collected in the following
tables.
.. list-table::
:header-rows: 1
:widths: 30, 15, 20, 35
* - **Environment variable**
- **Default value**
- **Links**
- **Value**
* - | ``ROCBLAS_USE_HIPBLASLT``
| Provides manual control over which GEMM backend is used.
- Unset by default.
- :ref:`Control the GEMM backend <rocblas-tensile-hipblaslt>`
- | **Unset**: GEMM backend is automatically selected.
| **0**: Tensile is always used as the GEMM backend.
| **1**: hipBLASLt is preferred as the GEMM backend, but will fallback to Tensile on problems for which hipBLASLt does not provide a solution or when errors are encountered using the hipBLASLt backend.
* - | ``ROCBLAS_USE_HIPBLASLT_BATCHED``
| Deprecated. Manual control to selectively disable the use of hipBLASLt only for the batched GEMMs. ``ROCBLAS_USE_HIPBLASLT=0`` disables the ``ROCBLAS_USE_HIPBLASLT_BATCHED`` variable, because hipBLASLt would not be enabled. This variable should no longer be required and is planned for removal in a future release.
- 1
- :ref:`Control the GEMM backend <rocblas-tensile-hipblaslt>`
- | **Unset**: GEMM batched default backend.
| **0**: Tensile is always used as the GEMM batched backend.
| **1**: hipBLASLt will be used as the GEMM batched backend when applicable, but will fallback to Tensile on problems for which hipBLASLt does not provide a solution or when errors are encountered using the hipBLASLt backend.
* - | ``ROCBLAS_DEVICE_MEMORY_SIZE``
| Sets how much memory to preallocate.
- Unset by default.
- :ref:`Preallocate memory <memory-alloc>`
- | **0 or unset**: Lets rocBLAS manage the device memory.
| **Bigger than 0**: Sets the default handle device memory size to the specified size (in bytes).
* - | ``ROCBLAS_DEFAULT_ATOMICS_MODE``
| Sets the default atomics mode during the creation of ``rocblas_handle``.
- Unset by default.
- :ref:`Atomic Operations`
- | **0**: Sets the default to :any:`rocblas_atomics_not_allowed`
| **1**: Sets the default to :any:`rocblas_atomics_allowed`
* - | ``ROCBLAS_STREAM_ORDER_ALLOC``
| Allows memory allocation and deallocation to be stream ordered.
- 0
- :ref:`Device memory allocation <memory-alloc>`
- | **0**: Disable
| **1**: Enable
* - | ``ROCBLAS_BENCH_STREAM_SYNC``
| Benchmark timing based on ``hipStreamSynchronize``, otherwise uses default ``hipEvent_t`` based timing.
- 0
- :ref:`rocblas_bench_stream_sync`
- | **0**: Disable
| **1**: Enable
Logging environment variables
--------------------------------------------------------------------------------
The logging environment variables in rocBLAS are collected in the following
table. For information on how to use these variables, see :ref:`logging`.
.. include:: ../data/reference/logging-env.rst