ipex-llm/python/llm/portable-executable/README.md
JinBridge 023555fb1f LLM: Add one-click installer for Windows (#8999)
* LLM: init one-click installer for windows

* LLM: fix typo in one-click installer readme

* LLM: one-click installer try except logic

* LLM: one-click installer add dependency

* LLM: one-click installer adjust README.md

* LLM: one-click installer split README and add zip compress in setup.bat

* LLM: one-click installer verified internlm and llama2 and replace gif

* LLM: remove one-click installer images

* LLM: finetune the one-click installer README.md

* LLM: fix typo in one-click installer README.md

* LLM: rename one-click installer to protable executable

* LLM: rename other places to protable executable

* LLM: rename the zip filename to executable

* LLM: update .gitignore

* LLM: add colorama to setup.bat
2023-09-22 14:46:30 +08:00

33 lines
1.3 KiB
Markdown

# 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)
<p align="left">
<img src=https://llm-assets.readthedocs.io/en/latest/_images/one-click-installer-screen-capture.gif width='80%' />
</p>
## 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)