Download Samples using the oneAPI CLI Samples Browser

Use the oneAPI CLI Samples Browser to explore the collection of online oneAPI samples. The oneAPI CLI utility is a single-file, stand-alone executable that has no dependencies on dynamic runtime libraries. You can copy samples to your local disk as buildable sample projects. The build instructions are included as part of the sample in a README file. Most oneAPI sample projects are built using Make or CMake.

For a list of components that support CMake, see Use CMake with oneAPI Applications.

An internet connection is required to download samples. To use this toolkit offline, see Developing with Offline Systems in the Troubleshooting section.

The oneAPI CLI Samples Browser does not work with system proxy settings and does not support WPAD proxy. If you have trouble connecting from behind a proxy, see Troubleshooting.

Watch a video walkthrough of creating a sample project: Exploring Intel® oneAPI Samples from the Command Line.

To download and set up a sample:

1. Create a folder where you want to store your sample. For example, C:\samples\vector-add
2. Open a command window.
3. Set system variables by running setvars:

   Component Directory Layout:

   "C:\Program Files (x86)\Intel\oneAPI\setvars.bat"

   NOTE:

   For Windows PowerShell*, execute this command:

   cmd.exe "/K" '"C:\Program Files (x86)\Intel\oneAPI\setvars.bat" && powershell'

   Unified Directory Layout:

   "C:\Program Files (x86)\Intel\oneAPI\<toolkit-version>\oneapi-vars.bat"

   NOTE:

   For Windows PowerShell*, execute this command:

   cmd.exe "/K" '"C:\Program Files (x86)\Intel\oneAPI\<toolkit-version>\oneapi-vars.bat" && powershell'

   The command above assumes you used the default install location. If you customized the installation folder, adjust the path to setvars | oneapi-vars accordingly.
   NOTE:

   You can manage setvars.bat script to specify exact version of the toolkit, libraries or the compiler, rather than defaulting to the latest version. For advanced setup options, see Using a Configuration File to Manage Setvars.bat,oneAPI Development Environment Setup.

4. In the same command window, run the application :

   oneapi-cli.exe

   The oneAPI CLI menu appears:

   

5. Use the up and down arrow keys to select Create a project, then press Enter
6. The language selection will appear. If you want to run samples from a toolkit other than the Intel® oneAPI Base Toolkit make sure those toolkits are installed.

   

7. Select the language for your sample. For your first project, select cpp, then press Enter. The toolkit samples list appears.
8. Select the Vector Add sample.Vector Add is a simple test application that will help verify that the tools are setup correctly and can access your system's GPU:

   

9. After you select a sample, press Enter.

10. Specify the location for the project. The default location includes the path from where the CLI Browser was run and the name of the project.

11. Press Tab to select Create, then press Enter:

    

See Explore SYCL* Through Samples to learn more.

Build and Run a CPU or GPU Sample Using Microsoft Build*

1. Using the same command prompt window where you ran setvars.bat, navigate to the folder where you downloaded the sample.
2. Configure the project to use the buffer-based implementation (first box) or the Unified Shared Memory (USM) based implementation (second box). Read more about these memory management techniques in the Vector Add description.

   mkdir build
   cd build
   cmake -G "NMake Makefiles" ..

   mkdir build
   cd build
   cmake -G "NMake Makefiles" .. -DUSM=1

3. Build the program.

   nmake cpu-gpu

   NOTE:

   Some samples require additional steps or arguments for building and/or running the sample. Review the sample's README.md file for specific details.

4. Navigate to the output directory (example: x64/Release)
5. Run the program using one of the following commands:

   vector-add-buffers.exe

   vector-add-usm.exe

A success message will appear:

If Running on Device shows a GPU and an error occurs, see the Troubleshooting tip for fixing a SPIRV Error.

Optional: Clean the program.

nmake clean

Compile and run a sample for FPGA

You can run the vector-add sample (or any FPGA SYCL* code) in the following modes:

• Emulation: Verifies the code correctness. Compilation completes in few seconds. Use this mode if you are using the Intel® oneAPI Base Toolkit.
• Report: Generates a static optimization report for design analysis. Compilation can take a few minutes to complete. When completed, you can find the reports in <project_name>.prj\reports\report.html. This can be used with the Intel® oneAPI Base Toolkit. For more information about the reports, refer to the FPGA Optimization Guide for Intel® oneAPI Toolkits.
• Hardware: Generates the actual bitstream on an FPGA device. Compilation can take few hours to complete. Use this mode to measure performance. To use this mode, download the Intel® Quartus® Prime Pro Edition software and third-party vendor-provided BSPs separately. For more information, refer to the Intel® FPGA Add-On for oneAPI Base Toolkit web page.

1. Using the same command prompt window where you ran setvars.bat, navigate to the folder where you downloaded the sample.

   cd <vector-add directory on the same system>

2. View the README.md file in the sample folder for instructions on how to build and run the sample.

See Explore SYCL* Through Samples to learn more.