Skip to content

Commit 69af853

Browse files
authored
docs: add backend naming template (#138)
1 parent 8193364 commit 69af853

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/create_new_backend.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,16 @@ This step-by-step tutorial provides examples for enabling new third-party librar
1010

1111
oneMKL has a header-based implementation of the interface layer (``include`` directory) and a source-based implementation of the backend layer for each third-party library (``src`` directory). To enable a third-party library, you must update both parts of oneMKL and integrate the new third-party library to the oneMKL build and test systems.
1212

13+
For the new backend library and header naming please use the following template:
14+
15+
.. code-block::
16+
17+
onemkl_<domain>_<3rd-party library short name>[<wrapper for specific target>]
18+
19+
Where ``<wrapper for specific target>`` is required only if multiple wrappers are provided from the same 3rd-party library, e.g., wrappers with Intel oneMKL C API for CPU target ``onemkl_blas_mklcpu.so`` and wrappers with Intel oneMKL DPC++ API for GPU target ``onemkl_blas_mklgpu.so``.
20+
21+
If there is no need for multiple wrappers only ``<domain>`` and ``<3rd-party library short name>`` are required, e.g. ``onemkl_rng_curand.so``
22+
1323
`1. Create Header Files`_
1424

1525
`2. Integrate Header Files`_

0 commit comments

Comments
 (0)