Installation

• Prerequisites
• Installing from public pypy repository (preferred method)
• Installing from github release
• Installing from source code

Prerequisites

• We support only native Linux (x86_64) or MacOS (x86_64) / (Arm64).

  Windows users can easily install Microsoft's excellent Windows Subsystem for Linux 2 (WSL2) and work from there since it gives you a native Linux environment that integrates very well with Visual Studio Code.

• If you're using a Mac

  • You need to have the Xcode command line developer tools installed. You can do this by entering xcode-select --install from a terminal session and following the installer's directions from there;

• The SAIL currently requires python >=3.8 and <=3.9. Any python interpreter in this version range should do but we strongly recommend that you use an anonconda/miniconda-based virtual environment. We recommend creating a dedicated virtual environment (e.g,. `conda) to avoid dependency clashes with other python libraries you might use. The SAIL developers currently use this approach so this is the one that has naturally been best tested internally.

Installation

1. Installing from public PyPI repository

pip install "sail[<OPTION>]"

Supported OPTION include:

• tensorflow
• tensorflow_arm64
• pytorch
• river
• ray
• dev
• tests
• examples : to run notebooks and examples
• all : all of the above
• all_arm64 : Apple ARM64 version all of the above

Note: you can add --upgrade to the command above to upgrade your installation to the latest version if you already have the SAIL installed

(Optional) If you'd like to use jupyter notebooks:

pip install jupyter
# MAC USERS, if this fails try
# `conda install jupyter` instead if you're using anaconda or miniconda

Note: if errors occur in the above steps along with Warning messages about a newer version of pip - you may need to upgrade your pip version:

pip install --upgrade pip

2. Installing from our github.com release page

Download a release from our github release page and then install it directly with pip. For example (your version might be different):

pip install "sail-0.6.4.zip[all]"

From there follow the same steps following the pip install in option one above.

3. Installing from source code

If you want to use the latest development code, install from the repository. First clone the SAIL repository.

git clone https://github.com/IBM/sail.git
cd sail
pip install -e ".[OPTION]"

Supported OPTION include:

• tensorflow
• tensorflow_arm64
• pytorch
• river
• ray
• dev
• tests
• examples : to run notebooks and examples
• all : all of the above
• all_arm64 : Apple ARM64 version all of the above