Skip to content

Commit

Permalink
[docs] Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
happycod3r committed Jul 28, 2023
1 parent bfb182e commit 38b01f7
Show file tree
Hide file tree
Showing 10 changed files with 77 additions and 1 deletion.
Binary file modified __pycache__/cli.cpython-311.pyc
Binary file not shown.
1 change: 1 addition & 0 deletions cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -560,6 +560,7 @@ def requestData(self) -> None:

#//////////// AUDIO ////////////
elif self.request_type == 2:
print("Here!")
_audio_file = open(self.audio_file, "rb")
_response = openai.Audio.transcribe(
self.engine, # "whisper-1",
Expand Down
Binary file modified ctrls/__pycache__/image_form.cpython-311.pyc
Binary file not shown.
Binary file modified ctrls/__pycache__/image_view.cpython-311.pyc
Binary file not shown.
2 changes: 1 addition & 1 deletion ctrls/image_view.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ def __init__(self):
self.IMG_URL = self.getImageURL()

self.img = ctk.CTkImage(light_image=None, dark_image=self.loadImageFromUrl(), size=(400, 400))
self._label = ctk.CTkLabel(self, image=self.img, text=" ")
self._label = ctk.CTkLabel(self, image=self.img, text=None)
self._label.grid(row=0, column=0)
self._label.configure(width=400, height=400)

Expand Down
75 changes: 75 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,19 @@
- [OpenAI API Key](#openai-api-key)
- [Running WinGTP](#running-wingtp)
- [python](#python)
- [Examples](#examples)
- [Chat](#chat)
- [Images](#images)
- [Transcriptions](#transcriptions)
- [Translations](#translations)
- [Embeddings](#embeddings)
- [Fine Tuning](#fine-tuning)
- [Moderations](#moderations)
- [Sentement Analysis](#sentement-analysis)
- [Q&A](#qa)
- [Code Generation](#code-generation)
- [Edits](#edits)
- [Summarization](#summarization)
- [Contributing](#contributing)
- [Security](#security)
- [Reporting a vulnerability or bug?](#reporting-a-vulnerability-or-bug)
Expand Down Expand Up @@ -216,6 +229,68 @@ username.

The following are examples of some of the main features mentioned in the [About](#about) section.

### [Usage Examples](#examples)

#### [Chat](#chat)

Type anything into the input box below the output and get an immediate response.
You can also try changing settings such as the `response token limit` or the `chat output temperature`
to change the response parameters.

![Chat Example](./res/chat-example1.gif)

#### [Images](#images)

You can either generate new images, edit an existing image or create variations
of an image.

- First select the `Images` request type from the `Request Types` section
- Once selected the image settings will open in the top right section in place of the `Chat Output Temperature`
section. These setings allow you to pick an image size and open existing images and or masks.
- Lastly press the `Send` button to get the url of the image.

You can type anything you want to create a new image. After pressing the `Send` button
it may take a second to get the url as you can see in this example. This is due to OpenAI
and theres not much I can do about it. As for WinGTP hanging when waiting for a
response, I will be working out a solution to this.

![Image Example](./res/image-new-example.gif)

When you are done creating the image you can either copy the url or view the image from within WinGTP.

![Show Image](./res/show-image-example.gif)

#### [Transcriptions](#transcriptions)

You can also create audio transcriptions in the same manner as images. Remember to pick the
correct model for each reuest type otherwise you won't get a response. For audio transcriptions
you can use `whisper-1`.

- First select `Audio` from the list in the `Request Types` section.
- Next press the `Choose Audio File` button to open the audio file you want to
transcribe.
- Once you have chosen a valid audio file press the `Transcribe` button.

![Audio Transcription](./res/audio-transcript-eample1.gif)

#### [Translations](#translations)

#### [Embeddings](#embeddings)

#### [Fine Tuning](#fine-tuning)

#### [Moderations](#moderations)

#### [Sentement Analysis](#sentement-analysis)

#### [Q&A](#qa)

#### [Code Generation](#code-generation)

#### [Edits](#edits)

#### [Summarization](#summarization)

## [Contributing](#contributing)

If you have any feature requests, suggestions or general questions you can reach me via any of the
Expand Down
Binary file added docs/res/audio-transcript-eample1.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/res/chat-example1.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/res/image-new-example.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/res/show-image-example.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 38b01f7

Please sign in to comment.