You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+32-25Lines changed: 32 additions & 25 deletions
Original file line number
Diff line number
Diff line change
@@ -27,13 +27,16 @@ You can select the model at the right side bar.
27
27
28
28
An internet connection is required.
29
29
30
-
## Contact
31
-
You can join pyqt-openai's <ahref="https://discord.gg/cHekprskVE">Discord Server</a> to have a conversation about it or AI-related stuff 🙂
32
-
33
-
## Note
34
-
Some of the features are still being tested.
35
-
36
-
I recommend to install sqlite management software. It's not necessary to run this app (obviously), but it's good practice to manage database about conversation history with AI and to know how this works.
30
+
## Table of Contents
31
+
*[Feature](#feature)
32
+
*[Requirements](#requirements)
33
+
*[Preview](#preview)
34
+
*[How to Install](#how-to-install)
35
+
*[Usage](#usage)
36
+
*[Troubleshooting](#troubleshooting)
37
+
*[Contact](#contact)
38
+
*[Note](#note)
39
+
*[See Also](#see-also)
37
40
38
41
## Feature
39
42
* basically this is <b>desktop application version of ChatGPT</b> with image generation tool.
@@ -45,7 +48,8 @@ I recommend to install sqlite management software. It's not necessary to run thi
45
48
* rename conversation
46
49
* everything above is saved in an SQLite database file named conv.db.
47
50
* support GPT-4 and every other models below GPT3
48
-
* support prompt generator (manageable)
51
+
* support prompt generator (manageable, autosaved in database)
52
+
* support slash commands
49
53
* support beginning and ending part of the prompt
50
54
* you can run this in background application
51
55
* notification will pop up when response is generated
@@ -77,35 +81,31 @@ This is using GPT-3.5 turbo model by default.
Again, weak preview (i just gave prompt text as "A" which is pathetic) but please consider this is very first version of sd image generation (v0.1.4) so just wait
3. You should put your api key in the line edit. You can get it in <ahref="https://platform.openai.com/account/api-keys">official site</a> of openai. Sign up and log in before you get it. <b>By the way, this is free trial, not permanently free. See <ahref="https://platform.openai.com/account/billing/overview">this</a> after you have logged in.</b>
90
+
## How to Install
91
+
1. open command propmt of your OS.
92
+
2. git clone ~
93
+
3. from the root directory, type "cd pyqt_openai"
94
+
4. pip install -r requirements.txt
95
+
5. You should put your api key in the line edit. You can get it in <ahref="https://platform.openai.com/account/api-keys">official site</a> of openai. Sign up and log in before you get it.
96
96
97
97
Be sure, this is a very important API key that belongs to you only, so you should remember it and keep it secure.
98
98
99
-
4. python main.py
99
+
6. python main.py
100
100
101
-
If installation doesn't work, check the troubleshooting below.
101
+
If installation doesn't work, you can contact me with bring up new issue in issue tab or check the troubleshooting below even it is only about very specific error.
102
102
103
103
## Troubleshooting
104
104
If you see this error while installing the openai package
105
105
```
106
106
subprocess-exited-with-error
107
107
```
108
-
you can shout a curse word and just download the package itself from <ahref="https://pypi.org/project/openai/#files">pypi</a>.
108
+
download the package itself from <ahref="https://pypi.org/project/openai/#files">pypi</a>.
109
109
110
110
Unzip it, access the package directory, type
111
111
```
@@ -114,8 +114,15 @@ python setup.py install
114
114
115
115
That will install the openai.
116
116
117
+
Note: I don't know this can happen in newer version of openai as well, so tell me if you know about something
118
+
119
+
## Contact
120
+
You can join pyqt-openai's <ahref="https://discord.gg/cHekprskVE">Discord Server</a> to have a conversation about it or AI-related stuff 🙂
121
+
122
+
## Note
123
+
I recommend to install sqlite management software. It's not necessary to run this app (obviously), but it's good practice to manage database about conversation history with AI and to know how this works.
124
+
117
125
## TODO list
118
-
* auto-complete prompt command
119
126
* DB for images (to further experiement of both DALL-E and Stable Diffusion or other image generation engine)
120
127
* show the explanation of every model and terms related to AI (e.g. temperature, topp..)
121
128
* save conversation history with other format (xlsx, csv, etc.)
0 commit comments