Intel® oneAPI Base Toolkit Release Notes

Intel® oneAPI Base Toolkit supports direct programming and API programming, and delivers a unified language and libraries that offer full native code support across a range of hardware including Intel® and compatible processors, Intel® Processor Graphics Gen9, Gen11, Intel® Iris® Xe MAX graphics, and Intel® Arria® 10 or Intel® Stratix® 10 SX FPGAs. It offers direct programming model as well as API-based programming model, and it also contains analysis & debug tools for development and performance tuning.

Major Features Supported

Please visit Intel® oneAPI Toolkit and Component Versioning Schema for semantic versioning schema detail. 

New in 2021.3 Product Release

Key Features at toolkit level

• Support for the 3rd Gen Intel® Xeon® Scalable processors (code name Ice Lake Server).
• New distributions available via Spack, a package manager for HPC, and via Anaconda Cloud distribution's anaconda-defaults channels.
• New C APIs, preview C++ and Python APIs, and samples for the Intel oneAPI Video Processing Library
• Installation option --continue-with-optional-error which was added by mistake in an earlier release is now removed.
• Performance, stability, and security improvements

Intel® oneAPI DPC++/C++ Compiler 2021.3.0

• Enabled support for  SYCL 2020 features sycl::kernel_bundle and reduction(partial support).
• Enabled support for DPC++ extension to allocation static local memory in SYCL kernels
• DPC++ extension Explicit SIMD now supports
  • Coexistence of ESIMD and regular SYCL kernels in the same source
  • Indirect read and write methods in ESIMD class
• Enabled support for OpenMP 5.0/5.1 user defined mapper (declare mapper) and OpenMP 5.1 dispatch variant support.
• Now available via Spack, a package manager for HPC and via Anaconda Cloud distribution's anaconda-defaults channels.

Intel® oneAPI DPC++ Library (oneDPL) 2021.3.0 & 2021.4.0

• Added the range-based versions of the following algorithms: adjacent_find, all_of, any_of, count, copy_if, count_if, equal, move, none_of, remove, remove_copy, remove_copy_if, remove_if, replace, replace_if, rotate_copy, reverse, reverse_copy,  swap_ranges, unique, unique_copy.
• Improved performance of discard_block_engine (including ranlux24, ranlux48, ranlux24_vec, ranlux48_vec predefined engines) and normal_distribution.

Intel® DPC++ Compatibility Tool 2021.3.0

• Enabled support for CUDA 11.2 and 11.3 header files
• More API migration coverage:
  • More migration coverage of CUDA Driver API
  • Partial migration of CUDA memory fence API
  • More migration coverage for Thrust and cuRand
  • Improved the migration of API, types, and macros to cover more scenarios
• Reduced the time of the migration: 28%-49% improvement

Intel® oneAPI Math Kernel Library (oneMKL) 2021.3.0

• New performance optimizations
• Added GPU support for additional RNG algorithms
• Introduced CMake config file support
• Enabled DPC++ dynamic libraries support for all DPC++ enabled functionality on Windows* 
• Added debug versions of mkl_sycl and mkl_tbb_thread  libraries on Windows*
• Now available via Spack, a package manager for HPC. 

Intel® oneAPI Threading Building Blocks (oneTBB) 2021.3.0

• More C++20 support which allows now to enforce requirements on argument types to ensure that a developer uses those argument types correctly.
• Preview of the following features:
  • Extended the high-level task API to simplify migration from Intel(R) Threading Building Blocks (TBB) to Intel(r) oneAPI Threading Building Blocks (oneTBB).
  • Added mutex and rw_mutex that are suitable for long critical sections and resistant to high contention.
  • Added ability to customize the concurrent_hash_map mutex type.
  • Added heterogeneous lookup, erase, and insert operations to concurrent_hash_map.

Intel® Distribution for GDB* 2021.3.0

• Enhanced multi-GPU debug capabilities
• Improved application debugging experience in MS Visual Studio* IDE. 
• Added a new sample to demonstrate application debug

Intel® Integrated Performance Primitives (Intel IPP) 2021.3.0

• Image processing and decompression optimizations
• Now available via Spack, a package manager for HPC and via Anaconda Cloud distribution's anaconda-defaults channels.

Intel® oneAPI Collective Communications Library (oneCCL) 2021.3.0

• Added OFI-based multi-NIC support
• Added OFI/psm3 provider support
• Bug fixes

Intel® oneAPI Data Analytics Library (oneDAL) 2021.3.0

• Graphic performance optimizations
• Added support for Intel(R) Extension for Scikit-learn
• Added new SVM regression and classification algorithms
• Now available via Spack, a package manager for HPC. 

Intel® oneAPI Deep Neural Networks Library (oneDNN) 2021.3.0

• Introduced support for DPC++ debug configuration on Windows
• Updated minimal supported CMake version to 2.8.12 (was 2.8.11)
• Performance optimizations
• Extended batch normalization and layer normalization primitives API to take separate scale and shift arguments.
• Extended resampling primitive with post-ops support and mixed source and destination data types..
• Now available via Spack, a package manager for HPC. 

Intel® oneAPI Video Processing Library (oneVPL) 2021.3.0

• C API implementation of oneVPL API 2.4
• OpenVINO Interop Samples for Linux
• C++ API and Samples (Preview)
• Python API and Samples (Preview)
• Samples demonstrating basic oneVPL, core API, and interop
• Added logging capability to Dispatcher
• Now available via Spack, a package manager for HPC. 

Intel® Distribution for Python* 2021.3.0

• Python 3.8 is now supported
• Updated Numba to version 0.53
• numba-dppy now supports native floating point atomics
• Patches & security updates
• Documentation updates

Intel® Advisor 2021.3.0

• Get actionable recommendations to maximize GPU utilizations using Offload Advisor Guidance. 
• Improved GPU Roofline Analysis: Gain insights into memory bound codes to remove memory subsystems bottlenecks. Get instance breakdown of each kernel to compare performance characteristics of different workloads. 
• Technical Preview Feature: Estimate performance benefits of a future GPU for existing GPU code with Offload Advisor GPU-to-GPU performance modeling.

Intel® VTune™ Profiler 2021.5.0

• Optimize GPU offload schema with improved data transfer analysis between CPU and GPU. Boost hottest compute kernels performance via automatic detection of reasons limiting the peak achievable GPU occupancy.
• Analyze workloads at scale to identify outliers using Intel® VTune™ Profiler's Application Performance Snapshot. 
• Easily identify vectorization issues using enriched Performance Snapshot and HPC Performance Characterization

Intel® FPGA Add-On for oneAPI Base Toolkit 2021.3.0 (Optional)

• Added support for Intel® custom platforms with Intel® Quartus® Prime software version 21.1.

New in 2021.2 Product Release

New in 2021.1 Product Release

System Requirements

Please see Intel oneAPI Base Toolkit System Requirements

Installation Instructions

Please visit Installation Guide for Intel oneAPI Toolkits

How to Start Using the Tools

Please reference:

• Get Started with the Intel® oneAPI Toolkits for Linux*
• Get Started with the Intel® oneAPI Toolkits for Windows*

Known Issues, Limitations and Workarounds

1. Known Issue - For users of 2021.2 version of the Intel® AI Analytics Toolkit who wish to install the Intel® oneapi Base Toolkit 2021.3 be aware of a known issue: If you have AI Toolkit 2021.2 installed and do not have the Base Toolkit 2021.2 installed, when you try to install Base Toolkit 2021.3 it will fail - the installation of Base Toolkit 2021.3 will fail, it will not install.  
   Workaround: To work around this issue: You have AI Toolkit 2021.2 installed. First install the the Intel® oneapi Base Toolkit 2021.2. Once Base Toolkit 2021.2 is installed alongside your AI Toolkit 2021.2, you can now install the Intel® oneapi Base Toolkit 2021.3. This issue will be fixed in a future Update.
2. Please read the whitepaper on Challenges, tips, and known issues when debugging heterogenous programs using DPC++ or OpenMP offload 
3. Limitations
   1. Running any GPU code on a Virtual Machine is not supported at this time.
   2. If you have chosen to download the Get Started Guide to use offline, viewing it in Chrome may cause the text to disappear when the browser window is resized. To fix this problem, resize your browser window again, or use a different browser.
   3. Eclipse* 4.12: the code sample project created by IDE plugin from Makefile will not build. It is a known issue with Eclipse 4.12. Please use Eclipse 4.9, 4.10 or 4.11.

4. Known issue- During the silent seamless installation of the Intel® FPGA Add-on package, no matter which add-on package you select for installation, all Intel® FPGA Add-on packages might get installed on your system.
   As a workaround for this issue, specify the intel.oneapi.lin.fpga.group component in the component list before the desired add-on component. For example:

   components=default:intel.oneapi.lin.fpga.group:intel.oneapi.lin.fpga.custom_platforms.quartus211

    

5. Known issue - Linux repositories serving package managers

   • A bug is discovered in the 2021.1 Gold release Linux packages provided by the Linux repositories serving package managers YUM/DNF, APT, Zypper. You will not be able to use package manager “UPGRADE” process for oneAPI packages. Please read this article: https://software.intel.com/content/www/us/en/develop/articles/yum-dnf-apt-zypper-packages-oneapi-2021-1-gold.html

     The following platform and distributions are not impacted:

     • Does not impact Windows or macOS
     • Does not impact IRC distributions
     • Does not impact containers

6. Known issue for FPGA and GPU regarding libtinfo.so.5 library - clang: error while loading shared libraries: libtinfo.so.5: cannot open shared object file: No such file or directory

   • When compiling for FPGA or GPU, you might see this error. To work around this issue, you must install the required compatibility library by executing one of the following OS-specific commands:

     • On Ubuntu 20.04: sudo apt install -y libncurses5 libncurses5-dev libncursesw5-dev

     • On RHEL/CentOS 8: sudo yum install ncurses-compat-libs

     • On SUSE 15: sudo zypper install libcurses5 ncurses5-devel

7. Known issue -  regarding namespace "oneapi" conflicting with older compilers - error: reference to 'tbb' is ambiguous

   • This issue is only found with the following compilers:

     1. GNU* gcc 7.x or older
     2. LLVM* Clang 3.7 or older
     3. Intel® C++ Compiler 19.0 or older
     4. Visual Studio 2017 version 15.6 or older 

   • If your code uses the namespace in the following manner and one of the compilers above, you may get the compilation errors like "error: reference to 'tbb' is ambiguous".

     The "using namespace oneapi;" directive in a oneDPL|oneDNN|oneTBB program code may result in compilation errors with the compilers listed above.

     test_tbb.cpp:

     namespace tbb { int bar(); }
     namespace oneapi { namespace tbb = ::tbb; }
     
     using namespace oneapi;
     int zoo0() { return tbb::bar(); }

     Compiling: .

     test_tbb.cpp: In function 'int zoo0()':
     test_tbb.cpp:5:21: error: reference to 'tbb' is ambiguous
     int zoo0() { return tbb::bar(); }

     Workarounds: 

     Instead of the directive "using namespace oneapi;", please use full qualified names or namespace aliases.

     test_tbb_workaround.cpp: 

     namespace tbb { int bar(); }
     namespace oneapi { namespace tbb = ::tbb; }
     
     // using namespace oneapi;
     int zoo0() { return tbb::bar(); }

     Additional Notes: 

     The "using namespace oneapi;" directive is not recommended right now, as it may result in compilation errors when oneMKL| oneDAL| oneCCL is used with other oneAPI libraries. There're two workarounds:

     • Use the full qualified namespace like above
     • Use namespace alias for oneMKL| oneDAL| oneCCL, e.g.

       • namespace one[mkl|dal|ccl] = ::oneapi::[mkl|dal|ccl];
         onemkl::blas::dgemm( … ); | onedal::train(); | onccl::allgathersv();

          

   •  

8. Known issue - the installation error on Windows "LoadLibrary failed with error 126: the specified module could not be found" in certain environment only

   • ​Impacted environment: Windows with AMD graphics card

   • Details: 

     When a Windows system has AMD* graphics cards or AMD Radeon Vega* graphics units, the installer of oneAPI Toolkits may report the error "LoadLibrary failed with error 126: the specified module could not be found". This has been reported and is being investigated. Please use the workaround for this release.

   • Workaround:

     Temporarily  disable the Intel® HD Graphics during the installation of oneAPI Toolkits with the steps below:

     Open the Device Manager > Display Adapters; Right click on the listed display (common is the intel integrated graphics accelerator) and select DISABLE.

9. Known issue - "Debug Error!" from Microsoft Visual C++ Runtime Library
   • ​Impacted environment: Windows, "Debug" build only, mixed use of DPC++ & oneAPI libraries (except oneTBB)
   • Details: This error may occur only when the DPC++ program is built in "Debug" configuration and it uses one of the oneAPI libraries that do not have a dynamic debug libraries, e.g. oneVPL; The oneTBB is not impacted by this issue.
   • The error is similar to the following:

     

   • Workaround:
     • Use "Release" configuration to build the program for now.
10. More limitations on Windows 
    • For users who have Visual Studio* 2017 or 2019 installed, the installation of IDE integrations of oneAPI Base Toolkit is very slow. It may take 30+minutes just for the IDE integrations installation sometimes. Please be extra patient and it will be eventualy installed. 
    • If you encounter a runtime error that "... ... sycl.dll was not found. ... ..." or similar like below

      

      when running your program within Visual Studio, please follow the instructions below to update the project property "Debugging > Environment" in order to run the program:
      • Open the project property "Debugging > Environment" property and click right drop-down & select Edit

        

      • Copy and paste the default PATH environment variable value from lower section to the above section.
        This step is very important because of how Visual Studio 2017 or newer handles the additional directory for the "PATH" environment variable.

        

      • Add any additional directories needed by the program for those dll files to the path like below

        

    • Error when running a code sample program within Visual Studio: unable to start program 'xxx.exe"

      

      
      Please follow the instructions below for the workaround.
      • Open Tools Options dialog, select Debugging tab, and select the check-box of "Automatically close the console when debugging stops". See the dialog image below for details.

        

Deprecation Notices

OS Deprecation Notice

Release Notes for All Tools included in Intel® oneAPI Base Toolkit

• Intel® oneAPI DPC++ Compiler Release Notes
• Intel® DPC++ Compatibility Tool Release Notes
• Intel® oneAPI DPC++ Library Release Notes
• Intel® FPGA Add-On for oneAPI Base Toolkit Release Notes
• Intel® Distribution for GDB* Release Notes
• Intel® oneAPI Math Kernel Library Release Notes
• Intel® oneAPI Threading Building Blocks Library Release Notes
• Intel® Integrated Performance Primitives Release Notes
• Intel® oneAPI Data Analytics Library Release Notes
• Intel® Distribution for Python* Release Notes
• Intel® VTune™ Profiler Release Notes
• Intel® Advisor Release Notes
• Intel® oneAPI Deep Neural Network Library Release Notes
• Intel® oneAPI Collective Communications Library Release Notes
• Intel® oneAPI Video Processing Library Release Notes

Notices and Disclaimers

Intel technologies may require enabled hardware, software or service activation.

No product or component can be absolutely secure.

Your costs and results may vary.

© 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.

No license (express or implied, by estoppel or otherwise) to any intellectual property rights is granted by this document.

The products described may contain design defects or errors known as errata which may cause the product to deviate from published specifications. Current characterized errata are available on request.

Intel disclaims all express and implied warranties, including without limitation, the implied warranties of merchantability, fitness for a particular purpose, and non-infringement, as well as any warranty arising from course of performance, course of dealing, or usage in trade.