Upload 8 files

.gitignore

@@ -0,0 +1 @@
+.env

LICENSE.txt

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

README.md

@@ -1,13 +1,64 @@
----
-title: VirtualBrainGPT
-emoji: 🏃
-colorFrom: blue
-colorTo: gray
-sdk: streamlit
-sdk_version: 1.19.0
-app_file: app.py
-pinned: false
-license: mit
----
-
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+
+# VirtualBrainGPT: Digital Journal 📝
+
+VirtualBrainGPT is a digital journal application that leverages the power of OpenAI's Embeddings API and Langchain to create a seamless and efficient journaling experience. With the capability to search and extract information from journal entries in seconds, VirtualBrainGPT becomes an indispensable tool for users who want to recall specific details from their past entries.
+
+# Web App
+Click [Here](https://huggingface.co/spaces/Kaludi/ChatGPT-BingChat-GPT3-Prompt-Generator_App "Here") To View This Application Online!
+
+![VirtualBrainGPT](https://github.com/add/your-image-url-here.jpg)
+
+## Features
+
+-   Create and manage journal entries using a clean interface.
+-   Search and extract information from journal entries quickly and accurately.
+-   Support for both TXT and PDF file formats.
+-   Powered by OpenAI's Embeddings API and Langchain for efficient information retrieval.
+
+## Usage
+
+### Brain Entry
+
+In the 'Brain Entry' section, users can create a new journal entry or edit an existing one by choosing a date using the date picker. Once you have completed your entry, click 'Submit' and it will be saved or updated to the diary_journal.txt file.
+
+### Brain Search
+
+The 'Brain Search' section of the application unlocks the full potential of your digital journal. Here, you can ask any questions related to your journal entries, and the combination of OpenAI's Embeddings API and Langchain will provide accurate responses in seconds, no matter how long the entry or document may be. The virtual brain can help in all aspects of a user's life, enabling users to easily recall specific information, even if they can't remember it themselves. Users also have an option to select other file types if they wish to upload their own file, the current file types include TXT and PDF files, which can be selected in the file type dropdown option.
+
+## Examples of Use-Cases
+
+This application can be used in many ways. Imagine five years from now, you're trying to recollect a specific event that you documented in your journal, or you may have kept a journal from your childhood. VirtualBrainGPT will locate the exact date and provide you with a detailed account of that exact situation in a matter of seconds, as well as any other memories that you may have forgotten about. This type of  application also could offer invaluable support for individuals with Alzheimer's, helping them retrieve memories from the past that may have been lost and share them with their loved ones.
+
+## Tools & Libraries Used
+
+-   OpenAI [Embeddings](https://platform.openai.com/docs/guides/embeddings)
+-   [LangChain](https://python.langchain.com/en/latest/use_cases/question_answering.html)
+-   [Streamlit](https://streamlit.io/)
+
+## Installation
+
+To install VirtualBrainGPT, you need to have Python 3.7+ installed. Follow these steps to install the necessary dependencies:
+
+1.  Clone this repository:
+
+`git clone https://github.com/Kaludii/VirtualBrainGPT.git` 
+
+2.  Change directory to the cloned repository:
+
+`cd VirtualBrainGPT` 
+
+3.  Install the required packages:
+
+`pip install -r requirements.txt` 
+
+4.  Run the Streamlit application:
+
+`streamlit run VirtualBrainGPT.py` 
+
+## About the Developer
+
+This application was developed by [Kaludii](https://github.com/Kaludii)  using the the different tools and libraries linked above. Kaludii is an AI enthusiast who is passionate about developing and applying large learning models to solve real-world problems quickly and stress-free.
+
+## Contributions
+
+If you have any suggestions or improvements for this project, feel free to open an issue or submit a pull request. Your contributions are always welcome!

VirtualBrainGPT.py

@@ -0,0 +1,51 @@
+import os
+import datetime
+import streamlit as st
+
+st.set_page_config(
+    page_title="VirtualBrainGPT",
+    page_icon="📝",
+)
+hide_streamlit_style = """
+            <style>
+            footer {visibility: hidden;}
+            </style>
+            """
+st.markdown(hide_streamlit_style, unsafe_allow_html=True)
+st.write("# VirtualBrainGPT: Digital Journal 📝")
+
+st.sidebar.success("Select either the Brain Entry or Brain Search from above.")
+
+st.markdown(
+    """
+    This application uses the Streamlit interface to take journaling to a whole new level.
+    Welcome to VirtualBrainGPT, an application that streamlines the process of creating and managing personal journal entries. By leveraging the power of OpenAI's Embeddings API and Langchain, this application not only simplifies journaling but also offers a new way to effortly and immediately search between multiple different journal entries, no matter how many or how long they may be.
+    
+    To begin, simply select either **'Brain Entry'** or **'Brain Search'** from the **sidebar menu**! 👈
+    
+    ### Brain Entry
+    In the 'Brain Entry' section, users can create a new journal entry or edit an existing one by choosing a date using the date picker. Once you have completed your entry, click 'Submit' and it will be saved or updated to the diary_journal.txt file.
+
+    ### Brain Search
+    The 'Brain Search' section of the application unlocks the full potential of your digital journal. Here, you can ask any questions related to your journal entries, and the combination of OpenAI's Embeddings API and Langchain will provide accurate responses in seconds, no matter how long the entry or document may be. The virtual brain can help in all aspects of a user's life, enabling users to easily recall specific information, even if they can't remember it themselves. Users also have an option to select other file types if they wish to upload their own file, the current file types include TXT and PDF files, which can be selected in the file type dropdown option.
+    
+    ### Tools Used
+    - OpenAI [Embeddings](https://platform.openai.com/docs/guides/embeddings)
+    - [LangChain](https://python.langchain.com/en/latest/use_cases/question_answering.html)
+    - [Streamlit](https://streamlit.io/)
+
+    ### Application Info
+    
+    - **GitHub Application & Documentation:** [https://github.com/Kaludii/VirtualBrainGPT](https://github.com/Kaludii/VirtualBrainGPT)
+    
+    - **Web Application:** [huggingface.co/add](https://huggingface.co/add)
+    
+    ## About the Developer
+    This application was developed by [Kaludii](https://github.com/Kaludii)  using the the different tools and libraries linked above. Kaludii is an AI enthusiast who is passionate about developing and applying large learning models to solve real-world problems quickly and stress-free.
+    
+"""
+)
+
+st.markdown("---")
+st.markdown("")
+st.markdown("<p style='text-align: center'><a href='https://github.com/Kaludii'>Github</a> | <a href='https://huggingface.co/Kaludi'>HuggingFace</a></p>", unsafe_allow_html=True)

diary/diary_journal.txt

@@ -0,0 +1,29 @@
+Date: 04-24-2023 Monday
+Today was a rollercoaster of emotions. As we enter the last week of senior year, it's finally hitting me that college is coming to an end. I spent most of the day working on my final project for the Capstone course. I can't believe I'm just a few days away from presenting it. In the evening, I met up with my friends for a study session, but we mostly spent the time reminiscing and laughing about our college adventures.
+
+Date: 04-25-2023 Tuesday
+Another hectic day filled with finalizing projects and preparing for exams. I received an email from the Career Services office informing me of a potential job opportunity after graduation. The thought of starting my career is both exciting and nerve-wracking. I spent the evening with my roommate, talking about our post-graduation plans and the challenges we'll face in the "real world."
+
+Date: 04-26-2023 Wednesday
+Today was the last day of classes! It's such a surreal feeling. My professors shared some words of wisdom and encouragement, which was very touching. After class, I attended a senior send-off event on campus, where we were given our caps and gowns. As we tried them on, the reality of graduating really set in. We took lots of photos to commemorate the moment.
+
+Date: 04-27-2023 Thursday
+It's officially finals week. I spent most of my day in the library, studying and finishing up my final papers. My friends and I took a break in the afternoon to grab some ice cream and enjoy the sunshine. We discussed our plans for the upcoming summer and our future careers. The conversation was bittersweet, as we know that we'll soon be parting ways and entering new chapters in our lives.
+
+Date: 04-28-2023 Friday
+I had my first final exam this morning. I think it went well, but I'm just relieved it's over. I spent the rest of the day preparing for my Capstone presentation. I'm feeling pretty confident about it, and I can't wait to show my professor and classmates what I've been working on all semester. In the evening, I attended a pre-graduation party with my friends. We danced and sang, embracing every moment together.
+
+Date: 04-29-2023 Saturday
+Today was all about relaxation and self-care. I spent the morning catching up on sleep, then went for a run around campus to clear my head. In the afternoon, I attended a yoga class with my friends to destress before our final exams next week. It's important to find balance during these stressful times.
+
+Date: 04-30-2023 Sunday
+I'm in full-on study mode for my last two exams. The library was packed, but I managed to find a quiet spot to focus. I took a break in the evening to watch a movie with my roommates. It's our tradition to have a movie night every Sunday, and tonight's choice was a nostalgic throwback to our freshman year.
+
+Date: 05-01-2023 Monday
+One more exam down, just one more to go! After finishing today's exam, I met up with my Capstone group to finalize our presentation for tomorrow. We practiced our parts and made last-minute adjustments to our slides. We're all feeling confident and ready to present.
+
+Date: 05-02-2023 Tuesday
+We finally presented our Capstone project! It was a huge success, and our professor praised our hard work and dedication. It was such a rewarding feeling to see our project come together after months of effort. In the evening, I attended the Senior Awards Ceremony, where several of my friends received well-deserved awards for their achievements.
+
+Date: 05-03-2023 Wednesday
+I completed my final exam today! It's hard to believe that my college journey is coming to an end. To celebrate, my friends and I went out for dinner at our favorite restaurant, reminiscing about our college experiences and sharing our hopes for the future. After dinner, we took a long walk around campus, stopping at all the memorable spots and taking pictures to capture these precious moments. As we walked, we couldn't help but feel a mix of happiness, sadness, and anticipation for what lies ahead.

pages/Brain_Entry.py

@@ -0,0 +1,116 @@
+import os
+import datetime
+import streamlit as st
+
+hide_streamlit_style = """
+            <style>
+            footer {visibility: hidden;}
+            </style>
+            """
+st.markdown(hide_streamlit_style, unsafe_allow_html=True)
+
+# Create a 'diary' folder in the current directory if it doesn't exist
+if not os.path.exists("diary"):
+    os.makedirs("diary")
+
+# Name of the single journal file
+journal_file = "diary/diary_journal.txt"
+
+def parse_date(date_string):
+    try:
+        return datetime.datetime.strptime(date_string, "%m-%d-%Y %A")
+    except ValueError:
+        return datetime.datetime.strptime(date_string, "%m-%d-%Y")
+
+def get_journal_entries():
+    entries = []
+    if not os.path.exists(journal_file):
+        return entries
+
+    with open(journal_file, "r", encoding="utf-8") as f:
+        for line in f:
+            if line.startswith("Date: "):
+                entry_date = parse_date(line[6:].strip())
+                entries.append(entry_date)
+    entries.sort(reverse=True)
+    return entries
+
+def read_entry(date):
+    content = ""
+    with open(journal_file, "r", encoding="utf-8") as f:
+        lines = f.readlines()
+
+    start_reading = False
+    for line in lines:
+        if line.startswith("Date: ") and start_reading:
+            break
+
+        if start_reading:
+            content += line
+
+        if line.startswith("Date: ") and date == parse_date(line[6:].strip()):
+            start_reading = True
+
+    return content
+
+def write_entry(date, content):
+    new_entry = f"\nDate: {date}\n{content}\n"
+
+    # Check if the entry already exists
+    entry_exists = False
+    if os.path.exists(journal_file):
+        with open(journal_file, "r", encoding="utf-8") as f:
+            lines = f.readlines()
+            entry_exists = any(line.strip() == f"Date: {date}" for line in lines)
+
+    # If the entry does not exist, append the new entry to the end of the file
+    if not entry_exists:
+        with open(journal_file, "a", encoding="utf-8") as f:
+            f.write(new_entry)
+    else:
+        # If the entry exists, update the existing entry
+        with open(journal_file, "r", encoding="utf-8") as f:
+            lines = f.readlines()
+
+        # Remove existing entry if present
+        lines = [line for line in lines if line.strip() != f"Date: {date}"]
+
+        with open(journal_file, "w", encoding="utf-8") as f:
+            f.writelines(lines)
+            f.write(new_entry)
+
+st.title("Digital Brain Journal Entry ✍️")
+st.write("Write a diary journal entry or edit an existing one by selecting on the date picker.")
+
+selected_date = st.date_input("Select the date for the journal entry:", value=datetime.date.today())
+formatted_date = selected_date.strftime("%m-%d-%Y %A")
+st.write(f"Selected date: {formatted_date}")
+
+entry = ""
+
+if selected_date in get_journal_entries():
+    entry = read_entry(selected_date)
+
+new_entry = st.text_area("Write your journal entry:", entry)
+
+if st.button("Submit"):
+    write_entry(formatted_date, new_entry)
+    st.success("Journal entry saved successfully!")
+
+st.header("Previous Journal Entries")
+entries = get_journal_entries()
+
+if entries:
+    selected_entry_date = st.selectbox("Select an entry to view or edit:", entries, format_func=lambda x: x.strftime("%m-%d-%Y %A"))
+
+    if st.button("Load Entry"):
+        entry_text = read_entry(selected_entry_date)
+        st.write(f"**{selected_entry_date.strftime('%m-%d-%Y %A')}**")
+        st.markdown(entry_text.replace("\n", "<br>"), unsafe_allow_html=True)
+
+else:
+    st.write("No previous entries found.")
+
+st.markdown("---")
+st.markdown("")
+st.markdown("<p style='text-align: center'><a href='https://github.com/Kaludii'>Github</a> | <a href='https://huggingface.co/Kaludi'>HuggingFace</a></p>", unsafe_allow_html=True)

pages/Brain_Search.py

@@ -0,0 +1,102 @@
+from dotenv import load_dotenv
+import os
+import streamlit as st
+from PyPDF2 import PdfReader
+from langchain.text_splitter import CharacterTextSplitter
+from langchain.embeddings.openai import OpenAIEmbeddings
+from langchain.vectorstores import FAISS
+from langchain.chains.question_answering import load_qa_chain
+from langchain.chains.qa_with_sources import load_qa_with_sources_chain
+from langchain.llms import OpenAI
+from langchain.callbacks import get_openai_callback
+
+def extract_text_from_pdf(pdf):
+    pdf_reader = PdfReader(pdf)
+    text = ""
+    for page in pdf_reader.pages:
+        text += page.extract_text()
+    return text
+
+
+def extract_text_from_txt(txt):
+    text = txt.read().decode("utf-8")
+    return text
+
+
+def extract_text_from_diary():
+    with open('diary/diary_journal.txt', 'r', encoding='utf-8') as file:
+        text = file.read()
+    return text
+
+
+def main():
+    load_dotenv()
+    hide_streamlit_style = """
+                <style>
+                footer {visibility: hidden;}
+                </style>
+                """
+    st.markdown(hide_streamlit_style, unsafe_allow_html=True)
+    st.title("Digital Brain Journal Search 🔍")
+    st.write("Ask any questions about all the journal entries with OpenAI's Embeddings API and Langchain. The virtual brain keeps track of everything in a user's life. If you have another TXT or PDF file you'd like to search for answers, click on the dropdown and select eithter TXT or PDF option in file type.")
+
+    # Add API key input
+    api_key = st.text_input("Enter your API key:", type="password")
+    os.environ["OPENAI_API_KEY"] = api_key
+
+    if not api_key:
+        st.warning("Please enter your OpenAI API key to continue.")
+    else:
+        file_type = st.selectbox("Choose the file type", options=["Diary", "PDF", "TXT"])
+
+        file = None
+        text = None
+
+        if file_type == "PDF":
+            file = st.file_uploader("Upload your PDF", type="pdf")
+            if file is not None:
+                text = extract_text_from_pdf(file)
+        elif file_type == "TXT":
+            file = st.file_uploader("Upload your TXT", type="txt")
+            if file is not None:
+                text = extract_text_from_txt(file)
+        elif file_type == "Diary":
+            text = extract_text_from_diary()
+
+        if file is not None or file_type == "Diary":
+            # split into chunks
+            text_splitter = CharacterTextSplitter(
+                separator="\n",
+                chunk_size=1000,
+                chunk_overlap=200,
+                length_function=len
+            )
+            chunks = text_splitter.split_text(text)
+
+            # create embeddings
+            embeddings = OpenAIEmbeddings()
+            knowledge_base = FAISS.from_texts(chunks, embeddings)
+
+            # show user input
+            user_question = st.text_input("Ask a question about your document:")
+
+            if st.button("Submit"):
+                if user_question:
+                    docs = knowledge_base.similarity_search(user_question)
+
+                    llm = OpenAI()
+                    chain = load_qa_chain(llm, chain_type="stuff")
+                    with get_openai_callback() as cb:
+                        response = chain.run(input_documents=docs, question=user_question)
+                        print(cb)
+
+                    st.markdown("### Response:")
+                    st.write(response)
+                    st.write(cb)
+    st.markdown("---")
+    st.markdown("")
+    st.markdown("<p style='text-align: center'><a href='https://github.com/Kaludii'>Github</a> | <a href='https://huggingface.co/Kaludi'>HuggingFace</a></p>", unsafe_allow_html=True)
+
+
+if __name__ == '__main__':
+    main()

requirements.txt

@@ -0,0 +1,3 @@
+langchain==0.0.154
+PyPDF2==3.0.1
+streamlit==1.18.1