diff --git a/python/llm/portable-executable/.gitignore b/python/llm/portable-executable/.gitignore deleted file mode 100644 index 23c0161c..00000000 --- a/python/llm/portable-executable/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -python-embed -portable-executable.zip \ No newline at end of file diff --git a/python/llm/portable-executable/README.md b/python/llm/portable-executable/README.md deleted file mode 100644 index 0f1df88f..00000000 --- a/python/llm/portable-executable/README.md +++ /dev/null @@ -1,33 +0,0 @@ -# BigDL-LLM Portable Executable For Windows: User Guide - -This portable executable includes everything you need to run LLM (except models). Please refer to How to use section to get started. - -## 13B model running on an Intel 11-Gen Core PC (real-time screen capture) - -

- - -

- -## Verified Models - -- ChatGLM2-6b -- Baichuan-13B-Chat -- Baichuan2-7B-Chat -- internlm-chat-7b-8k -- Llama-2-7b-chat-hf - -## How to use - -1. Download the model to your computer. Please ensure there is a file named `config.json` in the model folder, otherwise the script won't work. - - ![](https://llm-assets.readthedocs.io/en/latest/_images/one-click-installer-user-guide-step1.png) - -2. Run `chat.bat` in Terminal and input the path of the model (e.g. `path\to\model`, note that there's no slash at the end of the path). - - ![](https://llm-assets.readthedocs.io/en/latest/_images/one-click-installer-user-guide-step2.png) - -3. Press Enter and wait until model finishes loading. Then enjoy chatting with the model! -4. If you want to stop chatting, just input `stop` and the model will stop running. - - ![](https://llm-assets.readthedocs.io/en/latest/_images/one-click-installer-user-guide-step34.png) diff --git a/python/llm/portable-executable/setup.md b/python/llm/portable-executable/setup.md deleted file mode 100644 index 22520c64..00000000 --- a/python/llm/portable-executable/setup.md +++ /dev/null @@ -1,5 +0,0 @@ -# BigDL-LLM Portable Executable Setup Script For Windows - -# How to use - -Just simply run `setup.bat` and it will download and install all dependency and generate a zip file for user to use. diff --git a/python/llm/portable-zip/.gitignore b/python/llm/portable-zip/.gitignore new file mode 100644 index 00000000..fa79eccd --- /dev/null +++ b/python/llm/portable-zip/.gitignore @@ -0,0 +1,2 @@ +python-embed +bigdl-llm.zip \ No newline at end of file diff --git a/python/llm/portable-zip/README.md b/python/llm/portable-zip/README.md new file mode 100644 index 00000000..a8202f55 --- /dev/null +++ b/python/llm/portable-zip/README.md @@ -0,0 +1,37 @@ +# BigDL-LLM Portable Zip For Windows: User Guide + +## Introduction + +This portable zip includes everything you need to run an LLM with BigDL-LLM optimizations (except models) . Please refer to [How to use](#how-to-use) section to get started. + +### 13B model running on an Intel 11-Gen Core PC (real-time screen capture) + +

+ + +

+ +### Verified Models + +- ChatGLM2-6b +- Baichuan-13B-Chat +- Baichuan2-7B-Chat +- internlm-chat-7b-8k +- Llama-2-7b-chat-hf + +## How to use + +1. Download the zip from link [here](). +2. (Optional) You could also build the zip on your own. Run `setup.bat` and it will generate the zip file. +3. Unzip `bigdl-llm.zip`. +4. Download the model to your computer. Please ensure there is a file named `config.json` in the model folder, otherwise the script won't work. + + ![](https://llm-assets.readthedocs.io/en/latest/_images/one-click-installer-user-guide-step1.png) + +5. Go into the unzipped folder and double click `chat.bat`. Input the path of the model (e.g. `path\to\model`, note that there's no slash at the end of the path). Press Enter and wait until model finishes loading. Then enjoy chatting with the model! + + ![](https://llm-assets.readthedocs.io/en/latest/_images/one-click-installer-user-guide-step2.png) + +6. If you want to stop chatting, just input `stop` and the model will stop running. + + ![](https://llm-assets.readthedocs.io/en/latest/_images/one-click-installer-user-guide-step34.png) diff --git a/python/llm/portable-executable/chat.bat b/python/llm/portable-zip/chat.bat similarity index 61% rename from python/llm/portable-executable/chat.bat rename to python/llm/portable-zip/chat.bat index b02c9615..832eb13d 100644 --- a/python/llm/portable-executable/chat.bat +++ b/python/llm/portable-zip/chat.bat @@ -5,4 +5,6 @@ set PYTHONUNBUFFERED=1 set /p modelpath="Please enter the model path: " -.\python-embed\python.exe .\chat.py --model-path="%modelpath%" \ No newline at end of file +.\python-embed\python.exe .\chat.py --model-path="%modelpath%" + +pause \ No newline at end of file diff --git a/python/llm/portable-executable/chat.py b/python/llm/portable-zip/chat.py similarity index 100% rename from python/llm/portable-executable/chat.py rename to python/llm/portable-zip/chat.py diff --git a/python/llm/portable-executable/setup.bat b/python/llm/portable-zip/setup.bat similarity index 92% rename from python/llm/portable-executable/setup.bat rename to python/llm/portable-zip/setup.bat index de8ad28c..19990214 100644 --- a/python/llm/portable-executable/setup.bat +++ b/python/llm/portable-zip/setup.bat @@ -20,4 +20,4 @@ cd .. %python-embed% -m pip install bigdl-llm[all] transformers_stream_generator tiktoken einops colorama :: compress the python and scripts -powershell -Command "Compress-Archive -Path '.\python-embed', '.\chat.bat', '.\chat.py', '.\README.md' -DestinationPath .\portable-executable.zip" +powershell -Command "Compress-Archive -Path '.\python-embed', '.\chat.bat', '.\chat.py', '.\README.md' -DestinationPath .\bigdl-llm.zip" diff --git a/python/llm/portable-zip/setup.md b/python/llm/portable-zip/setup.md new file mode 100644 index 00000000..5810a559 --- /dev/null +++ b/python/llm/portable-zip/setup.md @@ -0,0 +1,5 @@ +# BigDL-LLM Portable Zip Setup Script For Windows + +# How to use + +Just simply run `setup.bat` and it will download and install all dependency and generate `bigdl-llm.zip` for user to use.