First Commit

README.md

@@ -11,3 +11,62 @@ license: other
 ---
 
 Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+
+# GPT-3 based Zero-shot Synonym Editor
+
+Replace words with synonyms while maintaining the original sentence structure and meaning for a given text using OpenAI GPT-3
+
+## Overview
+
+The Synonym Editor is a Python tool that uses OpenAI's GPT-3 language model to replace words in a text with synonyms while maintaining the original sentence structure. The tool can be used to edit text files, such as articles, essays, or reports, to improve their readability, diversity of language, and clarity.
+
+## Features
+
+- Replace exactly n words with a synonym in a sentence while preserving quotation marks and symbols
+- Maintain the original sentence structure and meaning of the text.
+- Use OpenAI's GPT-3 language model to ensure reliable and consistent word replacement.
+- Edit multiple paragraphs and sentences at once.
+- Save the edited text to a file.
+
+## Usage
+
+1. Clone the repository to your local machine:
+
+```
+git clone https://github.com/ashokgit/SynonymEditor
+
+```
+
+2. Install the required packages:
+
+```
+pip install -r requirements.txt
+
+```
+
+3. Set up your OpenAI API key. You can create an API key by signing up for OpenAI at . Once you have your API key, export it to your environment variables:
+
+```
+export OPENAI_API_KEY=your_api_key
+
+```
+
+4. Edit the input text file. The input file should be a plain text file with one or more paragraphs of text. You can edit the file in any text editor, such as Notepad, Sublime Text, or Vim.
+5. Run the Synonym Editor with the input and output file paths:
+
+```
+python app.py input.txt output.txt
+
+```
+
+Replace `input.txt` with the path to your input file and `output.txt` with the path to your output file. The Synonym Editor will read the input file, replace words with synonyms using OpenAI's GPT-3 model, and save the edited text to the output file.
+
+6. Check the output file for any errors or issues. You can open the file in any text editor to view the edited text.
+
+## License
+
+The Synonym Editor is licensed under the MIT License. See the `LICENSE` file for more information.
+
+## Acknowledgments
+
+- This project uses the [OpenAI API](https://beta.openai.com/docs/api-reference/introduction) to perform language tasks.

SynonymEditor.py

@@ -0,0 +1,78 @@
+import openai
+from nltk import sent_tokenize
+import re
+
+
+class SynonymEditor:
+
+    def __init__(self, api_key, model_engine, max_tokens):
+        openai.api_key = api_key
+        self.model_engine = model_engine
+        self.max_tokens = max_tokens
+
+    # Play with the prompts here and change the return index to change and see the effect of the prompt on the output quality
+    # Note that the longer the prompt, higher the token used and hence the billing
+    def _get_prompt(self, sentence):
+        if "__QUOTE__" in sentence:
+            return "Replace exactly one word with a synonym while preserving __QUOTE__ in the following sentence:\n"+sentence+"\n"
+        else:
+            return "Replace exactly one word with a synonym in the following sentence:\n"+sentence+"\n"
+
+    # Call the OpenAI API here
+
+    def __call_ai(self, sentence):
+        prompt = self._get_prompt(sentence)
+        response = openai.Completion.create(
+            model=self.model_engine,
+            prompt=prompt,
+            temperature=0.6,
+            max_tokens=self.max_tokens,
+            top_p=1,
+            frequency_penalty=0,
+            presence_penalty=0
+        )
+        return self._post_process_sentence(response.choices[0].text.strip())
+
+    # Split the paragraph to preserve quotation marks
+    def _split_into_sentences(self, text):
+        text = text.replace('"', '__QUOTE__')
+        text = re.sub(r'\s+', ' ', text)
+        text = text.strip()
+        sentences = sent_tokenize(text)
+        return sentences
+
+    def _post_process_sentence(self, text):
+        return text.replace('__QUOTE__', '"')
+
+    # Preprocess the text, perform edit task and join back to get the original format
+    def _edit_text(self, text):
+        edited_text = ""
+        paragraphs = text.split("\n\n")
+        edited_paragraphs = []
+        for paragraph in paragraphs:
+            sentences = self._split_into_sentences(paragraph)
+            edited_sentences = []
+            for sentence in sentences:
+                new_sentence = self.__call_ai(sentence)
+                edited_sentences.append(new_sentence)
+
+            # join edited sentences to form an edited paragraph
+            edited_paragraph = ' '.join(edited_sentences)
+            edited_paragraphs.append(edited_paragraph)
+
+        # join edited paragraphs to form edited text
+        edited_text = '\n\n'.join(edited_paragraphs)
+
+        return edited_text
+
+    # File Read Write operation
+    def edit_file(self, input_file, output_file):
+        print("Opening File")
+        with open(input_file, "r", encoding="utf8", errors="ignore") as f:
+            text = f.read()
+        print("Editing")
+        edited_text = self._edit_text(text)
+        print("Finishing up")
+        with open(output_file, "w") as f:
+            f.write(edited_text)
+        print("Done!")

app.py

@@ -0,0 +1,21 @@
+import gradio as gr
+from SynonymEditor import SynonymEditor
+
+
+def replace_synonyms(api_key, text):
+    model_engine = "text-davinci-003"
+    max_tokens = 500
+    editor = SynonymEditor(api_key, model_engine, max_tokens)
+    return editor._edit_text(text)
+
+
+api_key = gr.inputs.Textbox(label="API Key", lines=1, default="")
+
+input_text = gr.inputs.Textbox(
+    label="Input Text", lines=10, default="Enter your text here.")
+
+output_text = gr.outputs.Textbox(label="Output Text")
+
+io = gr.Interface(fn=replace_synonyms, inputs=[api_key, input_text], outputs=output_text, title="Synonym Replacer",
+                  description="Replace words in a text with their synonyms.", server_port=8080)
+io.launch()

requirements.txt

@@ -0,0 +1,3 @@
+nltk==3.8.1
+openai==0.26.5
+gradio==3.19.1

terminal.py

@@ -0,0 +1,20 @@
+import sys
+from SynonymEditor import SynonymEditor
+
+api_key = "YOUR_API_KEY_HERE"
+model_engine = "text-davinci-003"
+max_tokens = 500
+
+# Check if command line arguments are provided
+if len(sys.argv) < 3:
+    print("Usage: python3 app.py input.txt output.txt")
+    sys.exit()
+
+# Get command line arguments
+input_file = sys.argv[1]
+output_file = sys.argv[2]
+
+# Create synonym editor
+editor = SynonymEditor(api_key, model_engine, max_tokens)
+
+editor.edit_file(input_file, output_file)