diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..e62d424 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1 @@ +ko_fi: turboderp \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..6802bc4 --- /dev/null +++ b/LICENSE @@ -0,0 +1,19 @@ +MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..9c195c1 --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +
+ +# ExUI + +This is a simple, lightweight web interface for [ExLlamaV2](https://github.com/turboderp/exllamav2). + +### Overview of features + +- Friendly, responsive and minimalistic UI +- Persistent sessions +- Multiple instruct formats +- Speculative decoding +- Supports EXL2, GPTQ and FP16 models + +### Screenshots + +[](doc/screenshot1.png) +[](doc/screenshot2.png) + +### Running locally + +First, clone this repository and install requirements: + +``` +git clone https://github.com/turboderp/exui +cd exui +pip install -r requirements.txt +``` + +Then run the web server with the included server.py: + +``` +python server.py +``` + +Your browser should automatically open on `localhost:5000` + +### More to come + +Stay tuned. + + + + diff --git a/doc/icon.png b/doc/icon.png deleted file mode 100644 index 5a37502..0000000 Binary files a/doc/icon.png and /dev/null differ diff --git a/doc/screenshot1.png b/doc/screenshot1.png new file mode 100644 index 0000000..bfae5d4 Binary files /dev/null and b/doc/screenshot1.png differ diff --git a/doc/screenshot1_thumb.png b/doc/screenshot1_thumb.png new file mode 100644 index 0000000..536b0c1 Binary files /dev/null and b/doc/screenshot1_thumb.png differ diff --git a/doc/screenshot2.png b/doc/screenshot2.png new file mode 100644 index 0000000..aeb8d4e Binary files /dev/null and b/doc/screenshot2.png differ diff --git a/doc/screenshot2_thumb.png b/doc/screenshot2_thumb.png new file mode 100644 index 0000000..ff60ae7 Binary files /dev/null and b/doc/screenshot2_thumb.png differ