Media
/
compute-runtime
mirror of https://github.com/intel/compute-runtime.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Documentation refactoring [5/n] 

- Add references to oneAPI Level Zero
- Cleanup OpenCL references
- Fix links
- Expand team information

Change-Id: I73940ee705056e6ecd57bbdee7c4653fed80f968
Signed-off-by: Adam Cetnerowski <adam.cetnerowski@intel.com>
This commit is contained in:
Adam Cetnerowski 2020-03-05 08:15:11 +01:00 committed by sys_ocldev
parent 75f9029cb7
commit 6cd5508a9a
2 changed files with 41 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
FAQ.md
View File

@ -13,14 +13,12 @@ with default / stock configuration (no kernel patches), assuming the underlying
kernel's drm subsystem is 4.7 or higher. Newer platforms will require a kernel version
that provides support for that platform (e.g. Coffee Lake requires kernel 4.14 or higher).
Our default (most frequent) validation config is currently (as of Q4'18) Ubuntu 18.04 LTS.
Note: Neo will not work correctly on legacy kernels with Intel patches (e.g. 4.7.0.intel.r4.0).
Our default (most frequent) validation config is currently Ubuntu 18.04 LTS (as of Q1'20).
### Does NEO support Microsoft Windows?
Our closed-source driver for Windows is using the same codebase. At this time,
we do not support compilation of the OpenCL stack for Windows. It is our long-term
we do not support compilation of the stack for Windows. It is our long-term
intention to offer that option.
### Why is the feature set different in latest Windows driver vs. latest NEO on github?
@ -51,13 +49,6 @@ It is our intention to offer full support ahead of platform's market availabilit
## Who are we?
NEO OpenCL team is part of VTT (Visual Technologies Team).
Historically, our team was responsible for delivery of the closed source OpenCL driver for Windows, Linux, and Android.
The Compute Runtime team is part of VTT (Visual Technologies Team).
Most of the developers are located in Poland (UTC+1 timezone).
### I would like to join your team. How can I apply for a job?
1. Go to: https://jobs.intel.com/ListJobs/All/Search/city/Gdansk/
1. Filter for OpenCL in the job title
1. Browse the descriptions looking for positions mentioning this GitHub repository
Most of our engineers are located in Poland and the United States.

71
README.md
View File

@ -1,27 +1,36 @@
# Intel(R) Graphics Compute Runtime for OpenCL(TM)
# Intel(R) Graphics Compute Runtime for oneAPI Level Zero and OpenCL(TM) Driver
## Introduction
The Intel(R) Graphics Compute Runtime for OpenCL(TM) is an open source project to
converge Intel's development efforts on OpenCL(TM) compute stacks supporting the
GEN graphics hardware architecture.
The Intel(R) Graphics Compute Runtime for oneAPI Level Zero and OpenCL(TM) Driver
is an open source project providing compute API support (Level Zero, OpenCL)
for Intel graphics hardware architectures (HD Graphics, Xe).
Please refer to http://01.org/compute-runtime for additional details regarding Intel's
motivation and intentions wrt OpenCL support in open source.
## What is NEO?
NEO is the shorthand name for Compute Runtime contained within this repository.
It is also a development mindset that we adopted when we first started the
implementation effort for OpenCL.
The project evolved beyond a single API and NEO no longer implies a specific API.
When talking about a specific API, we will mention it by name (e.g. Level Zero, OpenCL).
## License
The Intel(R) Graphics Compute Runtime for OpenCL(TM) is distributed under the MIT License.
The Intel(R) Graphics Compute Runtime for oneAPI Level Zero and OpenCL(TM) Driver
is distributed under the MIT License.
You may obtain a copy of the License at: https://opensource.org/licenses/MIT
## Supported Platforms
* Intel Core Processors with Gen8 graphics devices (formerly Broadwell) - OpenCL 2.1
* Intel Core Processors with Gen9 graphics devices (formerly Skylake, Kaby Lake, Coffee Lake) - OpenCL 2.1
* Intel Atom Processors with Gen9 graphics devices (formerly Apollo Lake, Gemini Lake) - OpenCL 1.2
* Intel Core Processors with Gen11 graphics devices (formerly Ice Lake) - OpenCL 2.1
* Intel Core Processors with Gen12 graphics devices (formerly Tiger Lake) - OpenCL 2.1
|Platform|OpenCL|Level Zero|
|--------|:----:|:--------:|
|Intel Core Processors with Gen8 graphics devices (formerly Broadwell)| 2.1 | - |
|Intel Core Processors with Gen9 graphics devices (formerly Skylake, Kaby Lake, Coffee Lake)| 2.1 | Y |
|Intel Atom Processors with Gen9 graphics devices (formerly Apollo Lake, Gemini Lake)| 1.2 | - |
|Intel Core Processors with Gen11 graphics devices (formerly Ice Lake)| 2.1 | Y |
|Intel Core Processors with Gen12 graphics devices (formerly Tiger Lake)| 2.1 | Y |
## Release cadence
@ -33,10 +42,7 @@ the format yy.ww.bbbb (yy - year, ww - work week, bbbb - incremental build numbe
## Installation Options
To allow NEO accessing GPU device make sure user has permissions to files /dev/dri/renderD*.
Under Ubuntu* or Centos* user must be in video group.
In Fedora* all users by default have access to /dev/dri/renderD* files.
To allow NEO access to GPU device make sure user has permissions to files /dev/dri/renderD*.
### Via system package manager
@ -52,47 +58,44 @@ apt-get install intel-opencl-icd
Procedures for other
[distributions](https://github.com/intel/compute-runtime/blob/master/DISTRIBUTIONS.md).
## Linking applications
When building applications, they should link with ICD loader library (ocl-icd).
Directly linking to the runtime library (igdrcl) is not supported.
### Manual download
.deb packages for Ubuntu are provided along with installation instructions and
Release Notes on the [release page](https://github.com/intel/compute-runtime/releases)
## Linking applications
Directly linking to the runtime library is not supported:
* Level Zero applications should link with [Level Zero loader](https://github.com/oneapi-src/level-zero)
* OpenCL applications should link with [ICD loader library (ocl-icd)](https://github.com/OCL-dev/ocl-icd)
## Dependencies
* GmmLib - https://github.com/intel/gmmlib
* Intel Graphics Compiler - https://github.com/intel/intel-graphics-compiler
## Optional dependencies
To enable
[cl_intel_va_api_media_sharing](https://www.khronos.org/registry/OpenCL/extensions/intel/cl_intel_va_api_media_sharing.txt)
extension, the following packages are required:
* libdrm - https://anongit.freedesktop.org/git/mesa/drm.git
* libva - https://github.com/intel/libva.git
## How to provide feedback
By default, please submit an issue using native github.com [interface](https://github.com/intel/compute-runtime/issues).
## How to contribute
Create a pull request on github.com with your patch. Make sure your change is cleanly building and passing ULTs.
A maintainer will contact you if there are questions or concerns.
Create a pull request on github.com with your patch. Make sure your change is cleanly building
and passing ULTs. A maintainer will contact you if there are questions or concerns.
See
[contribution guidelines](https://github.com/intel/compute-runtime/blob/master/documentation/CONTRIBUTING.md)
[contribution guidelines](https://github.com/intel/compute-runtime/blob/master/CONTRIBUTING.md)
for more details.
## See also
* [Contribution guidelines](https://github.com/intel/compute-runtime/blob/master/documentation/CONTRIBUTING.md)
* [Contribution guidelines](https://github.com/intel/compute-runtime/blob/master/CONTRIBUTING.md)
* [Frequently Asked Questions](https://github.com/intel/compute-runtime/blob/master/FAQ.md)
### Level Zero specific
* [oneAPI Level Zero specification](https://spec.oneapi.com/versions/latest/elements/l0/source/index.html)
* [Intel(R) OneApi Level Zero Specification API C/C++ header files](https://github.com/oneapi-src/level-zero/)
* [oneAPI Level Zero tests](https://github.com/oneapi-src/level-zero-tests/)
### OpenCL specific
* [OpenCL on Linux guide](https://github.com/bashbaug/OpenCLPapers/blob/markdown/OpenCLOnLinux.md)