Interpretable AI packages are implemented in the Julia language and provided using a precompiled system image for Julia. This is a file with the extension
.dll for Windows,
.dylib for macOS, or
.so for Linux. There are two ways to install the software on your system:
If you are planning to use the R or Python interfaces to the IAI algorithms, it is possible for these packages to download and configure a Julia installation automatically. For more information, please refer to the relevant installation instructions for either R or Python.
If you would prefer to work directly in Julia, or use R or Python with a manually-managed Julia installation, please follow the instructions below to install Julia and the IAI system image.
In both cases, once the installation is complete, please follow the instructions to obtain a license file.
Please contact us for access to the system image.
Each system image is compatible with a specific operating system and version of Julia, so when downloading, make sure you select the version that matches your environment.
You should install the exact version of Julia corresponding to your system image using the standard installers.
We strongly recommend that you install an official release of Julia, as we cannot guarantee compatibility with self-compiled versions of Julia.
Once installed, you need to configure Julia to use the new system image. There are two options.
Replace the default system image file (
sys.so) with the file you have downloaded. You might also like to rename and keep the original file in case you want to revert to the default system image.
On macOS, replacing the default system image may lead to Julia being unable to start, with an error message stating "Julia.app is damaged". In this case, please restore the original system image and specify the system image at runtime instead.
For a default Julia installation, the system image is located at:
|OS||Default system image location|
If you are unsure about where to find the system image file, you can run the following command in Julia to show the correct location:
Specify the system image file when starting Julia using the
-J/--sysimage flag. For example, the following shell command will start Julia with the modified system image, assuming
julia is on the system
$ julia --sysimage path/to/sys.dylib
If you are using Jupyter, you can run the following code in Julia to create a custom kernel that loads the IAI system image:
julia> using IJulia julia> installkernel("Julia (IAI)", "--sysimage=path/to/sys.dylib")
Once installation is complete, when the IAI modules are launched for the first time, a number of packages will be installed in order to satisfy dependencies. You will then receive a message that there is no license file, along with a machine ID:
Could not find Interpretable AI license file at `~/iai.lic`. If you need to register a license for this machine, please send us the following machine ID: 478b884fa4f8fcd73a102ccffe3d347276f51cdf94d32b079226a8f9edb204c3
You can also get the machine ID directly with one of the following functions (depending on the language being used):
Please send us this machine ID so that we can create a license file for your machine. You will need to place this file in your home folder (which you can find by running
homedir() inside Julia) with the name
iai.lic. By default, the path to the license file should be:
|OS||Default license file location|
Alternatively, you can set the environment variable
IAI_LICENSE_FILE to point to the location of your license file if you would like to place it elsewhere.
When working with the system image in Julia, you can use Julia as you would normally, with the exception that the Interpretable AI modules are already loaded into the Julia session.
There is no need to run
using IAI - the IAI package is already loaded in every session.
You can find the version of the system image by running
On newer versions of macOS, you may receive a warning when you try to start Julia with the new system image:
"sys.dylib" cannot be opened because the developer cannot be verified
To fix this, go to the "General" tab under "Security & Privacy" in "System Preferences", and click "Allow Anyway".
Return the machine ID for the current computer.