├── .devcontainer
    └── devcontainer.json
├── .gitignore
├── LICENSE
├── README.md
├── achademio.py
├── figures
    ├── bullet-point-example.png
    ├── correct-text-example.png
    ├── main-example.png
    ├── rewrite-example.png
    └── update-rewriting.png
└── requirements.txt


/.devcontainer/devcontainer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "Python 3",
 3 |   // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
 4 |   "image": "mcr.microsoft.com/devcontainers/python:1-3.11-bullseye",
 5 |   "customizations": {
 6 |     "codespaces": {
 7 |       "openFiles": [
 8 |         "README.md",
 9 |         "achademio.py"
10 |       ]
11 |     },
12 |     "vscode": {
13 |       "settings": {},
14 |       "extensions": [
15 |         "ms-python.python",
16 |         "ms-python.vscode-pylance"
17 |       ]
18 |     }
19 |   },
20 |   "updateContentCommand": "[ -f packages.txt ] && sudo apt update && sudo apt upgrade -y && sudo xargs apt install -y <packages.txt; [ -f requirements.txt ] && pip3 install --user -r requirements.txt; pip3 install --user streamlit; echo '✅ Packages installed and Requirements met'",
21 |   "postAttachCommand": {
22 |     "server": "streamlit run achademio.py --server.enableCORS false --server.enableXsrfProtection false"
23 |   },
24 |   "portsAttributes": {
25 |     "8501": {
26 |       "label": "Application",
27 |       "onAutoForward": "openPreview"
28 |     }
29 |   },
30 |   "forwardPorts": [
31 |     8501
32 |   ]
33 | }


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | /API_key
2 | /code_to_show_previous_messages.py
3 | .bashrc
4 | .streamlit/secrets.toml
5 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2023 Taja Kuzman
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Achademio - an AI-based assistant for improving your research papers
 2 | 
 3 | ![](figures/main-example.png)
 4 | 
 5 | AI assistant, based on the GPT-3.5 model by OpenAI, is designed to enhance your proficiency in writing research papers. It allows you to adapt your content to academic standards, transform bullet points into eloquent text, or enhance the quality of your writing through error detection.
 6 | 
 7 | Clone the repository and run it with python and streamlit module, or deploy it for your personal use to [Streamlit Community Cloud](https://streamlit.io/cloud). 
 8 | 
 9 | The web interface offers a range of functionalities, empowering you to accomplish the following:
10 | - **Academic Style Rewriting**: you can conveniently invoke the assistant to improve the style of your text by rewriting it in an academic style. Simply execute the program by pressing CTRL+Enter.
11 | - **Academic Paragraph Generation**: By selecting this option from the drop-down menu, you can effortlessly convert your bullet point lists into cohesive academic paragraphs. 
12 | - **Proofreading**: By selecting this option from the drop-down menu, you invoke the AI assistant to identify and highlight potential errors, enabling you to rectify and refine their work.
13 | 
14 | The model has a limitation of how many words it can process at once. Therefore, it is advisable to input shorter text sequences at a time to optimize its performance.
15 | 
16 | This program requires an OpenAPI key and some basic programming skills (to install the Streamlit python library and execute the program through the command line.) More detailed instructions for setup and utilization are provided below.
17 | 
18 | Let me know via an Issue if you would like to have any other functionalities!
19 | 
20 | ## Update
21 | 
22 | The rewritten text now includes information on what has changed for easier implementation of changes:
23 | 
24 | ![](figures/update-rewriting.png)
25 | 
26 | 
27 | ## Examples
28 | 
29 | **Academic Style Rewriting**
30 | 
31 | ![](figures/rewrite-example.png)
32 | 
33 | **Academic Paragraph Generation**
34 | 
35 | ![](figures/bullet-point-example.png)
36 | 
37 | **Proofreading**
38 | ![](figures/correct-text-example.png)
39 | 
40 | ## Use
41 | 
42 | 1. Clone this repository.
43 | 2. Install streamlit: `pip install streamlit install pip-run --user`, and openai: `pip install openai`, and redlines `pip install redlines`
44 | 3. Create an OpenAI account to get a API key (see https://elephas.app/blog/how-to-create-openai-api-keys-cl5c4f21d281431po7k8fgyol0). Save the API key in line 5 of `achademio.py` or in a separate file *secrets.toml* in a *.streamlit* folder (path: \.streamlit\secrets.toml): `API_KEY = "[your-key]"` (make sure that you do not share it with anyone).
45 | 4. Run the streamlit python script in the command line with the following command: `python -m streamlit run achademio.py`. A website will open in your browser where you can use the Achademio bot to improve your academic texts.
46 | 5. Or deploy the streamlit app to Streamlit Cloud Community: follow the [instructions here](https://blog.streamlit.io/host-your-streamlit-app-for-free/#:~:text=Connect%20your%20account%20to%20GitHub,-There%20are%20two&text=On%20the%20authorization%20page%2C%20click%20on%20%E2%80%9CAuthorize%20streamlit.%22&text=This%20will%20let%20Community%20Cloud,%2C%20click%20%E2%80%9CAuthorize%20streamlit.%22&text=Now%20you're%20ready%20to%20deploy%20Streamlit%20apps!).
47 | 
48 | ## Costs
49 | 
50 | New users of the OpenAPI key are granted a complimentary $18 credit, so the initial utilization of the model comes at no expense to you. After this amount is spent, the usage of the program is based on the cost of GPT-3.5 model, which is $0.0015/1K tokens for input and $0.002/1K tokens for model's output. You can track your expenses in the `Manage account` menu item under `Personal` at https://platform.openai.com/. The costs are very affordable: if you would input to the AI assistant 1,000 words (approximately 2 pages), the total expense would amount to less than $4.
51 | 
52 | ## Please note
53 | 
54 | Please note that the results are based on a generative language model and require careful consideration before being used -- make sure to read all outputs carefully and use common sense when making use of them. If your initial text is hard to understand or contains many errors, the model might interpret the text incorrectly, so always check whether your statement still holds. It could also happen that the generated text would omit negation and by that change the meaning of the sentence, so make sure to check the output before using it.
55 | 
56 | The assistant should be used for improving the style of the text that you have written by yourself and verified facts based on trusted sources, and not for generating new statements (please consider that big blocks of generated text might come from a published work and using them without citing the work would be plagiarism).
57 | 
58 | ## License
59 | 
60 | MIT License
61 | 
62 | Copyright (c) 2023 Taja Kuzman
63 | 
64 | Permission is hereby granted, free of charge, to any person obtaining a copy
65 | of this software and associated documentation files (the "Software"), to deal
66 | in the Software without restriction, including without limitation the rights
67 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
68 | copies of the Software, and to permit persons to whom the Software is
69 | furnished to do so, subject to the following conditions:
70 | 
71 | The above copyright notice and this permission notice shall be included in all
72 | copies or substantial portions of the Software.
73 | 
74 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
75 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
76 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
77 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
78 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
79 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
80 | SOFTWARE.
81 | 


--------------------------------------------------------------------------------
/achademio.py:
--------------------------------------------------------------------------------
  1 | import streamlit as st
  2 | import openai
  3 | from redlines import Redlines
  4 | 
  5 | #openai.api_key = open("API_key", "r").read()
  6 | openai.api_key = st.secrets["API_KEY"]
  7 | 
  8 | 
  9 | def send_click():
 10 |     if st.session_state.user != '':
 11 |         prompt = st.session_state.user
 12 | 
 13 |         # Define the bot role:
 14 |         bot_role = "You are AChatdemio, a bot that helps young researchers to write better research papers. You respond in a concise and academic style. Write short sentences, so that they are clear."
 15 | 
 16 |         # Define the ChatGPT model
 17 |         output = openai.ChatCompletion.create(
 18 |             # Define the model
 19 |             model="gpt-4o-2024-08-06",
 20 |             # Define the prompt - add the context
 21 |             messages = [
 22 |                 {'role':'system', 'content':"{}".format(bot_role)},
 23 |                 {'role':'user', 'content':"Rewrite the following: {}".format(prompt)}
 24 |             ],
 25 |             # Set the temperature to 0 to get the most stable results
 26 |             temperature = 0,
 27 |         )
 28 | 
 29 |         response = output['choices'][0].message.content
 30 | 
 31 |         st.write(response)
 32 | 
 33 | 
 34 | def academic():
 35 |     if st.session_state.user != '':
 36 |         prompt = st.session_state.user
 37 | 
 38 |         # Define the bot role:
 39 |         bot_role = "You are AChatdemio, a bot that helps young researchers to write better research papers. You respond in a clear, concise and academic style."
 40 | 
 41 |         # Define the ChatGPT model
 42 |         output = openai.ChatCompletion.create(
 43 |             # Define the model
 44 |             model="gpt-4o-2024-08-06",
 45 |             # Define the prompt - add the context
 46 |             messages = [
 47 |                 {'role':'system', 'content':"{}".format(bot_role)},
 48 |                 {'role':'user', 'content':"Rewrite the following text, delimited by triple backticks, in academic style: ```{}```".format(prompt)}
 49 |             ],
 50 |             # Set the temperature to 0 to get the most stable results
 51 |             temperature = 0,
 52 |         )
 53 | 
 54 |         response = output['choices'][0].message.content
 55 | 
 56 |         st.subheader("Text with corrections")
 57 |         diff = Redlines(prompt,response)
 58 |         st.markdown(diff.output_markdown, unsafe_allow_html=True)
 59 | 
 60 |         st.subheader("Rewritten text")
 61 |         st.write(response)
 62 | 
 63 | def bullet():
 64 |     if st.session_state.user != '':
 65 |         prompt = st.session_state.user
 66 | 
 67 |         # Define the bot role:
 68 |         bot_role = "You are AChatdemio, a bot that helps young researchers to write better research papers. You respond in a clear, concise and academic style."
 69 | 
 70 |         # Define the ChatGPT model
 71 |         output = openai.ChatCompletion.create(
 72 |             # Define the model
 73 |             model="gpt-4o-2024-08-06",
 74 |             # Define the prompt - add the context
 75 |             messages = [
 76 |                 {'role':'system', 'content':"{}".format(bot_role)},
 77 |                 {'role':'user', 'content':"Provide one paragraph of text from the following bullet point list, delimited by triple backticks: ```{}```".format(prompt)}
 78 |             ],
 79 |             # Set the temperature to 0 to get the most stable results
 80 |             temperature = 0,
 81 |         )
 82 | 
 83 |         response = output['choices'][0].message.content
 84 | 
 85 |         st.write(response)
 86 | 
 87 | def slides():
 88 |     if st.session_state.user != '':
 89 |         prompt = st.session_state.user
 90 | 
 91 |         # Define the bot role:
 92 |         bot_role = "You are AChatdemio, a bot that helps young researchers to write better research papers. You respond in a clear, concise and academic style."
 93 | 
 94 |         # Define the ChatGPT model
 95 |         output = openai.ChatCompletion.create(
 96 |             # Define the model
 97 |             model="gpt-4o-2024-08-06",
 98 |             # Define the prompt - add the context
 99 |             messages = [
100 |                 {'role':'system', 'content':"{}".format(bot_role)},
101 |                 {'role':'user', 'content':"Prepare text for powerpoint slides in form of bullet points from the following text, delimited by triple backticks. The bullet points should summarize the provided texts in a few sentences. The sentences should be short and summarization of the provided text. Avoid using full sentences when possible. End each sentence with a dot. The text: ```{}```".format(prompt)}
102 |             ],
103 |             # Set the temperature to 0 to get the most stable results
104 |             temperature = 0,
105 |         )
106 | 
107 |         response = output['choices'][0].message.content
108 | 
109 |         st.write(response)
110 | 
111 | 
112 | def proofreading():
113 |     if st.session_state.user != '':
114 |         prompt = st.session_state.user
115 | 
116 |         # Define the bot role:
117 |         bot_role = "You are AChatdemio, a bot that helps young researchers to write better research papers. You respond in a clear, concise and academic style."
118 | 
119 |         # Define the ChatGPT model
120 |         output = openai.ChatCompletion.create(
121 |             # Define the model
122 |             model="gpt-4o-2024-08-06",
123 |             # Define the prompt - add the context
124 |             messages = [
125 |                 {'role':'system', 'content':"{}".format(bot_role)},
126 |                 {'role':'user', 'content':"Find errors in the following text, delimited by triple backticks: ```{}```. Only ouput the errors and suggest how they should be corrected.".format(prompt)}
127 |             ],
128 |             # Set the temperature to 0 to get the most stable results
129 |             temperature = 0,
130 |         )
131 | 
132 |         response = output['choices'][0].message.content
133 | 
134 |         st.write(response)
135 | 
136 | def own_prompt():
137 |     if st.session_state.user != '':
138 |         prompt = st.session_state.user
139 |         user_defined_prompt = st.session_state.user_prompt
140 | 
141 |         # Define the bot role:
142 |         bot_role = "You are AChatdemio, a bot that helps young researchers to write better research papers."
143 | 
144 |         # Define the ChatGPT model
145 |         output = openai.ChatCompletion.create(
146 |             # Define the model
147 |             model="gpt-4o-2024-08-06",
148 |             # Define the prompt - add the context
149 |             messages = [
150 |                 {'role':'system', 'content':"{}".format(bot_role)},
151 |                 {'role':'user', 'content':"{}: ```{}```".format(user_defined_prompt,prompt)}
152 |             ],
153 |             # Set the temperature to 0 to get the most stable results
154 |             temperature = 0,
155 |         )
156 | 
157 |         response = output['choices'][0].message.content
158 | 
159 |         st.write(response)
160 | 
161 | st.title(":blue[Achademio] ☕")
162 | st.write("# Improve the style of your research papers with AI")
163 | 
164 | 
165 | # Create another two Streamlit widgets st.text_input() and st.button() to facilitate the query interface to users. 
166 | st.text_area("Provide your text:", key="user")
167 | option = st.selectbox("Select what would you like the Achademio bot to do:", ('Rewrite in academic style', 'Write a paragraph from my bullet point list', 'Summarize text in bullet points for slides', 'Proofread my text and output errors', 'Define your own prompt'))
168 | 
169 | if 'Rewrite in academic style' in option:
170 |     academic()
171 | elif 'Write a paragraph from my bullet point list' in option:
172 |     bullet()
173 | elif 'Summarize text in bullet points for slides' in option:
174 |     slides()
175 | elif 'Proofread my text and output errors' in option:
176 |     proofreading()
177 | elif 'Define your own prompt' in option:
178 |     if st.session_state.get("user_prompt", None) != None:
179 |         user_defined_prompt = st.session_state.user_prompt
180 |         st.write(f"Previous prompt: {user_defined_prompt}")
181 | 
182 |     st.text_area("Provide your prompt:", key="user_prompt")
183 |     own_prompt()
184 | 


--------------------------------------------------------------------------------
/figures/bullet-point-example.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/TajaKuzman/Achademio/ecfe32eada3e1860371429d164a9e4b738947df8/figures/bullet-point-example.png


--------------------------------------------------------------------------------
/figures/correct-text-example.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/TajaKuzman/Achademio/ecfe32eada3e1860371429d164a9e4b738947df8/figures/correct-text-example.png


--------------------------------------------------------------------------------
/figures/main-example.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/TajaKuzman/Achademio/ecfe32eada3e1860371429d164a9e4b738947df8/figures/main-example.png


--------------------------------------------------------------------------------
/figures/rewrite-example.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/TajaKuzman/Achademio/ecfe32eada3e1860371429d164a9e4b738947df8/figures/rewrite-example.png


--------------------------------------------------------------------------------
/figures/update-rewriting.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/TajaKuzman/Achademio/ecfe32eada3e1860371429d164a9e4b738947df8/figures/update-rewriting.png


--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
1 | openai==0.27.6
2 | redlines==0.3.0
3 | streamlit==1.22.0


--------------------------------------------------------------------------------