diff --git a/README.md b/README.md index feb932f..9e784bf 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,34 @@ -# StartUI-oobabooga-webui +# WebUI StartGUI + +## 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. + +## Current Features +- 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) +- Adjust pre-layer value +- Load the model with 8-bit precision +- Enable authentication and choose an authentication file +- Choose extensions for the WebUI +- Enable local network mode and specify the listen port +- Automatically open the browser when loading is finished +- Save settings to a profile +- Load profiles via Dropdown menu. + +## How to Use +1. Clone the repository or download the source code. +2. Install the required dependencies listed in the `requirements.txt` file. (PyQT5 & gpustat) +3. Run the `StartUI.py` script using Python `python3 StartUI.py`. +4. Configure the desired settings using the GUI elements. +5. Click the "Save Settings" button to save the current settings to a profile. +6. Click the "Load" button to load and apply settings from a saved profile. +7. Click the "Start" button to launch the WebUI with the selected settings. + + +## Binary Download +Binary releases of this script can be found in the [Releases](https://github.com/your-username/your-repository/releases) section of this repository. + +## Credits +StartGUI is developed and maintained by [Henry Hofmann](https://github.com/your-username). It is based on the [PyQt5](https://pypi.org/project/PyQt5/) library and uses [gpustat](https://pypi.org/project/gpustat/) for GPU information.