Upload 7 files

.gitattributes

@@ -1,35 +1,2 @@
-*.7z filter=lfs diff=lfs merge=lfs -text
-*.arrow filter=lfs diff=lfs merge=lfs -text
-*.bin filter=lfs diff=lfs merge=lfs -text
-*.bz2 filter=lfs diff=lfs merge=lfs -text
-*.ckpt filter=lfs diff=lfs merge=lfs -text
-*.ftz filter=lfs diff=lfs merge=lfs -text
-*.gz filter=lfs diff=lfs merge=lfs -text
-*.h5 filter=lfs diff=lfs merge=lfs -text
-*.joblib filter=lfs diff=lfs merge=lfs -text
-*.lfs.* filter=lfs diff=lfs merge=lfs -text
-*.mlmodel filter=lfs diff=lfs merge=lfs -text
-*.model filter=lfs diff=lfs merge=lfs -text
-*.msgpack filter=lfs diff=lfs merge=lfs -text
-*.npy filter=lfs diff=lfs merge=lfs -text
-*.npz filter=lfs diff=lfs merge=lfs -text
-*.onnx filter=lfs diff=lfs merge=lfs -text
-*.ot filter=lfs diff=lfs merge=lfs -text
-*.parquet filter=lfs diff=lfs merge=lfs -text
-*.pb filter=lfs diff=lfs merge=lfs -text
-*.pickle filter=lfs diff=lfs merge=lfs -text
-*.pkl filter=lfs diff=lfs merge=lfs -text
-*.pt filter=lfs diff=lfs merge=lfs -text
-*.pth filter=lfs diff=lfs merge=lfs -text
-*.rar filter=lfs diff=lfs merge=lfs -text
-*.safetensors filter=lfs diff=lfs merge=lfs -text
-saved_model/**/* filter=lfs diff=lfs merge=lfs -text
-*.tar.* filter=lfs diff=lfs merge=lfs -text
-*.tar filter=lfs diff=lfs merge=lfs -text
-*.tflite filter=lfs diff=lfs merge=lfs -text
-*.tgz filter=lfs diff=lfs merge=lfs -text
-*.wasm filter=lfs diff=lfs merge=lfs -text
-*.xz filter=lfs diff=lfs merge=lfs -text
-*.zip filter=lfs diff=lfs merge=lfs -text
-*.zst filter=lfs diff=lfs merge=lfs -text
-*tfevents* filter=lfs diff=lfs merge=lfs -text
+# Auto detect text files and perform LF normalization
+* text=auto

.gitignore

@@ -0,0 +1,152 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintainted in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Abishek M
+
+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

@@ -0,0 +1,56 @@
+# Langchain Based LLM Project
+
+## Overview
+
+This is a simple Langchain-based LLM project that allows users to upload multiple documents and ask questions through a web UI. The LLM has access to the knowledge contained within the uploaded documents and can provide answers to user's questions. This project can be improved in the future by creating a more user-friendly interface and enhancing its academic capabilities.
+
+## Features
+
+The following features are currently available in this project:
+
+- Users can upload multiple PDF documents through the web UI.
+- Users can ask questions related to the content of the uploaded documents.
+- The LLM uses natural language processing and machine learning algorithms to understand and interpret user questions.
+- The LLM provides answers to user questions based on the information contained within the uploaded documents.
+- The LLM retains knowledge of past messages and documents to provide more accurate responses.
+
+## Installation
+
+To install this project, follow these steps:
+
+1. Clone the repository using 
+    
+    `git clone https://github.com/abishek-ctrl/pdf-chat-langchain.git`
+2. Install all dependencies by running 
+            
+    `pip install -r requirements.txt`
+3. Add your OpenAI API key by creating a .env file.
+            
+        OPENAI_API_KEY="your_openai_api_key"
+3. Run the application using `python app.py`
+
+# Usage
+
+Once the project is installed, users can start using it by following these steps:
+
+1. Upload one or more PDF documents using the "Upload" button on the web UI.
+2. Ask a question related to the content of the uploaded documents using the "Ask Question" button on the web UI.
+3. The LLM will process the question and provide an answer based on the information contained within the uploaded documents.
+
+### Update (2024-01-20)
+
+Added Streamlit URL for access: [https://lang-chat.streamlit.app](https://lang-chat.streamlit.app)
+
+# Future Improvements
+
+We plan to improve this project in the future by implementing the following features:
+
+- A more user-friendly interface to make it easier for users to interact with the LLM.
+- Deployment to the real world for public use.
+- Enhanced academic capabilities to support students and researchers in their studies and work.
+- Integration with additional document formats to expand the types of documents that can be used with the LLM.
+- Advanced language models to improve the accuracy and comprehensiveness of the LLM's responses.
+
+# License
+
+This project is licensed under the MIT License.

app.py

@@ -0,0 +1,83 @@
+import streamlit as st
+from dotenv import load_dotenv
+from PyPDF2 import PdfReader
+from langchain.chat_models import ChatOpenAI
+from langchain.text_splitter import CharacterTextSplitter
+from langchain.vectorstores import FAISS
+from langchain.embeddings import OpenAIEmbeddings
+from langchain.memory import ConversationBufferMemory
+from langchain.chains import ConversationalRetrievalChain
+from htmltemp import css, botTemp, userTemp
+
+def get_text(docs):
+    text= ""
+    for pdf in docs:
+        pdf_reader=PdfReader(pdf)
+        for page in pdf_reader.pages:
+            text+=page.extract_text()
+    return text
+
+def get_chunks(rawtxt):
+    splitter=CharacterTextSplitter(
+        separator="\n",
+        chunk_size=1000,
+        chunk_overlap=200,
+        length_function=len
+    )
+    chunks=splitter.split_text(rawtxt)
+    return chunks
+
+def get_vectorstore(chunks):
+    embeddings=OpenAIEmbeddings()
+    vectors=FAISS.from_texts(texts=chunks,embedding=embeddings)
+    return vectors
+
+def get_convo_chain(vector):
+    llm=ChatOpenAI()
+    memory=ConversationBufferMemory(memory_key='chat_history',return_messages=True)
+    convo_chain= ConversationalRetrievalChain.from_llm(
+        llm=llm,
+        retriever=vector.as_retriever(),
+        memory=memory
+    )
+    return convo_chain
+
+def handle_inp(inp):
+    response=st.session_state.conversation({'question':inp})
+    st.session_state.chat_history= response['chat_history']
+
+    for i, msg in enumerate(st.session_state.chat_history):
+        if i%2==0:
+            st.write(userTemp.replace("{{MSG}}",msg.content),unsafe_allow_html=True)
+        else:
+            st.write(botTemp.replace("{{MSG}}",msg.content),unsafe_allow_html=True)
+
+
+def main():
+    load_dotenv()
+    st.set_page_config(page_title="PDF Chat", page_icon=":books:")
+
+    st.write(css,unsafe_allow_html=True)
+
+    if "conversation" not in st.session_state:
+        st.session_state.conversation=None
+    if "chat_history" not in st.session_state:
+        st.session_state.chat_history=None
+
+    st.header("PDF Chat :books:")
+    inp= st.text_input("Ask a question about the PDF:")
+    if inp:
+        handle_inp(inp)
+
+    with st.sidebar:
+        st.subheader("Your PDFs")
+        docs=st.file_uploader("Upload your PDFs here",accept_multiple_files=True)
+        if st.button("Upload"):
+            with st.spinner("Processing"):
+                rawtxt=get_text(docs)
+                chunks=get_chunks(rawtxt)
+                vectors=get_vectorstore(chunks)
+                st.session_state.conversation=get_convo_chain(vectors)
+
+if __name__ == "__main__":
+    main()

htmltemp.py

@@ -0,0 +1,44 @@
+css = '''
+<style>
+.chat-message {
+    padding: 1.5rem; border-radius: 0.5rem; margin-bottom: 1rem; display: flex
+}
+.chat-message.user {
+    background-color: #2b313e
+}
+.chat-message.bot {
+    background-color: #475063
+}
+.chat-message .avatar {
+  width: 20%;
+}
+.chat-message .avatar img {
+  max-width: 78px;
+  max-height: 78px;
+  border-radius: 50%;
+  object-fit: cover;
+}
+.chat-message .message {
+  width: 80%;
+  padding: 0 1.5rem;
+  color: #fff;
+}
+'''
+
+userTemp = '''
+<div class="chat-message bot">
+    <div class="avatar">
+        <span>User:</span>
+    </div>
+    <div class="message">{{MSG}}</div>
+</div>
+'''
+
+botTemp = '''
+<div class="chat-message user">
+    <div class="avatar">
+        <span>Bot:</span>
+    </div>    
+    <div class="message">{{MSG}}</div>
+</div>
+'''