uploaded main files

CONTRIBUTING.md

@@ -0,0 +1,33 @@
+# Contributing to Legal Chatbot LLM
+
+Thank you for considering contributing to the Legal Chatbot LLM project! Your contributions are highly valued and appreciated. To maintain a smooth and collaborative development process, please adhere to the following guidelines:
+
+## How to Contribute
+
+1. **Fork the Repository**: Fork the project on GitHub and create your own copy.
+
+2. **Create a Branch**: Create a new branch for your changes using `git checkout -b feature/improvement`.
+
+3. **Make Changes**: Implement your desired changes or improvements.
+
+4. **Commit Changes**: Commit your changes with a descriptive message using `git commit -am 'Add/Fix feature'`.
+
+5. **Push Changes**: Push your committed changes to your forked repository using `git push origin feature/improvement`.
+
+6. **Create a Pull Request**: Open a pull request on this repository's `main` branch.
+
+## Code Style and Standards
+
+- Follow the coding style guidelines specified in the project. we are using `black` formatter and `flake8` linting
+- Ensure your code adheres to the established standards and practices.
+- Write clear and concise commit messages to facilitate the review process.
+
+## Reporting Issues
+
+If you encounter any issues or bugs, please feel free to open an issue on the repository. Include detailed information about the problem, steps to reproduce it, and any relevant screenshots or error messages.
+
+## Contact
+
+For any questions, suggestions, or discussions, please feel free to open an issue or contact the maintainer **Izam Mohammed** at **[email protected]**.
+
+Your contributions contribute to the continued improvement and success of the Legal Chatbot LLM project. Thank you for your support!

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Izam Mohammed
+
+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,49 @@
----
-title: Legal Advisor
-emoji: 🔥
-colorFrom: blue
-colorTo: gray
-sdk: streamlit
-sdk_version: 1.31.1
-app_file: app.py
-pinned: false
-license: apache-2.0
----
-
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# Legal Chatbot LLM 
+
+## Overview
+This project is a Legal Chatbot powered by Large Language Models (LLM) and RAG model. It allows users to ask questions related to legal terms and receive accurate responses. The chatbot utilizes a RAG (Retrieval-Augmented Generation) model to enhance its performance.
+
+![](assets/demo.png)
+
+## Features
+- Utilizes LLM for natural language understanding and generation.
+- Integrates vector databases for efficient retrieval of legal information.
+- Implements a RAG model to combine retrieval and generation approaches for improved responses.
+- Allows users to ask questions related to legal terms and concepts.
+- Provides accurate and concise responses to user queries.
+- User-friendly interface for seamless interaction.
+
+## Usage
+1. Clone the repository to your local machine.
+2. Install the required dependencies specified in the `requirements.txt` file.
+3. Run the main script to start the chatbot.
+4. Enter your legal queries and interact with the chatbot to receive responses.
+
+## Technologies Used
+- Large Language Models (LLM)
+- Vector Databases
+- RAG (Retrieval-Augmented Generation) Model
+- Python
+
+## Installation
+```bash
+git clone https://github.com/your_username/legal-chatbot.git
+cd legal-chatbot
+pip install -r requirements.txt
+python app.py
+```
+
+## Contributing
+Contributions are welcome! If you'd like to contribute to this project, please follow these steps:
+1. Fork the repository.
+2. Create a new branch (`git checkout -b feature/improvement`).
+3. Make your changes.
+4. Commit your changes (`git commit -am 'Add new feature'`).
+5. Push to the branch (`git push origin feature/improvement`).
+6. Create a new Pull Request.
+
+## License
+This project is under [MIT Licence](LICENSE)
+
+## Contact
+For any inquiries or feedback, please contact [Izam mohammed] at [[email protected]].

app.py

@@ -0,0 +1,52 @@
+import streamlit as st
+
+st.title("Legal Advisor 📚")
+
+# Sidebar for selecting the chatbot
+selected_chatbot = st.sidebar.radio("Select Chatbot", ("OpenAI", "Llama 2"))
+if selected_chatbot == "OpenAI":
+    from src import openai_call
+elif selected_chatbot == "Llama 2":
+    st.warning(
+        "It might take some time to get response becuase of the size of Llama 2 model ⚠️"
+    )
+    from src import llama_call
+
+# Initialize chat history
+if "messages" not in st.session_state:
+    st.session_state.messages = []
+st.info("""
+**Legal Advisor Bot:**
+- **Objective:** Develop a conversational AI chatbot to provide legal advice and assistance. 🤖💼
+- **Technology Stack:** Utilizes Streamlit for the user interface, integrates with external chatbot APIs (such as OpenAI and Llama 2) for natural language processing. 🖥️📡
+- **Features:**
+  - Allows users to select between different chatbot models for varied responses. 🔄
+  - Provides a chat history feature to track user interactions. 📝
+  - Displays loading spinner while fetching responses from the selected chatbot. ⏳
+  - Offers a user-friendly interface for asking legal questions. 💬
+- **Emphasis:** Focuses on simplicity, efficiency, and accessibility in delivering legal information and support through conversational AI. 🎯
+        """)
+# Display chat messages from history on app rerun
+for message in st.session_state.messages:
+    with st.chat_message(message["role"]):
+        st.markdown(message["content"])
+
+# React to user input
+if prompt := st.chat_input("Ask something about law"):
+    # Display user message in chat message container
+    st.chat_message("user").markdown(prompt)
+    # Add user message to chat history
+    st.session_state.messages.append({"role": "user", "content": prompt})
+
+    # Add a loading spinner while waiting for response
+    with st.spinner("Thinking ✨..."):
+        if selected_chatbot == "Llama 2":
+            response = llama_call(prompt)
+        elif selected_chatbot == "OpenAI":
+            response = openai_call(prompt)
+
+        # Display assistant response in chat message container
+        with st.chat_message("assistant"):
+            st.markdown(response)
+        # Add assistant response to chat history
+        st.session_state.messages.append({"role": "assistant", "content": response})

requirements.txt

@@ -0,0 +1,13 @@
+langchain
+pymupdf
+pinecone-client
+sentence-transformers
+pypdf
+langchain_pinecone
+ctransformers
+openai
+python-dotenv
+# faiss-gpu==1.7.2
+streamlit
+langchain-community
+langchain-openai

setup.py

@@ -0,0 +1,10 @@
+from setuptools import find_packages, setup
+
+setup(
+    name="Legal Chatbot",
+    version="0.0.1",
+    author="Izam Mohammed",
+    author_email="[email protected]",
+    packages=find_packages(),
+    install_requires=[],
+)