oneAPI Samples
The oneAPI-samples repository contains samples for the Intel® oneAPI Toolkits.
The contents of the default branch in this repository are meant to be used with the most recent released version of the Intel® oneAPI Toolkits.
Get the oneAPI Samples
Clone the repository by entering the following command:
git clone https://github.com/oneapi-src/oneAPI-samples.git
Alternatively, you can download a zip file containing the primary branch in repository.
- Click the Code button.
- Select Download ZIP from the menu options.
- After downloading the file, unzip the repository contents.
Get Earlier Versions of the oneAPI Samples
If you need samples for an earlier version of any of the Intel® oneAPI Toolkits, then use a tagged version of the repository that corresponds with the toolkit version.
Clone an earlier version of the repository using Git by entering a command similar to the following:
git clone -b <tag> https://github.com/oneapi-src/oneAPI-samples.git
where <tag> is the GitHub tag corresponding to the toolkit version number, like 2023.0.0.
Alternatively, you can download a zip file containing a specific tagged version of the repository.
- Select the appropriate tag.
- Click the Code button.
- Select Download ZIP from the menu options.
- After downloading the file, unzip the repository contents.
Getting Started with oneAPI Samples
The best oneAPI sample to start with depends on what you are trying to learn or types of problems you are trying to solve.
| If you want to learn about... | Start with... |
|---|---|
| the basics of writing, compiling, and building programs for CPUs, GPUs, or FPGAs | Simple Add or Vector Add samples (You can use these samples as starter projects by removing unwanted elements and adding your code and build requirements.) |
| the basics of using artificial intelligence | Getting Started Samples for Intel® AI Analytics Toolkit (AI Kit) |
| the basics of image rendering workloads and ray tracing | Getting Started Samples for Intel® oneAPI Rendering Toolkit (Render Kit) |
| how to modify or create build files for SYCL-compliant projects | Vector Add sample |
Note: The README.md included with each sample provides build instructions for all supported operating system. For samples run in Jupyter Notebooks, you might need to install or configure additional frameworks or package managers if you do not already have them on your system.
Using Integrated Development Environments (IDE)
If you prefer to use an Integrated Development Environment (IDE) with these samples, you can download Visual Studio Code for use on Windows*, Linux*, and macOS*.
Repository Structure
The oneAPI-sample repository is organized by high-level categories.
Known Issues and Limitations
Windows
- If you are using Microsoft Visual Studio* 2019, you must use Microsoft Visual Studio 2019 version 16.4.0 or newer.
- Windows support for the FPGA code samples is limited to the FPGA emulator and optimization reports. Only Linux supports FPGA hardware compilation. See any FPGA code sample README.md for more details.
- If you encounter
Error MSB6003 The specified task executable ... could not be run...when building a sample program, it might be due to the length of the directory path. Move thebuilddirectory to a location with a shorter path. Build the sample in the new location.
Licenses
Code samples are licensed under the MIT license. See License.txt for details.
Third-party program licenses can be found here: third-party-programs.txt.
Notices and Disclaimers
© Intel Corporation. Intel, the Intel logo, and other Intel marks are trademarks of Intel Corporation or its subsidiaries. Other names and brands may be claimed as the property of others.