Get Started

  • 2021.2
  • 05/24/2021
  • Public Content

Configure Your System

Intel® oneAPI AI Analytics Toolkit

Install the
Intel® oneAPI AI Analytics Toolkit

If you have not already installed the AI Analytics Toolkit, refer to Installing Intel® oneAPI Toolkits via Linux* Package Managers.
To get the Intel® Distribution of Modin*, you must install the AI Kit using the Conda* package manager.
To set up your system, you must:

Set Environment Variables for CLI Development

For working at a Command Line Interface (CLI), the tools in the oneAPI toolkits are configured via environment variables. Set up your CLI environment by
sourcing
the
setvars
script:
Option 1: Source setvars.sh once per session
Source
setvars.sh
every time you open a new terminal window:
You can find the
setvars.sh
script in the root folder of your oneAPI installation, which is typically
/opt/intel/oneapi/
for sudo or root users and
~/intel/oneapi/
when installed as a normal user.
For root or sudo installations:
. /opt/intel/oneapi/setvars.sh
For normal user installations:
. ~/intel/oneapi/setvars.sh
Option 2: One time setup for setvars.sh
To have the environment automatically set up for your projects, include the command
source <install_dir>/setvars.sh
in a startup script where it will be invoked automatically (replace
<install_dir>
with the path to your oneAPI install location). The default installation locations are
/opt/intel/oneapi/
for sudo or root users and
~/intel/oneapi/
when installed as a normal user.
For example, you can add the
source <install_dir>/setvars.sh
command to your
~/.bashrc
or
~/.bashrc_profile
or
~/.profile
file. To make the settings permanent for all accounts on your system, create a one-line
.sh
script in your system's
/etc/profile.d
folder that sources
setvars.sh
(for more details, see Ubuntu documentation on Environment Variables).
The
setvars.sh
script can be managed using a configuration file, which is especially helpful if you need to initialize specific versions of libraries or the compiler, rather than defaulting to the "latest" version. For more details, see Using a Configuration File to Manage Setvars.sh..
If you need to setup the environment in a non-POSIX shell, see
oneAPI Development Environment Setup for more configuration options.

Use the Conda Clone Function to Add Packages as a Non-Root User

The Intel oneAPI AI Analytics toolkit is installed in the
inteloneapi
folder, which requires root privileges to manage. You may wish to add and maintain new packages using Conda*, but you cannot do so without root access. Or, you may have root access but do not want to enter the root password every time you activate Conda.
To manage your environment without using root access, utilize the Conda clone functionality to clone the packages you need to a folder outside of the
inteloneapi
folder:
  1. From the same terminal window where you ran
    setvars.sh
    , identify the Conda environments on your system:
    conda env list
    You will see results similar to this:
  2. Use the clone function to clone the environment to a new folder. In the example below, the new environment is named
    usr_intelpython
    and the environment being cloned is named
    base
    (as shown in the image above).
    conda create --name usr_intelpython --clone base
    The clone details will appear:
    If the command does not execute, you may not have access to the
    ~/.conda
    folder. To fix this, delete the
    .conda
    folder and execute this command again:
    conda create --name usr_intelpython --clone base
    .
  3. Activate the new environment to enable the ability to add packages.
    conda activate usr_intelpython
  4. Verify the new environment is active.
    conda env list

For GPU Users, Install GPU Drivers

If you followed the instructions in the Installation Guide to install GPU Drivers, you may skip this step. If you have not installed the drivers, follow the directions in the Installation Guide.

GPU: Disable Hangcheck

This section applies only to applications with long-running GPU compute workloads in native environments. It is not recommended for virtualizations or other standard usages of GPU, such as gaming.
A workload that takes more than four seconds for GPU hardware to execute is a long running workload. By default, individual threads that qualify as long-running workloads are considered hung and are terminated. By disabling the hangcheck timeout period, you can avoid this problem.
If the system is rebooted, hangcheck is automatically enabled. You must disable hangcheck again after every reboot or follow the directions to disable hangcheck persistently (across multiple reboots).
To disable hangcheck until the next reboot:
sudo sh -c "echo N> /sys/module/i915/parameters/enable_hangcheck"
To disable hangcheck across multiple reboots:
If the kernel is updated, hangcheck is automatically enabled. Run the procedure below after every kernel update to ensure hangcheck is disabled.
  1. Open a terminal.
  2. Open the
    grub
    file in
    /etc/default
    .
  3. In the grub file, find the line
    GRUB_CMDLINE_LINUX_DEFAULT=""
    .
  4. Enter this text between the quotes (""):
    i915.enable_hangcheck=0
  5. Run this command:
    sudo update-grub
  6. Reboot the system. Hangcheck remains disabled.

GPU: Add User to Video Group

For GPU compute workloads, non-root (normal) users do not typically have access to the GPU device. Make sure to add your normal user(s) to the
video
group; otherwise, binaries compiled for the GPU device will fail when executed by a normal user. To fix this problem, add the non-root user to the
video
group:
sudo usermod -a -G video <username>

Next Step

Now that you have configured your system, proceed to Build a Project Using the Command Line.

Product and Performance Information

1

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.