In this directory, you will find examples on how you could apply IPEX-LLM INT4 optimizations on Mistral models. For illustration purposes, we utilize the mistralai/Mistral-7B-Instruct-v0.1 and mistralai/Mistral-7B-v0.1 as reference Mistral models.
To run these examples with IPEX-LLM, we have some recommended requirements for your machine, please refer to here for more information.
Important: According to Mistral Troubleshooting, please make sure you have installed transformers==4.34.0 to run the example.
In the example generate.py, we show a basic use case for a Mistral model to predict the next N tokens using generate() API, with IPEX-LLM INT4 optimizations.
We suggest using conda to manage the Python environment. For more information about conda installation, please refer to here.
After installing conda, create a Python environment for IPEX-LLM:
conda create -n llm python=3.9 # recommend to use Python 3.9
conda activate llm
pip install --pre --upgrade ipex-llm[all] # install the latest ipex-llm nightly build with 'all' option
# Refer to https://huggingface.co/mistralai/Mistral-7B-v0.1#troubleshooting, please make sure you are using a stable version of Transformers, 4.34.0 or newer.
pip install transformers==4.34.0After setting up the Python environment, you could run the example by following steps.
Note: When loading the model in 4-bit, IPEX-LLM converts linear layers in the model into INT4 format. In theory, a XB model saved in 16-bit will requires approximately 2X GB of memory for loading, and ~0.5X GB memory for further inference.
Please select the appropriate size of the Mistral model based on the capabilities of your machine.
On client Windows machines, it is recommended to run directly with full utilization of all cores:
python ./generate.py --prompt 'What is AI?'More information about arguments can be found in Arguments Info section. The expected output can be found in Sample Output section.
For optimal performance on server, it is recommended to set several environment variables (refer to here for more information), and run the example with all the physical cores of a single socket.
E.g. on Linux,
# set IPEX-LLM env variables
source ipex-llm-init
# e.g. for a server with 48 cores per socket
export OMP_NUM_THREADS=48
numactl -C 0-47 -m 0 python ./generate.py --prompt 'What is AI?'More information about arguments can be found in Arguments Info section. The expected output can be found in Sample Output section.
In the example, several arguments can be passed to satisfy your requirements:
--repo-id-or-model-path REPO_ID_OR_MODEL_PATH: argument defining the huggingface repo id for the Mistral model (e.g.mistralai/Mistral-7B-Instruct-v0.1andmistralai/Mistral-7B-v0.1) to be downloaded, or the path to the huggingface checkpoint folder. It is default to be'mistralai/Mistral-7B-Instruct-v0.1'.--prompt PROMPT: argument defining the prompt to be infered (with integrated prompt format for chat). It is default to be'What is AI?'.--n-predict N_PREDICT: argument defining the max number of tokens to predict. It is default to be32.
Inference time: xxxx s
-------------------- Output --------------------
[INST] What is AI? [/INST] AI stands for Artificial Intelligence. It is a branch of computer science that focuses on the development of intelligent machines that work, react, and even think like humans
Inference time: xxxx s
-------------------- Output --------------------
[INST] What is AI? [/INST]
[INST] Artificial Intelligence (AI) is a branch of computer science that deals with the simulation of intelligent behavior in computers. It is a broad