From 56f735d14978a16031e21112f5c2b8c12868e7c5 Mon Sep 17 00:00:00 2001 From: etotmeni Date: Mon, 14 Dec 2020 08:01:27 -0600 Subject: [PATCH 1/3] Added docs --- README.md | 4 ++++ docs/INDEX.md | 18 ++++++++++++++++++ 2 files changed, 22 insertions(+) create mode 100644 docs/INDEX.md diff --git a/README.md b/README.md index 483ad7bdad..725f39f179 100644 --- a/README.md +++ b/README.md @@ -67,3 +67,7 @@ Please follow instructions in the [DEBUGGING.md](DEBUGGING.md) ## Reporting issues Please use https://github.com/IntelPython/numba-dppy/issues to report issues and bugs. + +## Features + +Read this guide for additional features [INDEX.md](INDEX.md) diff --git a/docs/INDEX.md b/docs/INDEX.md new file mode 100644 index 0000000000..763d1ebf3c --- /dev/null +++ b/docs/INDEX.md @@ -0,0 +1,18 @@ +# numba-dppy + +Below is the functionality that is implemented in numba-dppy. You can follow the detailed descriptions of some of the features. + +## Offload Diagnostics + +Setting the debug environment variable `NUMBA_DPPY_OFFLOAD_DIAGNOSTICS ` +(e.g. `export NUMBA_DPPY_OFFLOAD_DIAGNOSTICS=1`) enables the parallel and offload diagnostics information. + +If set to an integer value between 1 and 4 (inclusive) diagnostic information about parallel transforms undertaken by Numba will be written to STDOUT. The higher the value set the more detailed the information produced. +In the "Auto-offloading" section there is the information on which device (device name) this parfor or kernel was offloaded. + +## Controllable Fallback + +With the default behavior of numba-dppy, if a section of code cannot be offloaded on the GPU, then it is automatically executed on the CPU and printed a warning. + +Setting the debug environment variable `NUMBA_DPPY_FALLBACK_OPTION ` +(e.g. `export NUMBA_DPPY_FALLBACK_OPTION=0`) enables the code is not automatically offload to the CPU, and an error occurs. This is necessary in order to understand at an early stage which parts of the code do not work on the GPU, and not to wait for the program to execute on the CPU if you don't need it. From 80f705bdf2e47781476a5568179545c263087f86 Mon Sep 17 00:00:00 2001 From: etotmeni Date: Tue, 15 Dec 2020 03:36:21 -0600 Subject: [PATCH 2/3] Added note --- docs/INDEX.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/INDEX.md b/docs/INDEX.md index 763d1ebf3c..87e2d9c45f 100644 --- a/docs/INDEX.md +++ b/docs/INDEX.md @@ -16,3 +16,5 @@ With the default behavior of numba-dppy, if a section of code cannot be offloade Setting the debug environment variable `NUMBA_DPPY_FALLBACK_OPTION ` (e.g. `export NUMBA_DPPY_FALLBACK_OPTION=0`) enables the code is not automatically offload to the CPU, and an error occurs. This is necessary in order to understand at an early stage which parts of the code do not work on the GPU, and not to wait for the program to execute on the CPU if you don't need it. + +This behavior only applies to njit functions and auto-offloading of numpy functions, array expressions, and prange loops. From 2d1923987de99603e6bdead3bbeb500d6d9f3b9a Mon Sep 17 00:00:00 2001 From: etotmeni Date: Wed, 16 Dec 2020 12:50:12 -0600 Subject: [PATCH 3/3] Small fixes --- README.md | 2 +- docs/INDEX.md | 4 +--- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 725f39f179..8d314a179f 100644 --- a/README.md +++ b/README.md @@ -70,4 +70,4 @@ Please use https://github.com/IntelPython/numba-dppy/issues to report issues and ## Features -Read this guide for additional features [INDEX.md](INDEX.md) +Read this guide for additional features [INDEX.md](docs/INDEX.md) diff --git a/docs/INDEX.md b/docs/INDEX.md index 87e2d9c45f..2c8b990c6c 100644 --- a/docs/INDEX.md +++ b/docs/INDEX.md @@ -12,9 +12,7 @@ In the "Auto-offloading" section there is the information on which device (devic ## Controllable Fallback -With the default behavior of numba-dppy, if a section of code cannot be offloaded on the GPU, then it is automatically executed on the CPU and printed a warning. +With the default behavior of numba-dppy, if a section of code cannot be offloaded on the GPU, then it is automatically executed on the CPU and printed a warning. This behavior only applies to njit functions and auto-offloading of numpy functions, array expressions, and prange loops. Setting the debug environment variable `NUMBA_DPPY_FALLBACK_OPTION ` (e.g. `export NUMBA_DPPY_FALLBACK_OPTION=0`) enables the code is not automatically offload to the CPU, and an error occurs. This is necessary in order to understand at an early stage which parts of the code do not work on the GPU, and not to wait for the program to execute on the CPU if you don't need it. - -This behavior only applies to njit functions and auto-offloading of numpy functions, array expressions, and prange loops.