Update README.md

README.md

@@ -1,95 +1,12 @@
-# ApnaLaw: AI IPC Legal advice Assistant 📘
-
-ApnaLaw is a sophisticated legal advisory chatbot focused on providing detailed and contextually accurate responses about the Indian Penal Code. It utilizes a powerful combination of machine learning technologies to efficiently process and retrieve legal information.
-
----
-
-## Features 🌟
-
-- **Document Ingestion**: Automated processing of text documents to store legal information in a FAISS vector database.
-- **Real-Time Interaction**: Real-time legal advice through a conversational interface built with Streamlit.
-- **Legal Prompt Templating**: Structured prompt format ensuring clarity, detail, and legal accuracy in responses.
-<br>
-
----
-
-<h4><strong>🚀Blast off to discovery! Our project is waiting for you <a href= "https://huggingface.co/spaces/adarsh-maurya/ApnaLawyer">ApnaLaw</a>. Explore it today and elevate your understanding!🌟</strong><h4>
-<br>
-   
 ---
-
-## Components 🛠️
-
-### Ingestion Script (`Ingest.py`)
-
-| Functionality        | Description |
-|----------------------|-------------|
-| **Document Loading** | Loads text documents from a specified directory. |
-| **Text Splitting**   | Splits documents into manageable chunks for processing. |
-| **Embedding Generation** | Utilizes `HuggingFace's InLegalBERT` to generate text embeddings. |
-| **FAISS Database**   | Indexes embeddings for fast and efficient retrieval. |
-
-### Web Application (`app.py`)
-
-| Feature               | Description |
-|-----------------------|-------------|
-| **Streamlit Interface** | Provides a web interface for user interaction. |
-| **Chat Functionality**  | Manages conversational flow and stores chat history. |
-| **Legal Information Retrieval** | Leverages FAISS index to fetch pertinent legal information based on queries. 
-
+license: mit
+title: ApnaLawyer
+sdk: streamlit
+pinned: true
 ---
 
-## Setup 📦
-
-### Prerequisites
-
-- Python 3.8 or later
-- ray
-- langchain
-- streamlit
-- faiss
-
-### Installation
-
-1. **Clone the repository:**
-   ```bash
-   git clone https://github.com/your-repo/ApnaLaw.git
-   cd ApnaLaw
-   ```
-2. **Install dependencies:**
-   ```bash
-    pip install -r requirements.txt
-   ```
-3. **Set up the Together AI API Key:**
-Obtain an API key from <a href="https://api.together.xyz/">Together AI</a>.&nbsp;
-Sign up with Together AI today and get $25 worth of free credit! 🎉 Whether you choose to use it for a short-term project or opt for a long-term commitment, Together AI offers cost-effective solutions compared to the OpenAI API. 🚀&nbsp;<br><br>
-**> To set this API key as an environment variable on any OS, you can use the following approach:**
-  - On macOS and Linux:
-    ```bash
-    echo "export TOGETHER_API_KEY='Your-API-Key-Here'" >> ~/.bash_profile
-    source ~/.bash_profile
-    ```
-  - On Windows (using Command Prompt):
-    ```cmd
-    setx TOGETHER_API_KEY "Your-API-Key-Here"
-    ```
-  - On Windows (using PowerShell):
-    ```powershell
-    [Environment]::SetEnvironmentVariable("TOGETHER_API_KEY", "Your-API-Key-Here", "User")
-    ```
-This key is crucial for the chatbot to access language model functionalities provided by Together AI.
-
-## Running the Application
-1. **Run the ingestion script to prepare the data:**
-    ```bash
-    python ingest.py
-    ```
-2. Launch the Streamlit application:
-   ```bash
-   streamlit run app.py
-   ```
----
+# ApnaLawyer 🧑‍⚖️💬
 
-## Usage 🔍
+ApnaLawyer is a friendly Indian legal chatbot built with Streamlit and powered by HuggingFace, FAISS, Firebase, and Together AI. It helps users understand IPC (Indian Penal Code) laws in simple language with voice and text input options.
 
-Navigate to the local URL provided by Streamlit to interact with the ApnaLaw chatbot. Enter your legal queries and receive precise information derived from the indexed legal documents. Utilize the chat interface to engage in a legal discussion and get accurate advice.<br>
+> Built by Adarsh Maurya