# Install IPEX-LLM on Windows with Intel GPU

This guide demonstrates how to install IPEX-LLM on Windows with Intel GPUs. 

It applies to Intel Core Ultra and Core 11 - 14 gen integrated GPUs (iGPUs), as well as Intel Arc Series GPU.

## Install Prerequisites

### (Optional) Update GPU Driver

```eval_rst
.. tip::

   It is recommended to update your GPU driver, if you have driver version lower than ``31.0.101.5122``. Refer to `here <../Overview/install_gpu.html#prerequisites>`_ for more information.
```

Download and install the latest GPU driver from the [official Intel download page](https://www.intel.com/content/www/us/en/download/785597/intel-arc-iris-xe-graphics-windows.html). A system reboot is necessary to apply the changes after the installation is complete.

```eval_rst
.. note::

   The process could take around 10 minutes. After reboot, check for the **Intel Arc Control** application to verify the driver has been installed correctly. If the installation was successful, you should see the **Arc Control** interface similar to the figure below
```

<img src="https://llm-assets.readthedocs.io/en/latest/_images/quickstart_windows_gpu_3.png" width=100%; />


<!-- ### Install oneAPI  -->

<!-- Download and install the [**Intel oneAPI Base Toolkit 2024.0**](https://www.intel.com/content/www/us/en/developer/tools/oneapi/base-toolkit-download.html?operatingsystem=window&distributions=offline). During installation, you can continue with the default installation settings.

<img src="https://llm-assets.readthedocs.io/en/latest/_images/quickstart_windows_gpu_oneapi_offline_installer.png"  width=100%; />

```eval_rst
.. tip::

   If the oneAPI installation hangs at the finalization step for more than 10 minutes, the error might be due to a problematic install of Visual Studio. Please reboot your computer and then launch the Visual Studio installer. If you see installation error messages, please repair your Visual Studio installation. After the repair is done, oneAPI installation is completed successfully.
``` -->

### Setup Python Environment

Visit [Miniforge installation page](https://conda-forge.org/download/), download the **Miniforge installer for Windows**, and follow the instructions to complete the installation.

<div align="center">
<img src="https://llm-assets.readthedocs.io/en/latest/_images/quickstart_windows_gpu_miniforge_download.png"  width=80%/>
</div>

After installation, open the **Miniforge Prompt**, create a new python environment `llm`:
```cmd
conda create -n llm python=3.11 libuv
```
Activate the newly created environment `llm`:
```cmd
conda activate llm
```
  
## Install `ipex-llm`

With the `llm` environment active, use `pip` to install `ipex-llm` for GPU. Choose either US or CN website for `extra-index-url`:

```eval_rst
.. tabs::
   .. tab:: US

      .. code-block:: cmd

         pip install --pre --upgrade ipex-llm[xpu] --extra-index-url https://pytorch-extension.intel.com/release-whl/stable/xpu/us/

   .. tab:: CN

      .. code-block:: cmd

         pip install --pre --upgrade ipex-llm[xpu] --extra-index-url https://pytorch-extension.intel.com/release-whl/stable/xpu/cn/
```

```eval_rst
.. note::

  If you encounter network issues while installing IPEX, refer to `this guide <https://ipex-llm.readthedocs.io/en/latest/doc/LLM/Overview/install_gpu.html#install-ipex-llm-from-wheel>`_ for troubleshooting advice.
```

## Verify Installation
You can verify if `ipex-llm` is successfully installed following below steps.

### Step 1: Runtime Configurations
* Open the **Miniforge Prompt** and activate the Python environment `llm` you previously created: 
   ```cmd
   conda activate llm
   ```
<!-- * Configure oneAPI variables by running the following command:
   ```cmd
   call "C:\Program Files (x86)\Intel\oneAPI\setvars.bat"
   ``` -->
* Set the following environment variables according to your device:

  ```eval_rst
  .. tabs::
     .. tab:: Intel iGPU
  
        .. code-block:: cmd
  
           set SYCL_CACHE_PERSISTENT=1
           set BIGDL_LLM_XMX_DISABLED=1
  
     .. tab:: Intel Arc™ A770
  
        .. code-block:: cmd
  
           set SYCL_CACHE_PERSISTENT=1
  ```
  
  ```eval_rst
  .. seealso::

     For other Intel dGPU Series, please refer to `this guide <../Overview/install_gpu.html#runtime-configuration>`_ for more details regarding runtime configuration.
  ```

### Step 2: Run Python Code

*  Launch the Python interactive shell by typing `python` in the Miniforge Prompt window and then press Enter.

* Copy following code to Miniforge Prompt **line by line** and press Enter **after copying each line**.
  ```python
  import torch 
  from ipex_llm.transformers import AutoModel,AutoModelForCausalLM    
  tensor_1 = torch.randn(1, 1, 40, 128).to('xpu') 
  tensor_2 = torch.randn(1, 1, 128, 40).to('xpu') 
  print(torch.matmul(tensor_1, tensor_2).size()) 
  ```
  It will output following content at the end:
  ```
  torch.Size([1, 1, 40, 40])
  ```

  ```eval_rst
  .. seealso::

    If you encounter any problem, please refer to `here <https://ipex-llm.readthedocs.io/en/latest/doc/LLM/Overview/install_gpu.html#troubleshooting>`_ for help.
  ```
* To exit the Python interactive shell, simply press Ctrl+Z then press Enter (or input `exit()` then press Enter).

## Monitor GPU Status
To monitor your GPU's performance and status (e.g. memory consumption, utilization, etc.), you can use either the **Windows Task Manager (in `Performance` Tab)** (see the left side of the figure below) or the **Arc Control** application (see the right side of the figure below)

<img src="https://llm-assets.readthedocs.io/en/latest/_images/quickstart_windows_gpu_4.png"  width=100%; />

## A Quick Example

Now let's play with a real LLM. We'll be using the [Qwen-1.8B-Chat](https://huggingface.co/Qwen/Qwen-1_8B-Chat) model, a 1.8 billion parameter LLM for this demonstration. Follow the steps below to setup and run the model, and observe how it responds to a prompt "What is AI?". 

* Step 1: Follow [Runtime Configurations Section](#step-1-runtime-configurations) above to prepare your runtime environment.  
* Step 2: Install additional package required for Qwen-1.8B-Chat to conduct:
   ```cmd
   pip install tiktoken transformers_stream_generator einops
   ```
* Step 3: Create code file. IPEX-LLM supports loading model from Hugging Face or ModelScope. Please choose according to your requirements.
  ```eval_rst
  .. tabs::
     .. tab:: Hugging Face
        Create a new file named ``demo.py`` and insert the code snippet below to run `Qwen-1.8B-Chat <https://huggingface.co/Qwen/Qwen-1_8B-Chat>`_ model with IPEX-LLM optimizations.
  
        .. code-block:: python
  
           # Copy/Paste the contents to a new file demo.py
           import torch
           from ipex_llm.transformers import AutoModelForCausalLM
           from transformers import AutoTokenizer, GenerationConfig
           generation_config = GenerationConfig(use_cache=True)
           
           print('Now start loading Tokenizer and optimizing Model...')
           tokenizer = AutoTokenizer.from_pretrained("Qwen/Qwen-1_8B-Chat",
                                                      trust_remote_code=True)

           # Load Model using ipex-llm and load it to GPU
           model = AutoModelForCausalLM.from_pretrained("Qwen/Qwen-1_8B-Chat",
                                                        load_in_4bit=True,
                                                        cpu_embedding=True,
                                                        trust_remote_code=True)
           model = model.to('xpu')
           print('Successfully loaded Tokenizer and optimized Model!')
        
           # Format the prompt
           question = "What is AI?"
           prompt = "user: {prompt}\n\nassistant:".format(prompt=question)

           # Generate predicted tokens
           with torch.inference_mode():
               input_ids = tokenizer.encode(prompt, return_tensors="pt").to('xpu')
        
               print('--------------------------------------Note-----------------------------------------')
               print('| For the first time that each model runs on Intel iGPU/Intel Arc™ A300-Series or |')
               print('| Pro A60, it may take several minutes for GPU kernels to compile and initialize. |')
               print('| Please be patient until it finishes warm-up...                                  |')
               print('-----------------------------------------------------------------------------------')
        
               # To achieve optimal and consistent performance, we recommend a one-time warm-up by running `model.generate(...)` an additional time before starting your actual generation tasks.
               # If you're developing an application, you can incorporate this warm-up step into start-up or loading routine to enhance the user experience.
               output = model.generate(input_ids,
                                       do_sample=False,
                                       max_new_tokens=32,
                                       generation_config=generation_config) # warm-up
        
               print('Successfully finished warm-up, now start generation...')
        
               output = model.generate(input_ids,
                                       do_sample=False,
                                       max_new_tokens=32,
                                       generation_config=generation_config).cpu()
               output_str = tokenizer.decode(output[0], skip_special_tokens=True)
               print(output_str)
     
     .. tab:: ModelScope
  
        Please first run following command in Miniforge Prompt to install ModelScope:

        .. code-block:: cmd

           pip install modelscope==1.11.0

        Create a new file named ``demo.py`` and insert the code snippet below to run `Qwen-1.8B-Chat <https://www.modelscope.cn/models/qwen/Qwen-1_8B-Chat/summary>`_ model with IPEX-LLM optimizations.

        .. code-block:: python

           # Copy/Paste the contents to a new file demo.py
           import torch
           from ipex_llm.transformers import AutoModelForCausalLM
           from transformers import GenerationConfig
           from modelscope import AutoTokenizer
           generation_config = GenerationConfig(use_cache=True)
           
           print('Now start loading Tokenizer and optimizing Model...')
           tokenizer = AutoTokenizer.from_pretrained("Qwen/Qwen-1_8B-Chat",
                                                      trust_remote_code=True)

           # Load Model using ipex-llm and load it to GPU
           model = AutoModelForCausalLM.from_pretrained("Qwen/Qwen-1_8B-Chat",
                                                        load_in_4bit=True,
                                                        cpu_embedding=True,
                                                        trust_remote_code=True,
                                                        model_hub='modelscope')
           model = model.to('xpu')
           print('Successfully loaded Tokenizer and optimized Model!')
        
           # Format the prompt
           question = "What is AI?"
           prompt = "user: {prompt}\n\nassistant:".format(prompt=question)

           # Generate predicted tokens
           with torch.inference_mode():
               input_ids = tokenizer.encode(prompt, return_tensors="pt").to('xpu')
        
               print('--------------------------------------Note-----------------------------------------')
               print('| For the first time that each model runs on Intel iGPU/Intel Arc™ A300-Series or |')
               print('| Pro A60, it may take several minutes for GPU kernels to compile and initialize. |')
               print('| Please be patient until it finishes warm-up...                                  |')
               print('-----------------------------------------------------------------------------------')
        
               # To achieve optimal and consistent performance, we recommend a one-time warm-up by running `model.generate(...)` an additional time before starting your actual generation tasks.
               # If you're developing an application, you can incorporate this warm-up step into start-up or loading routine to enhance the user experience.
               output = model.generate(input_ids,
                                       do_sample=False,
                                       max_new_tokens=32,
                                       generation_config=generation_config) # warm-up
        
               print('Successfully finished warm-up, now start generation...')
        
               output = model.generate(input_ids,
                                       do_sample=False,
                                       max_new_tokens=32,
                                       generation_config=generation_config).cpu()
               output_str = tokenizer.decode(output[0], skip_special_tokens=True)
               print(output_str)
      

        .. tip::

           Please note that the repo id on ModelScope may be different from Hugging Face for some models.

  ```

  ```eval_rst
  .. note::
  
     When running LLMs on Intel iGPUs with limited memory size, we recommend setting ``cpu_embedding=True`` in the ``from_pretrained`` function.
     This will allow the memory-intensive embedding layer to utilize the CPU instead of GPU.
  ```

* Step 4. Run `demo.py` within the activated Python environment using the following command:
  ```cmd
  python demo.py
  ```
   
   ### Example output
  
   Example output on a system equipped with an Intel Core Ultra 5 125H CPU and Intel Arc Graphics iGPU:
   ```
   user: What is AI?

   assistant: AI stands for Artificial Intelligence, which refers to the development of computer systems that can perform tasks that typically require human intelligence, such as visual perception, speech recognition,
   ```

## Tips & Troubleshooting

### Warm-up for optimal performance on first run
When running LLMs on GPU for the first time, you might notice the performance is lower than expected, with delays up to several minutes before the first token is generated. This delay occurs because the GPU kernels require compilation and initialization, which varies across different GPU types. To achieve optimal and consistent performance, we recommend a one-time warm-up by running `model.generate(...)` an additional time before starting your actual generation tasks. If you're developing an application, you can incorporate this warm-up step into start-up or loading routine to enhance the user experience.
