installation.md

Installation

1. Linux Installation

   1.1. Prerequisites

   1.2. Install from Pypi

   1.3. Install from Source

2. Windows Installation

   2.1. Prerequisites

   2.2. Install from Pypi

   2.3. Install from Source

3. System Requirements

   3.1. Validated Hardware Environment

   3.2. Validated Software Environment

Linux Installation

Prerequisites

The following prerequisites and requirements must be satisfied for a successful installation:

• Python version: 3.7 or 3.8 or 3.9 or 3.10

# Install Dependency
pip install -r requirements.txt

Note: Recommend install protobuf <= 3.20.0 if use onnxruntime <= 1.11

Install from Pypi

# install stable basic version from pypi
pip install intel-extension-for-transformers

# install nightly version
pip install -i https://test.pypi.org/simple/ intel-extension-for-transformers
# or install nightly version with only backend
pip install -i https://test.pypi.org/simple/ intel-extension-for-transformers-backend

# install stable basic version from from conda
conda install -c intel intel_extension_for_transformers

Install from Source

git clone https://github.com/intel/intel-extension-for-transformers.git intel_extension_for_transformers
cd intel_extension_for_transformers
# Install Dependency
pip install -r requirements.txt
git submodule update --init --recursive
# Install intel_extension_for_transformers
python setup.py install

Windows Installation

Prerequisites

The following prerequisites and requirements must be satisfied for a successful installation:

• Python version: 3.7 or 3.8 or 3.9
• Visual Studio

Install from Pypi

pip install intel-extension-for-transformers

Install from Source

git clone https://github.com/intel/intel-extension-for-transformers.git intel_extension_for_transformers
cd intel_extension_for_transformers
# Install Dependency
pip install -r requirements.txt
git submodule update --init --recursive
# Install intel_extension_for_transformers
python setup.py install

System Requirements

Validated Hardware Environment

Intel® Extension for Transformers supports systems based on Intel 64 architecture or compatible processors that are specifically optimized for the following CPUs:

• Intel Xeon Scalable processor (formerly Cascade Lake, Icelake)
• Future Intel Xeon Scalable processor (code name Sapphire Rapids)

Validated Software Environment

• OS version: CentOS 8.4, Ubuntu 20.04
• Python version: 3.7, 3.8, 3.9

Framework	Intel TensorFlow	PyTorch	IPEX
Version	2.10.0 2.9.1	1.13.0+cpu 1.12.0+cpu 1.11.0+cpu	1.13.0 1.12.0

• OS version: Windows 10
• Python version: 3.7, 3.8, 3.9

Framework	Intel TensorFlow	PyTorch
Version	2.9.1	1.13.0+cpu