diff --git a/docs/mddocs/Quickstart/llamacpp_portable_zip_gpu_quickstart.md b/docs/mddocs/Quickstart/llamacpp_portable_zip_gpu_quickstart.md index 3df69edf..82e60add 100644 --- a/docs/mddocs/Quickstart/llamacpp_portable_zip_gpu_quickstart.md +++ b/docs/mddocs/Quickstart/llamacpp_portable_zip_gpu_quickstart.md @@ -8,7 +8,6 @@ This guide demonstrates how to use [llama.cpp portable zip](https://github.com/i > - Intel Core 11th - 14th gen processors > - Intel Arc A-Series GPU > - Intel Arc B-Series GPU -> Currently, IPEX-LLM only provides llama.cpp portable zip on Windows. ## Table of Contents - [Windows Quickstart](#windows-quickstart) @@ -16,6 +15,12 @@ This guide demonstrates how to use [llama.cpp portable zip](https://github.com/i - [Step 1: Download and Unzip](#step-1-download-and-unzip) - [Step 3: Runtime Configuration](#step-2-runtime-configuration) - [Step 3: Run GGUF models](#step-3-run-gguf-models) +- [Linux Quickstart](#linux-quickstart) + - [Prerequisites](#prerequisites-1) + - [Step 1: Download and Extract](#step-1-download-and-extract) + - [Step 2: Runtime Configuration](#step-2-runtime-configuration-1) + - [Step 3: Run GGUF models](#step-3-run-gguf-models-1) + - [(New) FlashMoE for Moe Models (e.g., DeeSeek V3/R1) using llama.cpp](#flashmoe-for-deeseek-v3r1) - [Tips & Troubleshooting](#tips--troubleshooting) - [Error: Detected different sycl devices](#error-detected-different-sycl-devices) - [Multi-GPUs usage](#multi-gpus-usage) @@ -54,12 +59,14 @@ Here we provide a simple example to show how to run a community GGUF model with Before running, you should download or copy community GGUF model to your current directory. For instance, `DeepSeek-R1-Distill-Qwen-7B-Q4_K_M.gguf` of [bartowski/DeepSeek-R1-Distill-Qwen-7B-GGUF](https://huggingface.co/bartowski/DeepSeek-R1-Distill-Qwen-7B-GGUF/blob/main/DeepSeek-R1-Distill-Qwen-7B-Q4_K_M.gguf). #### Run GGUF model - ```cmd - llama-cli.exe -m D:\llm-models\gguf\DeepSeek-R1-Distill-Qwen-7B-Q4_K_M.gguf -p "A conversation between User and Assistant. The user asks a question, and the Assistant solves it. The assistant first thinks about the reasoning process in the mind and then provides the user with the answer. The reasoning process and answer are enclosed within and tags, respectively, i.e., reasoning process here answer here . User: Question:The product of the ages of three teenagers is 4590. How old is the oldest? a. 18 b. 19 c. 15 d. 17 Assistant: " -n 2048 -t -8 -e -ngl 99 --color -c 2500 --temp 0 - ``` + +```cmd +llama-cli.exe -m D:\llm-models\gguf\DeepSeek-R1-Distill-Qwen-7B-Q4_K_M.gguf -p "A conversation between User and Assistant. The user asks a question, and the Assistant solves it. The assistant first thinks about the reasoning process in the mind and then provides the user with the answer. The reasoning process and answer are enclosed within and tags, respectively, i.e., reasoning process here answer here . User: Question:The product of the ages of three teenagers is 4590. How old is the oldest? a. 18 b. 19 c. 15 d. 17 Assistant: " -n 2048 -t 8 -e -ngl 99 --color -c 2500 --temp 0 +``` + Part of outputs: - ``` + +``` Found 1 SYCL devices: | | | | |Max | |Max |Global | | @@ -90,39 +97,11 @@ sampler chain: logits -> logit-bias -> penalties -> dry -> top-k -> typical -> t generate: n_ctx = 2528, n_batch = 4096, n_predict = 2048, n_keep = 1 -A conversation between User and Assistant. The user asks a question, and the Assistant solves it. The assistant first thinks about the reasoning process in the mind and then provides the user with the answer. The reasoning process and answer are enclosed within and tags, respectively, i.e., reasoning process here answer here . User: Question:The product of the ages of three teenagers is 4590. How old is the oldest? a. 18 b. 19 c. 15 d. 17 Assistant: - -Okay, so I have this problem where the product of the ages of three teenagers is 4590, and I need to figure out how old the oldest one is. The options are 18, 19, 15, or 17. Hmm, let's break this down step by step. - -First, I know that teenagers are typically between 13 and 19 years old. So, the ages we're dealing with are all in that range. The product of their ages is 4590, which is a pretty big number. I need to find three numbers between 13 and 19 that multiply together to give 4590. - -Maybe I should start by factoring 4590 to see what numbers I'm working with. Let's see, 4590. I can divide by 10 first because it's easy. 4590 divided by 10 is 459. So, 4590 = 10 × 459. Now, 459 is a bit tricky. Let's factor that further. 459 divided by 3 is 153. So, 459 = 3 × 153. Continuing, 153 divided by 3 is 51, so 153 = 3 × 51. And 51 divided by 3 is 17, so 51 = 3 × 17. Putting it all together, 4590 = 10 × 3 × 3 × 3 × 17. - -Wait, but 10 is not a teenager's age. Teenagers are between 13 and 19, so 10 is too young. Maybe I need to combine some of these factors to get ages within the teenager range. Let's see, 10 can be broken down into 2 × 5. So, 4590 = 2 × 5 × 3 × 3 × 3 × 17. - -Now, I need to group these prime factors into three numbers between 13 and 19. Let's list out the prime factors: 2, 3, 3, 3, 5, 17. Hmm, 17 is a prime number, so that has to be one of the ages. So, one of the teenagers is 17 years old. - -Now, I need to find two more ages from the remaining factors: 2, 3, 3, 3, 5. Let's see, 2 × 3 = 6, which is too young. 3 × 3 = 9, also too young. 3 × 5 = 15, which is within the teenager range. So, one age is 15. - -Now, the remaining factors are 2, 3, and 5. Let's multiply them together: 2 × 3 × 5 = 30. Wait, 30 is too old for a teenager. That's a problem. Maybe I need to combine them differently. Let's see, 2 × 5 = 10, which is too young. 3 × 5 = 15, which we've already used. Hmm, maybe I need to adjust my grouping. - -Wait, perhaps I can combine 2 and 3 to make 6, but that's too young. Alternatively, maybe I can combine 3 and 3 to make 9, but that's still too young. Hmm, this is tricky. Maybe I need to consider that one of the ages could be 18 or 19, which are also teenagers. - -Let me try a different approach. Let's list all possible combinations of three numbers between 13 and 19 that multiply to 4590. Starting with 17, since it's a prime factor, it has to be one of them. So, 17 is one age. Now, I need two more ages from the remaining factors: 2, 3, 3, 3, 5. - -If I take 15 (which is 3 × 5), then the remaining factors are 2 and 3. Multiplying those gives 6, which is too young. So that doesn't work. Alternatively, if I take 18 (which is 2 × 3 × 3), then the remaining factors are 3 and 5. Multiplying those gives 15. So, the ages would be 17, 18, and 15. That adds up correctly: 17 × 18 × 15 = 4590. - -Wait, let me double-check that multiplication. 17 × 18 is 306, and 306 × 15 is indeed 4590. So, the ages are 15, 17, and - 18. Therefore, the oldest is 18. - -But wait, the options include 19 as well. Did I miss a combination where one of the ages is 19? Let's see. If I try to include 19, I need to see if 4590 is divisible by 19. Let's divide 4590 by 19. 19 × 241 is 4579, which is close but not exactly 4590. So, 19 doesn't divide evenly into 4590. Therefore, 19 can't be one of the ages. - -So, the only possible ages are 15, 17, and 18, making the oldest 18. Therefore, the answer should be 18. + +XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -The oldest teenager is 18 years old. - -18 [end of text] +XXXX [end of text] llama_perf_sampler_print: sampling time = xxx.xx ms / 1386 runs ( x.xx ms per token, xxxxx.xx tokens per second) @@ -130,7 +109,156 @@ llama_perf_context_print: load time = xxxxx.xx ms llama_perf_context_print: prompt eval time = xxx.xx ms / 129 tokens ( x.xx ms per token, xxx.xx tokens per second) llama_perf_context_print: eval time = xxxxx.xx ms / 1256 runs ( xx.xx ms per token, xx.xx tokens per second) llama_perf_context_print: total time = xxxxx.xx ms / 1385 tokens +``` + +## Linux Quickstart + +### Prerequisites + +Check your GPU driver version, and update it if needed; we recommend following [Intel client GPU driver installation guide](https://dgpu-docs.intel.com/driver/client/overview.html) to install your GPU driver. + +### Step 1: Download and Extract + +Download IPEX-LLM llama.cpp portable tgz for Linux users from the [link](https://github.com/intel/ipex-llm/releases/tag/v2.2.0-nightly). + +Then, extract the tgz file to a folder. + +### Step 2: Runtime Configuration + +- Open a "Terminal", and enter the extracted folder through `cd /PATH/TO/EXTRACTED/FOLDER` +- To use GPU acceleration, several environment variables are required or recommended before running `llama.cpp`. + ```bash + export SYCL_CACHE_PERSISTENT=1 ``` +- For multi-GPUs user, go to [Tips](#multi-gpus-usage) for how to select specific GPU. + +### Step 3: Run GGUF models + +Here we provide a simple example to show how to run a community GGUF model with IPEX-LLM. + +#### Model Download +Before running, you should download or copy community GGUF model to your current directory. For instance, `DeepSeek-R1-Distill-Qwen-7B-Q4_K_M.gguf` of [bartowski/DeepSeek-R1-Distill-Qwen-7B-GGUF](https://huggingface.co/bartowski/DeepSeek-R1-Distill-Qwen-7B-GGUF/blob/main/DeepSeek-R1-Distill-Qwen-7B-Q4_K_M.gguf). + +#### Run GGUF model + +```bash +llama-cli -m D:\llm-models\gguf\DeepSeek-R1-Distill-Qwen-7B-Q4_K_M.gguf -p "A conversation between User and Assistant. The user asks a question, and the Assistant solves it. The assistant first thinks about the reasoning process in the mind and then provides the user with the answer. The reasoning process and answer are enclosed within and tags, respectively, i.e., reasoning process here answer here . User: Question:The product of the ages of three teenagers is 4590. How old is the oldest? a. 18 b. 19 c. 15 d. 17 Assistant: " -n 2048 -t 8 -e -ngl 99 --color -c 2500 --temp 0 +``` + +Part of outputs: + +```bash +Found 1 SYCL devices: +| | | | |Max | |Max |Global | + | +| | | | |compute|Max work|sub |mem | + | +|ID| Device Type| Name|Version|units |group |group|size | Driver version| +|--|-------------------|---------------------------------------|-------|-------|--------|-----|-------|---------------------| +| 0| [level_zero:gpu:0]| Intel Arc Graphics| 12.71| 128| 1024| 32| 13578M| 1.3.27504| +llama_kv_cache_init: SYCL0 KV buffer size = 138.25 MiB +llama_new_context_with_model: KV self size = 138.25 MiB, K (f16): 69.12 MiB, V (f16): 69.12 MiB +llama_new_context_with_model: SYCL_Host output buffer size = 0.58 MiB +llama_new_context_with_model: SYCL0 compute buffer size = 1501.00 MiB +llama_new_context_with_model: SYCL_Host compute buffer size = 58.97 MiB +llama_new_context_with_model: graph nodes = 874 +llama_new_context_with_model: graph splits = 2 +common_init_from_params: warming up the model with an empty run - please wait ... (--no-warmup to disable) +main: llama threadpool init, n_threads = 8 + +system_info: n_threads = 8 (n_threads_batch = 8) / 22 | CPU : SSE3 = 1 | SSSE3 = 1 | AVX = 1 | AVX2 = 1 | F16C = 1 | FMA = 1 | LLAMAFILE = 1 | OPENMP = 1 | AARCH64_REPACK = 1 | + +sampler seed: 341519086 +sampler params: + repeat_last_n = 64, repeat_penalty = 1.000, frequency_penalty = 0.000, presence_penalty = 0.000 + dry_multiplier = 0.000, dry_base = 1.750, dry_allowed_length = 2, dry_penalty_last_n = -1 + top_k = 40, top_p = 0.950, min_p = 0.050, xtc_probability = 0.000, xtc_threshold = 0.100, typical_p = 1.000, temp = 0.000 + mirostat = 0, mirostat_lr = 0.100, mirostat_ent = 5.000 +sampler chain: logits -> logit-bias -> penalties -> dry -> top-k -> typical -> top-p -> min-p -> xtc -> temp-ext -> dist + +generate: n_ctx = 2528, n_batch = 4096, n_predict = 2048, n_keep = 1 + + +XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + +XXXX [end of text] +``` + +### FlashMoe for DeeSeek V3/R1 + +FlashMoE is a command-line tool built on llama.cpp, optimized for mixture-of-experts (MoE) models such as DeepSeek V3/R1. Now, it's available for Linux platforms. + +Tested MoE GGUF Models (other MoE GGUF models are also supported): +- [DeepSeek-V3-Q4_K_M](https://huggingface.co/unsloth/DeepSeek-V3-GGUF/tree/main/DeepSeek-V3-Q4_K_M) +- [DeepSeek-V3-Q6_K](https://huggingface.co/unsloth/DeepSeek-V3-GGUF/tree/main/DeepSeek-V3-Q6_K) +- [DeepSeek-R1-Q4_K_M.gguf](https://huggingface.co/unsloth/DeepSeek-R1-GGUF/tree/main/DeepSeek-R1-Q4_K_M) +- [DeepSeek-R1-Q6_K](https://huggingface.co/unsloth/DeepSeek-R1-GGUF/tree/main/DeepSeek-R1-Q6_K) + +#### Run DeepSeek V3/R1 with FlashMoE + +Requirements: +- 380GB CPU Memory +- 1-8 ARC A770 +- 500GB Disk + +Note: +- Larger models and other precisions may require more resources. +- For 1 ARC A770 platform, please reduce context length (e.g., 1024) to avoid OOM. Add this option `-c 1024` at the end of below command. + +Before running, you should download or copy community GGUF model to your current directory. For instance, `DeepSeek-R1-Q4_K_M.gguf` of [DeepSeek-R1-Q4_K_M.gguf](https://huggingface.co/unsloth/DeepSeek-R1-GGUF/tree/main/DeepSeek-R1-Q4_K_M). + +Run `DeepSeek-R1-Q4_K_M.gguf` + +```bash +flash-moe -m DeepSeek-R1-Q4_K_M-00001-of-00009.gguf --prompt "What's AI?" +``` + +Part of outputs + +```bash +llama_kv_cache_init: SYCL0 KV buffer size = 1280.00 MiB +llama_kv_cache_init: SYCL1 KV buffer size = 1280.00 MiB +llama_kv_cache_init: SYCL2 KV buffer size = 1280.00 MiB +llama_kv_cache_init: SYCL3 KV buffer size = 1280.00 MiB +llama_kv_cache_init: SYCL4 KV buffer size = 1120.00 MiB +llama_kv_cache_init: SYCL5 KV buffer size = 1280.00 MiB +llama_kv_cache_init: SYCL6 KV buffer size = 1280.00 MiB +llama_kv_cache_init: SYCL7 KV buffer size = 960.00 MiB +llama_new_context_with_model: KV self size = 9760.00 MiB, K (i8): 5856.00 MiB, V (i8): 3904.00 MiB +llama_new_context_with_model: SYCL_Host output buffer size = 0.49 MiB +llama_new_context_with_model: pipeline parallelism enabled (n_copies=1) +llama_new_context_with_model: SYCL0 compute buffer size = 2076.02 MiB +llama_new_context_with_model: SYCL1 compute buffer size = 2076.02 MiB +llama_new_context_with_model: SYCL2 compute buffer size = 2076.02 MiB +llama_new_context_with_model: SYCL3 compute buffer size = 2076.02 MiB +llama_new_context_with_model: SYCL4 compute buffer size = 2076.02 MiB +llama_new_context_with_model: SYCL5 compute buffer size = 2076.02 MiB +llama_new_context_with_model: SYCL6 compute buffer size = 2076.02 MiB +llama_new_context_with_model: SYCL7 compute buffer size = 3264.00 MiB +llama_new_context_with_model: SYCL_Host compute buffer size = 1332.05 MiB +llama_new_context_with_model: graph nodes = 5184 (with bs=4096), 4720 (with bs=1) +llama_new_context_with_model: graph splits = 125 +common_init_from_params: warming up the model with an empty run - please wait ... (--no-warmup to disable) +main: llama threadpool init, n_threads = 48 + +system_info: n_threads = 48 (n_threads_batch = 48) / 192 | CPU : SSE3 = 1 | SSSE3 = 1 | AVX = 1 | AVX_VNNI = 1 | AVX2 = 1 | F16C = 1 | FMA = 1 | LLAMAFILE = 1 | OPENMP = 1 | AARCH64_REPACK = 1 | + +sampler seed: 2052631435 +sampler params: + repeat_last_n = 64, repeat_penalty = 1.000, frequency_penalty = 0.000, presence_penalty = 0.000 + dry_multiplier = 0.000, dry_base = 1.750, dry_allowed_length = 2, dry_penalty_last_n = -1 + top_k = 40, top_p = 0.950, min_p = 0.050, xtc_probability = 0.000, xtc_threshold = 0.100, typical_p = 1.000, temp = 0.800 + mirostat = 0, mirostat_lr = 0.100, mirostat_ent = 5.000 +sampler chain: logits -> logit-bias -> penalties -> dry -> top-k -> typical -> top-p -> min-p -> xtc -> temp-ext -> dist +generate: n_ctx = 4096, n_batch = 4096, n_predict = -1, n_keep = 1 + + +XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + +XXXX [end of text] +``` ## Tips & Troubleshooting @@ -183,5 +311,3 @@ To specify which Intel GPU you would like llama.cpp to use, you could set enviro To enable SYCL_PI_LEVEL_ZERO_USE_IMMEDIATE_COMMANDLISTS, you can run `set SYCL_PI_LEVEL_ZERO_USE_IMMEDIATE_COMMANDLISTS=1`. > [!NOTE] > The environment variable SYCL_PI_LEVEL_ZERO_USE_IMMEDIATE_COMMANDLISTS determines the usage of immediate command lists for task submission to the GPU. While this mode typically enhances performance, exceptions may occur. Please consider experimenting with and without this environment variable for best performance. For more details, you can refer to [this article](https://www.intel.com/content/www/us/en/developer/articles/guide/level-zero-immediate-command-lists.html). - -