From 33d2fdcf8b739beffa2b9a9067c372f85642b828 Mon Sep 17 00:00:00 2001 From: Pakobbix Date: Sat, 13 May 2023 16:22:10 +0200 Subject: [PATCH] Update README.md Added an Disclaimer to the Readme. --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cdc2140..91535d4 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ # WebUI StartGUI +## Disclaimer +As someone who isn't a professional programmer, I enjoy experimenting and finding ways to simplify my workflow. This GUI was created to make it easier for me to adjust parameters and save them for future use, without constantly modifying the webui.py or managing multiple scripts. While I'm glad to share this script with others, please understand that my expertise in maintaining it might be limited. Nonetheless, I hope it proves helpful to you, and I appreciate your understanding. + ## Description WebUI StartGUI is a Python graphical user interface (GUI) written with PyQT5, that allows users to configure settings and start the oobabooga web user interface (WebUI). It provides a convenient way to adjust various parameters and launch the WebUI with the desired settings. @@ -7,7 +10,7 @@ WebUI StartGUI is a Python graphical user interface (GUI) written with PyQT5, th - Select a model from a dropdown menu - Choose wbits and groupsize options - Select the operating mode (chat, cai-chat, notebook) -- Enable/disable GPU usage and set GPU VRAM (Only for Nvidia Right now, will detect if multiple GPU's are Present) +- Enable/disable GPU usage and set GPU VRAM (Only for Nvidia Right now, will automatically detect if multiple GPU's are Present) - Adjust pre-layer value - Load the model with 8-bit precision - Enable authentication and choose an authentication file @@ -30,6 +33,11 @@ WebUI StartGUI is a Python graphical user interface (GUI) written with PyQT5, th ## Binary Download Binary releases of this script can be found in the [Releases](https://github.com/Pakobbix/StartUI-oobabooga-webui/releases) section of this repository. +## Screenshots +![Screenshot 2023-05-13 151352](https://github.com/Pakobbix/StartUI-oobabooga-webui/assets/6762686/bb0da8ad-1f1f-438c-b5ac-4fa21fa02b7a) +![Screenshot 2023-05-13 151446](https://github.com/Pakobbix/StartUI-oobabooga-webui/assets/6762686/2fae0fad-bf0c-410d-8c49-1f79557c53c3) + + ## Credits StartGUI is developed and maintained by [Pakobbix](https://github.com/Pakobbix). It is based on the [PyQt5](https://pypi.org/project/PyQt5/) library and uses [gpustat](https://pypi.org/project/gpustat/) for GPU information.