* init * refine * refine * refine * modify hf-agent example * modify all CPU model example * remove readthedoc modify * replace powershell with cmd * fix repo * fix repo * update * remove comment on windows code block * update * update * update * update --------- Co-authored-by: xiangyuT <xiangyu.tian@intel.com>  | 
			||
|---|---|---|
| .. | ||
| generate.py | ||
| README.md | ||
DeepSeek-MoE
In this directory, you will find examples on how you could use IPEX-LLM optimize_model API to accelerate DeepSeek-MoE models. For illustration purposes, we utilize the deepseek-ai/DeepSeek-MoE-16b-chat as a reference DeepSeek-MoE model.
Requirements
To run these examples with IPEX-LLM, we have some recommended requirements for your machine, please refer to here for more information.
Example: Predict Tokens using generate() API
In the example generate.py, we show a basic use case for a deepseek-moe model to predict the next N tokens using generate() API, with IPEX-LLM INT4 optimizations.
1. Install
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:
On Linux:
conda create -n llm python=3.11 # recommend to use Python 3.11
conda activate llm
# install the latest ipex-llm nightly build with 'all' option
pip install --pre --upgrade ipex-llm[all] --extra-index-url https://download.pytorch.org/whl/cpu
pip install einops 
On Windows:
conda create -n llm python=3.11
conda activate llm
pip install --pre --upgrade ipex-llm[all]
pip install einops 
2. Run
After setting up the Python environment, you could run the example by following steps.
2.1 Client
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.
2.2 Server
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.
2.3 Arguments Info
In the example, several arguments can be passed to satisfy your requirements:
--repo-id-or-model-path: str, argument defining the huggingface repo id for the DeepSeek-MoE model to be downloaded, or the path to the huggingface checkpoint folder. It is default to be'deepseek-ai/deepseek-moe-16b-chat'.--prompt: str, argument defining the prompt to be inferred (with integrated prompt format for chat). It is default to be'What is AI?'.--n-predict: int, argument defining the max number of tokens to predict. It is default to be32.
2.4 Sample Output
deepseek-ai/deepseek-moe-16b-chat
Inference time: xxxx s
-------------------- Prompt --------------------
<|begin▁of▁sentence|>[INST] What is AI? [/INST]
-------------------- Output --------------------
<|begin▁of▁sentence|>[INST] What is AI? [/INST]
Artificial Intelligence (AI) is a field of computer science that aims to create intelligent machines that can perform tasks that typically require human intelligence, such as learning