ExternalVendorCode/lollms-webui
1
0
Fork 0
mirror of https://github.com/ParisNeo/lollms-webui.git synced 2025-02-20 09:16:15 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

more changes and reordering

Browse Source
This commit is contained in:
andzejsp 2023-04-15 14:55:44 +03:00
parent de7caeaf0b
commit b67c726823
1 changed files with 21 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
README.md
View File

@ -6,11 +6,11 @@
![GitHub forks](https://img.shields.io/github/forks/nomic-ai/GPT4All-ui)
[![Discord](https://img.shields.io/discord/1092918764925882418?color=7289da&label=Discord&logo=discord&logoColor=ffffff)](https://discord.gg/DZ4wsgg4)
This is a Flask web application that provides a chat UI for interacting with llamacpp based chatbots such as GPT4all, vicuna etc...
This is a Flask web application that provides a chat UI for interacting with [llamacpp](https://github.com/ggerganov/llama.cpp) based chatbots such as [GPT4all](https://github.com/nomic-ai/gpt4all), vicuna etc...
Follow us on our [Discord server](https://discord.gg/DZ4wsgg4).
## What is GPT4All ?
![image](https://user-images.githubusercontent.com/827993/231911545-750c8293-58e4-4fac-8b34-f5c0d57a2f7d.png)
GPT4All is an exceptional language model, designed and developed by Nomic-AI, a proficient company dedicated to natural language processing. The app uses Nomic-AI's advanced library to communicate with the cutting-edge GPT4All model, which operates locally on the user's PC, ensuring seamless and efficient communication.
@ -19,24 +19,11 @@ If you are interested in learning more about this groundbreaking project, visit
One of the app's impressive features is that it allows users to send messages to the chatbot and receive instantaneous responses in real-time, ensuring a seamless user experience. Additionally, the app facilitates the exportation of the entire chat history in either text or JSON format, providing greater flexibility to the users.
It's worth noting that the model has recently been launched, and it's expected to evolve over time, enabling it to become even better in the future. This webui is designed to provide the community with easy and fully localized access to a chatbot that will continue to improve and adapt over time.
## UI screenshot
### MAIN page
![image](https://user-images.githubusercontent.com/827993/231911545-750c8293-58e4-4fac-8b34-f5c0d57a2f7d.png)
### Settings page
![image](https://user-images.githubusercontent.com/827993/231912018-4e69e0c3-cbef-4dc8-81b3-d977d96cc7de.png)
### Extensions page
The extensions interface is not yet ready but once it will be, any one may build its own plugins and share them with the community.
![image](https://user-images.githubusercontent.com/827993/231809762-0dd8127e-0cab-4310-9df3-d1cff89cf589.png)
### Training page
This page is not yet ready, but it will eventually be released to allow you to fine tune your own model and share it if you want
![image](https://user-images.githubusercontent.com/827993/231810125-b39c0672-f748-4311-9523-9b27b8a89dfe.png)
# Features
- Chat with AI
- Create, edit, and share personality
- Audio in and audio out with many options for language and voices (Chromuim web browsers only)
- Chat with locally hosted AI inside a web browser
- Create, edit, and share your AI's personality
- Audio in and audio out with many options for language and voices (only Chrome web browser is supported at this time)
- History of discussion with resume functionality
- Add new discussion, rename discussion, remove discussion
- Export database to json format
@ -181,13 +168,14 @@ Now you're ready to work!
# Supported models
You can also refuse to download the model during the install procedure and download it manually.
## For now we support ggml models that work out of the box (tested on Windows 11 and Ubuntu 22.04.2) such as :
**For now we support ggml models that work out of the box (tested on Windows 11 and Ubuntu 22.04.2) such as:**
- [GPT4ALL 7B](https://huggingface.co/ParisNeo/GPT4All/resolve/main/gpt4all-lora-quantized-ggml.bin)
- [Vicuna 7B rev 1](https://huggingface.co/eachadea/legacy-ggml-vicuna-7b-4bit/resolve/main/ggml-vicuna-7b-4bit-rev1.bin)
- [Vicuna 13B rev 1](https://huggingface.co/eachadea/ggml-vicuna-13b-4bit/resolve/main/ggml-vicuna-13b-4bit-rev1.bin)
## These models dont work out of the box and need to be converted to the right ggml type:
**These models dont work out of the box and need to be converted to the right ggml type:**
- [Vicuna 7B](https://huggingface.co/eachadea/legacy-ggml-vicuna-7b-4bit/resolve/main/ggml-vicuna-7b-4bit.bin)
- [Vicuna 13B q4 v0](https://huggingface.co/eachadea/ggml-vicuna-13b-1.1/resolve/main/ggml-vicuna-13b-1.1-q4_0.bin)
@ -196,6 +184,16 @@ You can also refuse to download the model during the install procedure and downl
Just download the model into the `models` folder and start using the tool.
# Build custom personalities and share them
To build a new personality, create a new file with the name of the personality inside the `personalities` folder. You can look at `gpt4all_chatbot.yaml` file as an example. Then you can fill the fields with the description, the conditionning etc of your personality. Then save the file.
You can launch the application using the personality in two ways:
- Either you want to change it permanently by putting the name of the personality inside your configuration file
- Or just use the `--personality` or `-p` option to give the personality name to be used.
If you deem your personality worthy of sharing, you can share the personality by adding it to the [GPT4all personalities](https://github.com/ParisNeo/GPT4All_Personalities) repository. Just fork the repo, add your file and do a pull request.
# Advanced Usage
If you want more control on your launch, you can activate your environment:
@ -242,26 +240,14 @@ Make sure to adjust the default values and descriptions of the options to match
# Update application To latest version
On windows use:
On windows run:
```bash
update.bat
```
On linux or macos use:
On linux or macos run:
```bash
bash update.sh
```
# Build custom personalities and share them
To build a new personality, create a new file with the name of the personality inside the personalities folder. You can look at `gpt4all_chatbot.yaml` file as an example. Then you can fill the fields with the description, the conditionning etc of your personality. Then save the file.
You can launch the application using the personality in two ways:
- Either you want to change it permanently by putting the name of the personality inside your configuration file
- Or just use the `--personality` or `-p` option to give the personality name to be used.
If you deem your personality worthy of sharing, you can share the personality by adding it to the [GPT4all personalities](https://github.com/ParisNeo/GPT4All_Personalities) repository. Just fork the repo, add your file and do a pull request.
# Contribute
This is an open-source project by the community for the community. Our chatbot is a UI wrapper for Nomic AI's model, which enables natural language processing and machine learning capabilities.
@ -291,7 +277,7 @@ We will review your pull request as soon as possible and provide feedback on any
Please note that all contributions are subject to review and approval by our project maintainers. We reserve the right to reject any contribution that does not align with our project goals or standards.
## Future Plans
# Future Plans
Here are some of the future plans for this project: