Documentation refactoring [1/n]

- rename contribution to match Github expectations
- move double-precision information to FAQ
- move release cadence to README
- move quality expectations fo contribution guide
- cleanup README
- fix links

Change-Id: Iba9c5e2d57ea5264fd6cc2abb86ee6a98a074840
Signed-off-by: Adam Cetnerowski <adam.cetnerowski@intel.com>
This commit is contained in:
Adam Cetnerowski
2020-02-27 12:00:57 +01:00
committed by sys_ocldev
parent a799358ac7
commit 55ab09e618
4 changed files with 57 additions and 69 deletions

29
FAQ.md
View File

@@ -139,6 +139,35 @@ https://www.iwocl.org/wp-content/uploads/iwocl-2019-michal-mrozek-intel-breaking
1. Blocking command queue with user events blocks all further submissions until event is unblocked.
1. Commands blocked by user events, when unblocked are serialized as well.
## Feature: Double-precision emulation (FP64)
By default NEO driver enables double precision operations only on platforms with supporting hardware. This is signified by exposing the "cl_khr_fp64" extension in the extension string. For other platforms, this support can be emulated by the compiler (IGC).
### How do I enable emulation?
FP64 emulation can only be enabled on Linux. There are two settings that have to be set.
#### Runtime setting:
There are two ways you can enable this feature in NEO:
* Set an environment variable **OverrideDefaultFP64Settings** to **1**:
`OverrideDefaultFP64Settings=1`
* In **igdrcl.config** configuration file in the same directory as application binary (you may have to create this file) add a line as such:
`OverrideDefaultFP64Settings = 1`
#### Compiler setting:
IGC reads flags only from environment, so set **IGC_EnableDPEmulation** to **1** as such:
`IGC_EnableDPEmulation=1`
After both settings have been set you can run the application normally.
### Known issues and limitations
Intel does not claim full specification conformance when using emulated mode. We reserve the right to not fix issues that appear only in emulation mode. Performance degradation is to be expected and has not been measured by Intel.
## Who are we?
NEO OpenCL team is part of VTT (Visual Technologies Team).