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
69 lines
2.2 KiB
ReStructuredText
69 lines
2.2 KiB
ReStructuredText
.. meta::
|
|
:description: hipSPARSELt environment variables reference
|
|
:keywords: hipSPARSELt, ROCm, API, environment variables, environment, reference
|
|
|
|
.. _env-variables:
|
|
|
|
******************************************
|
|
Environment variables
|
|
******************************************
|
|
|
|
This section describes the important hipSPARSELt environment variables,
|
|
which are grouped by functionality.
|
|
|
|
Logging and debugging
|
|
=====================
|
|
|
|
The logging and debugging environment variables for hipSPARSELt are collected in the following table.
|
|
|
|
.. list-table::
|
|
:header-rows: 1
|
|
:widths: 70,30
|
|
|
|
* - **Environment variable**
|
|
- **Value**
|
|
|
|
* - | ``HIPSPARSELT_LOG_LEVEL``
|
|
| Controls the verbosity level of logging output.
|
|
- | ``0``: Off - logging is disabled (default)
|
|
| ``1``: Error - only errors will be logged
|
|
| ``2``: Trace - API calls that launch HIP kernels will log parameters
|
|
| ``3``: Hints - suggestions that can potentially improve performance
|
|
| ``4``: Info - general information about library execution
|
|
| ``5``: API Trace - API calls will log parameters and information
|
|
|
|
* - | ``HIPSPARSELT_LOG_MASK``
|
|
| Controls which types of messages are logged using bitmask values.
|
|
- | ``0``: Off
|
|
| ``1``: Error
|
|
| ``2``: Trace
|
|
| ``4``: Hints
|
|
| ``8``: Info
|
|
| ``16``: API Trace
|
|
| Values can be combined by adding multiple values together
|
|
|
|
* - | ``HIPSPARSELT_LOG_FILE``
|
|
| Specifies the file path for logging output.
|
|
- | String path to log file
|
|
| File name can contain ``%i``, which is replaced with the process ID
|
|
| If not defined, log messages are printed to stdout
|
|
|
|
Performance monitoring
|
|
======================
|
|
|
|
The performance monitoring environment variables for hipSPARSELt are collected in the following table.
|
|
|
|
.. list-table::
|
|
:header-rows: 1
|
|
:widths: 35,14,51
|
|
|
|
* - **Environment variable**
|
|
- **Default value**
|
|
- **Value**
|
|
|
|
* - | ``HIPSPARSELT_ENABLE_MARKER``
|
|
| Enables ROCTracer logging for performance analysis.
|
|
- ``0``
|
|
- | ``0``: Disable ROCTracer logging
|
|
| ``1``: Enable ROCTracer logging
|