Skip to content

Commit

Permalink
Update screenshot and URL (#23)
Browse files Browse the repository at this point in the history
* Update screenshot - ipex-llm, warm-up

* Update ipex-llm url in readme

* Revert link to download webUI in readme.
Only update readme after link itself is updated.

* Edits

* Migrate readthedocs url to ipex-llm

* Reference images from local readme folder
  • Loading branch information
chtanch authored Mar 28, 2024
1 parent 2a0c81f commit 8a97681
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
***The WebUI is ported from [Text-Generation-WebUI](https://github.com/oobabooga/text-generation-webui) for running local LLM on Intel GPU (e.g., local PC with iGPU, discrete GPU such as Arc, Flex and Max) using [IPEX-LLM](https://github.com/intel-analytics/bigdl).***
***The WebUI is ported from [Text-Generation-WebUI](https://github.com/oobabooga/text-generation-webui) for running local LLM on Intel GPU (e.g., local PC with iGPU, discrete GPU such as Arc, Flex and Max) using [IPEX-LLM](https://github.com/intel-analytics/ipex-llm).***

## Quick Start
To get started, please see the step-by-step [quickstart](https://bigdl.readthedocs.io/en/latest/doc/LLM/Quickstart/webui_quickstart.html).
To get started, please see the step-by-step [quickstart](https://ipex-llm.readthedocs.io/en/latest/doc/LLM/Quickstart/webui_quickstart.html).

[<img src="https://llm-assets.readthedocs.io/en/latest/_images/webui_quickstart_chat.png" height="480px">](https://bigdl.readthedocs.io/en/latest/doc/LLM/Quickstart/webui_quickstart.html)
[<img src="https://llm-assets.readthedocs.io/en/latest/_images/webui_quickstart_chat.png" height="480px">](https://ipex-llm.readthedocs.io/en/latest/doc/LLM/Quickstart/webui_quickstart.html)

## User Guide
For more information, see the user guide below.
Expand All @@ -13,7 +13,7 @@ For more information, see the user guide below.
Before starting all the steps, you need to download and unzip the text-generation-webui based on `IPEX-LLM` optimizations.

```bash
https://github.com/intel-analytics/text-generation-webui/archive/refs/heads/IPEX-LLM.zip
https://github.com/intel-analytics/text-generation-webui/archive/refs/heads/ipex-llm.zip
```

### 2. Prepare the Environment on Windows
Expand All @@ -22,7 +22,7 @@ Please use a python environment management tool (we recommend using Conda) to cr

#### 2.1 Install IPEX-LLM

Please see [IPEX-LLM Installation on Windows](https://bigdl.readthedocs.io/en/latest/doc/LLM/Overview/install_gpu.html#windows) for more details to install IPEX-LLM on your Client.
Please see [IPEX-LLM Installation on Windows](https://ipex-llm.readthedocs.io/en/latest/doc/LLM/Overview/install_gpu.html#windows) for more details to install IPEX-LLM on your Client.

#### 2.2 Install Other Required Dependencies

Expand Down Expand Up @@ -67,14 +67,14 @@ This share link expires in 72 hours. For free permanent hosting and GPU upgrades
##### 4.1.1 Download the Model
If you need to download a model, enter the Hugging Face username or model path, for instance: `Qwen/Qwen-7B-Chat`.

![Image text](https://github.com/intel-analytics/text-generation-webui/blob/8ebee0651dd56012c4a9e0ba6932efec4c7d1b2e/readme_folder/image.png)
![Image text](./readme_folder/image.png)

##### 4.1.2 Place the Model
After you have downloaded the model (or if you already have the model locally), please place the model in `Text-Generation-WebUI/models` directory.

After completing the two steps above, you may click the `Model` button to select your model.

![Image text](https://github.com/intel-analytics/text-generation-webui/blob/8ebee0651dd56012c4a9e0ba6932efec4c7d1b2e/readme_folder/image1.png)
![Image text](./readme_folder/image1.png)


#### 4.2 Enable IPEX-LLM Optimizations
Expand All @@ -83,7 +83,7 @@ Text-Generation-WebUI supports multiple backends, including `IPEX-LLM`, `Transfo

Then please select the device according to your device (the default device is `GPU`).

![Image text](https://github.com/intel-analytics/text-generation-webui/blob/8ebee0651dd56012c4a9e0ba6932efec4c7d1b2e/readme_folder/image2.png)
![Image text](./readme_folder/image2.png)


#### 4.3 Load Model in Low Precision
Expand All @@ -99,9 +99,9 @@ Notes:
- Please select the `optimize-model` and `use_cache` options to accelerate the model.


Now you may click the `Load` button to load the model with IPEX-LLM optimizations.
Now you may click the `Load` button to load the model with IPEX-LLM optimizations. If everything goes well, you will get a message as shown below.

![Image text](https://github.com/intel-analytics/text-generation-webui/blob/8ebee0651dd56012c4a9e0ba6932efec4c7d1b2e/readme_folder/image3.png)
![Image text](./readme_folder/image3.png)


##### 4.4 Run the Model on WebUI
Expand All @@ -128,7 +128,7 @@ Notes:

* Please see [Chat-Tab Wiki](https://github.com/oobabooga/text-generation-webui/wiki/01-%E2%80%90-Chat-Tab) for more details.

![Image text](https://github.com/intel-analytics/text-generation-webui/blob/8ebee0651dd56012c4a9e0ba6932efec4c7d1b2e/readme_folder/image4.png)
![Image text](./readme_folder/image4.png)

##### 4.4.2 Default Tab

Expand All @@ -138,7 +138,7 @@ This tab contains two main text boxes: Input, where you enter your prompt, and O

Please see [Default-Tab Wiki](https://github.com/oobabooga/text-generation-webui/wiki/02-%E2%80%90-Default-and-Notebook-Tabs#default-tab) for more details.

![Image text](https://github.com/intel-analytics/text-generation-webui/blob/8ebee0651dd56012c4a9e0ba6932efec4c7d1b2e/readme_folder/image5.png)
![Image text](./readme_folder/image5.png)


##### 4.4.3 Notebook Tab
Expand All @@ -147,4 +147,4 @@ You may use the `Notebook tab` to do exactly what the `Default tab` does, with t

Please see [Notebook-Tab Wiki](https://github.com/oobabooga/text-generation-webui/wiki/02-%E2%80%90-Default-and-Notebook-Tabs#notebook-tab) for more details.

![Image text](https://github.com/intel-analytics/text-generation-webui/blob/8ebee0651dd56012c4a9e0ba6932efec4c7d1b2e/readme_folder/image6.png)
![Image text](./readme_folder/image6.png)
Binary file modified readme_folder/image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified readme_folder/image1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified readme_folder/image2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified readme_folder/image3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8a97681

Please sign in to comment.