8000 Update README.md · ag-python-qt/pyqt-openai@f91a3b6 · GitHub
[go: up one dir, main page]

Skip to content

Commit f91a3b6

Browse files
authored
Update README.md
1 parent 8cec537 commit f91a3b6

File tree

1 file changed

+29
-13
lines changed

1 file changed

+29
-13
lines changed

README.md

Lines changed: 29 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88

99
</div>
1010

11-
1211
Example of using OpenAI with PyQt (Python cross-platform GUI toolkit)
1312

1413
This shows an example of using OpenAI with PyQt as a chatbot and using DALL-E or Stable Diffusion as a image generation tool.
@@ -21,24 +20,26 @@ If you want to study openai with Python-only good old desktop software, this is
2120

2221
The OpenAI model this package uses is the <a href="https://platform.openai.com/docs/models/gpt-3-5">gpt-3.5-turbo</a> model(which is nearly as functional as <b>ChatGPT</b>) by default. You can use gpt-4 as well.
2322

24-
Latest model such as gpt-3.5-turbo-0613 is also available
25-
26-
Image generation feature(DALL-E and Stable Diffusion) available since v0.1.4.
23+
Image generation feature(DALL-E and Stable Diffusion) is also available.
2724

2825
<b>Stable Diffusion</b> used [DreamStudio API](https://dreamstudio.ai/). This is not entirely free like stable-diffusion-webgui.
2926

3027
But this is very lightweight and more accessible. don't need CUDA, torch, expansive PC, anything.
3128

3229
This is using <b>sqlite</b> as a database.
3330

34-
You can select the model at the right side bar.
31+
You can select the model and change each parameters of openai from the right side bar.
32+
33+
Also you can combine openai with llama-index feature to make gpt model answer your question based on information you had provided!
3534

3635
An internet connection is required.
3736

37+
If you have any questions or you want to make AI related software with PyQt or PySide, feel free to join Discord server of pyqt-openai.
38+
3839
## Table of Contents
3940
* [Feature](#feature)
4041
* [Requirements](#requirements)
41-
* [Preview & Usage](#preview-usage)
42+
* [Preview and Usage](#preview-and-usage)
4243
* [How to Install](#how-to-install)
4344
* [Troubleshooting](#troubleshooting)
4445
* [Contact](#contact)
@@ -50,20 +51,22 @@ An internet connection is required.
5051
* text streaming (enable by default, you can disable it)
5152
* AI remembers past conversation
5253
* support copy button
53-
* conversation management
54+
* <b>conversation management</b>
5455
* add & delete conversations
5556
* save conversations - SQlite db, text files compressed file, html files compressed file (both are zip)
5657
* rename conversation
5758
* everything above is saved in an SQLite database file named conv.db.
58-
* support GPT-4 and every other models below GPT3
59-
* support prompt generator (manageable, autosaved in database)
60-
* support slash commands
59+
* support controlling parameters(temperature, top_p, etc) just like openai playground
60+
* support latest model such as <b>GPT-4-32k-0613</b>
61+
* support <b>prompt generator</b> (manageable, autosaved in database)
62+
* support <b>slash commands</b>
6163
* support beginning and ending part of the prompt
62-
* you can run this in background application
64+
* you can <b>run this in background</b> application
6365
* notification will pop up when response is generated
6466
* you can make window stack on top or control its transparency
6567
* image generation (DALL-E, Stable Diffusion with DreamStudio API)
6668
* you can copy and download the image if you want. just hover the mouse cursor over the image.
69+
* you can <b>fine-tune</b> openai with llama-index.
6770

6871
## Requirements
6972
* qtpy - the package allowing you to write code that works with both PyQt and PySide
@@ -73,8 +76,11 @@ An internet connection is required.
7376
* pyperclip - to copy prompt text from prompt generator
7477
* stability_sdk - for Stable Diffusion
7578
* jinja2 - for saving the conversation with html file
79+
* llama-index - to fine-tune
80+
81+
## Preview and Usage
82+
#### Note: A lot of previews below are not from latest version. It is slightly different with current GUI. So if you want to really know what this looks like, you can just see it for yourself :)
7683

77-
## Preview & Usage
7884
### Overview
7985
#### Windows
8086
![image](https://github.com/yjg30737/pyqt-openai/assets/55078043/51667298-2c3f-4846-a8c9-ec56331b8361)
@@ -87,7 +93,17 @@ You can change screen between text chatbot and image generating tool screen.
8793
#### Linux (Ubuntu)
8894
![image](https://github.com/yjg30737/pyqt-openai/assets/55078043/4005c085-53f4-406f-adb0-4fb4d87d88ba)
8995

90-
If you use MacOS, please give me the pyqt-openai screen image from it.
96+
#### MacOS
97+
![image](https://github.com/yjg30737/pyqt-openai/assets/55078043/4fec8f14-3768-49e8-9ad6-a4fbf240e643)
98+
99+
Thanks to Werranton, who gave me the pyqt-openai window example image from macOS :)
100+
101+
(He has changed the pyqt-openai's overall theme personally)
102+
103+
### Using LlamaIndex
104+
![image](https://github.com/yjg30737/pyqt-openai/assets/55078043/e161b551-91dc-4c4d-8a33-28179d72fb64)
105+
106+
If you want to use this with your personal chatbot based on data you've given, then you can check the llamaindex checkbox and go to the tab, select the directory which includes .txt files containing the data.
91107

92108
### Conversation
93109
#### Preview 1

0 commit comments

Comments
 (0)
0