LAWGPT commited on
Commit
79eb3ef
1 Parent(s): 0a97e22

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +8 -44
README.md CHANGED
@@ -1,44 +1,8 @@
1
- <h1 align="center">LawGPT - RAG based Generative AI Attorney Chatbot</h1>
2
- <h3 align="center">Know Your Rights! Better Citizen, Better Nation!</h1>
3
-
4
- <p align="center">
5
- <img src="https://github.com/harshitv804/LawGPT/assets/100853494/ecff5d3c-f105-4ba2-a93a-500282f0bf00" width="700"/>
6
- </p>
7
-
8
- ## About The Project
9
- LawGPT is a RAG based generative AI attorney chatbot that is trained using Indian Penal Code data. This project was developed using Streamlit LangChain and TogetherAI API for the LLM. Ask any questions to the attorney and it will give you the right justice as per the IPC. Are you a noob in knowing your rights? then this is for you!
10
- <br>
11
-
12
- <div align="center">
13
- <br>
14
- <video src="https://github.com/harshitv804/LawGPT/assets/100853494/b6711fd6-87df-4a37-ba24-317c50dc6f8f" width="400" />
15
- <br>
16
- </div>
17
-
18
-
19
-
20
-
21
- ### Check out the live demo on Hugging Face <a href="https://huggingface.co/spaces/harshitv804/LawGPT"><img src="https://static.vecteezy.com/system/resources/previews/009/384/880/non_2x/click-here-button-clipart-design-illustration-free-png.png" width="120" height="auto"></a>
22
-
23
- ## Getting Started
24
-
25
- #### 1. Clone the repository:
26
- - ```
27
- git clone https://github.com/harshitv804/LawGPT.git
28
- ```
29
- #### 2. Install necessary packages:
30
- - ```
31
- pip install -r requirements.txt
32
- ```
33
- #### 3. Run the `ingest.py` file, preferably on kaggle or colab for faster embeddings processing and then download the `ipc_vector_db` from the output folder and save it locally.
34
- #### 4. 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. 🚀 You also have the flexibility to explore other Language Models (LLMs) or APIs if you prefer. For a comprehensive list of options, check out this link: [python.langchain.com/docs/integrations/llms](https://python.langchain.com/docs/integrations/llms) . Once signed up, seamlessly integrate Together AI into your Python environment by setting the API Key as an environment variable. 💻✨
35
- - ```
36
- os.environ["TOGETHER_API_KEY"] = "YOUR_TOGETHER_API_KEY"`
37
- ```
38
- - If you are going to host it in streamlit, huggingface or other...
39
- - Save it in the secrets variable provided by the hosting with the name `TOGETHER_API_KEY` and key as `YOUR_TOGETHER_API_KEY`.
40
-
41
- #### 5. To run the `app.py` file, open the CMD Terminal and and type `streamlit run FULL_FILE_PATH_OF_APP.PY`.
42
-
43
- ## Contact
44
- If you have any questions or feedback, please reach out to [[email protected]]
 
1
+ title: LawGPT - RAG based AI Attorney Chatbot
2
+ emoji: ⚖️
3
+ colorFrom: red
4
+ colorTo: pink
5
+ sdk: streamlit
6
+ sdk_version: 1.31.1
7
+ app_file: app.py
8
+ pinned: false