Skip to content

Commit

Permalink
Add Environment variables section to usage.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
kostrykin authored Jul 12, 2024
1 parent 079c876 commit d562d96
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/source/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,19 @@ The pipeline data object ``data`` is a dictionary containing all the intermediat
The ``seg`` object returned by the :py:meth:`~superdsm.render.render_result_over_image` function is an RGB image (represented by a ``numpy.ndarray`` object) which can be visualized directly (e.g., using matplotlib) or saved for later use (e.g., using :py:meth:`~superdsm.io.imwrite`). Use :py:meth:`~superdsm.render.rasterize_labels` to obtain segmentation masks from the pipeline data object.

.. _env_variables:

Environment variables
*********************

``MKL_DEBUG_CPU_TYPE``

To take advantage of the acceleration provided by MKL on AMD CPUs, the environment variable ``MKL_DEBUG_CPU_TYPE=5`` should be set when using an AMD CPU. This usually happens automatically, unless automatic recognition of the CPU vendor fails, in which case a warning is displayed.

``SUPERDSM_INTERMEDIATE_OUTPUT``

Set ``SUPERDSM_INTERMEDIATE_OUTPUT=0`` to mute the intermediate console output.

.. _references:

References
Expand Down

0 comments on commit d562d96

Please sign in to comment.