summaryrefslogtreecommitdiffstats
path: root/gui/README.md
diff options
context:
space:
mode:
authort.me/xtekky <98614666+xtekky@users.noreply.github.com>2023-06-24 03:47:00 +0200
committert.me/xtekky <98614666+xtekky@users.noreply.github.com>2023-06-24 03:47:00 +0200
commit5db58fd87f230fbe5bae599bb4b120ab42cad3be (patch)
tree770be13bca77c5d04dfe3265f378431df788706f /gui/README.md
parentMerge pull request #664 from LopeKinz/main (diff)
downloadgpt4free-5db58fd87f230fbe5bae599bb4b120ab42cad3be.tar
gpt4free-5db58fd87f230fbe5bae599bb4b120ab42cad3be.tar.gz
gpt4free-5db58fd87f230fbe5bae599bb4b120ab42cad3be.tar.bz2
gpt4free-5db58fd87f230fbe5bae599bb4b120ab42cad3be.tar.lz
gpt4free-5db58fd87f230fbe5bae599bb4b120ab42cad3be.tar.xz
gpt4free-5db58fd87f230fbe5bae599bb4b120ab42cad3be.tar.zst
gpt4free-5db58fd87f230fbe5bae599bb4b120ab42cad3be.zip
Diffstat (limited to 'gui/README.md')
-rw-r--r--gui/README.md78
1 files changed, 0 insertions, 78 deletions
diff --git a/gui/README.md b/gui/README.md
deleted file mode 100644
index c0406216..00000000
--- a/gui/README.md
+++ /dev/null
@@ -1,78 +0,0 @@
-# gpt4free gui
-
-This code provides a Graphical User Interface (GUI) for gpt4free. Users can ask questions and get answers from GPT-4 API's, utilizing multiple API implementations. The project contains two different Streamlit applications: `streamlit_app.py` and `streamlit_chat_app.py`.
-
-In addition, a new GUI script specifically implemented using PyWebIO has been added and can be found in the pywebio-gui folder. If there are errors with the Streamlit version, you can try using the PyWebIO version instead
-
-Installation
-------------
-
-1. Clone the repository.
-2. Install the required dependencies with: `pip install -r requirements.txt`.
-3. To use `streamlit_chat_app.py`, note that it depends on a pull request (PR #24) from the https://github.com/AI-Yash/st-chat/ repository, which may change in the future. The current dependency library can be found at https://github.com/AI-Yash/st-chat/archive/refs/pull/24/head.zip.
-
-Analytics Disclaimer
------
-The streamlit browser app collects heavy analytics even when running locally. This includes events for every page load, form submission including metadata on queries (like length), browser and client information including host ips. These are all transmitted to a 3rd party analytics group, Segment.com.
-
-Usage
------
-
-Choose one of the Streamlit applications to run:
-
-### streamlit\_app.py
-
-This application provides a simple interface for asking GPT-4 questions and receiving answers.
-
-To run the application:
-
-run:
-```arduino
-streamlit run gui/streamlit_app.py
-```
-<br>
-
-<img width="724" alt="image" src="https://user-images.githubusercontent.com/98614666/234232449-0d5cd092-a29d-4759-8197-e00ba712cb1a.png">
-
-<br>
-<br>
-
-preview:
-
-<img width="1125" alt="image" src="https://user-images.githubusercontent.com/98614666/234232398-09e9d3c5-08e6-4b8a-b4f2-0666e9790c7d.png">
-
-
-### streamlit\_chat\_app.py
-
-This application provides a chat-like interface for asking GPT-4 questions and receiving answers. It supports multiple query methods, and users can select the desired API for their queries. The application also maintains a conversation history.
-
-To run the application:
-
-```arduino
-streamlit run streamlit_chat_app.py
-```
-
-<br>
-
-<img width="724" alt="image" src="image1.png">
-
-<br>
-<br>
-
-preview:
-
-<img width="1125" alt="image" src="image2.png">
-
-Contributing
-------------
-
-Feel free to submit pull requests, report bugs, or request new features by opening issues on the GitHub repository.
-
-Bug
-----
-There is a bug in `streamlit_chat_app.py` right now that I haven't pinpointed yet, probably is really simple but havent had the time to look for it. Whenever you open a new conversation or access an old conversation it will only start prompt-answering after the second time you input to the text input, other than that, everything else seems to work accordingly.
-
-License
--------
-
-This project is licensed under the MIT License.