Skip to content

Commit

Permalink
Correct display of superscripts
Browse files Browse the repository at this point in the history
Two superscripts were missing a backslash-escaped whitespace (see https://documatt.com/restructuredtext-reference/element/superscript.html) to be correctly displayed. Add a newline between the blocks explaining the superscripts for readability.
  • Loading branch information
rb214678 authored Jun 18, 2024
1 parent e00d86d commit 91728ec
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/source/ProgrammingGuide/Initialization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Kokkos chooses the two spaces using the following list:
8. `Kokkos::Threads`
9. `Kokkos::Serial`

The highest execution space in the list that is enabled is Kokkos' default execution space, and the highest enabled host execution space is Kokkos' default host execution space. For example, if `Kokkos::Cuda`, `Kokkos::OpenMP`, and `Kokkos::Serial` are enabled, then `Kokkos::Cuda` is the default execution space and `Kokkos::OpenMP` is the default host execution space.:sup:`1` In cases where the highest enabled backend is a host parallel execution space the `DefaultExecutionSpace` and the `DefaultHostExecutionSpace` will be the same.
The highest execution space in the list that is enabled is Kokkos' default execution space, and the highest enabled host execution space is Kokkos' default host execution space. For example, if `Kokkos::Cuda`, `Kokkos::OpenMP`, and `Kokkos::Serial` are enabled, then `Kokkos::Cuda` is the default execution space and `Kokkos::OpenMP` is the default host execution space\ :sup:`1`. In cases where the highest enabled backend is a host parallel execution space the `DefaultExecutionSpace` and the `DefaultHostExecutionSpace` will be the same.

`Kokkos::initialize <../API/Initialize-and-Finalize.html#kokos-initialize>`_ parses the command line for flags prefixed with `--kokkos-`, and removes all recognized flags. Argument options are given with an equals (`=`) sign. If the same argument occurs more than once, the last one is used. For example, the arguments

Expand All @@ -76,7 +76,7 @@ Table 5.1: Command-line options for Kokkos::initialize
* - --kokkos-device-id=INT
- specify device id to be used by Kokkos
* - --kokkos-map-device-id-by=(random\|mpi_rank), default: mpi_rank
- strategy to select device-id automatically from available devices: random or mpi_rank:sup:`2`
- strategy to select device-id automatically from available devices: random or mpi_rank\ :sup:`2`
* - --kokkos-tools-libs=STR
- specify which of the tools to use. Must either be full path to library or name of library if the path is present in the runtime library search path (e.g. LD_LIBRARY_PATH)
* - --kokkos-tools-help
Expand All @@ -92,6 +92,7 @@ The values are case insensitive.


:sup:`1` This is the preferred set of defaults when CUDA and OpenMP are enabled. If you use a thread-parallel host execution space, we prefer Kokkos' OpenMP backend, as this ensures compatibility of Kokkos' threads with the application's direct use of OpenMP threads. Kokkos cannot promise that its Threads backend will not conflict with the application's direct use of operating system threads.

:sup:`2` The two device-id mapping strategies are:
- random: select a random device from available.
- mpi_rank: select device based on a round robin assignment of local MPI ranks. Works with OpenMPI, MVAPICH, SLURM, and derived implementations. Support for MPICH was added in Kokkos 4.0
Expand Down

0 comments on commit 91728ec

Please sign in to comment.