veerukhannan commited on
Commit
3735ac3
·
verified ·
1 Parent(s): 02c656c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +59 -0
README.md CHANGED
@@ -10,5 +10,64 @@ pinned: false
10
  license: apache-2.0
11
  short_description: AI Legal Assistant for Indian Criminal Laws
12
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
13
 
14
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
10
  license: apache-2.0
11
  short_description: AI Legal Assistant for Indian Criminal Laws
12
  ---
13
+ # Nyaya-Mitra (न्याय-मित्र)
14
+
15
+ Your AI Legal Companion for India's New Criminal Laws
16
+
17
+ <div align="center">
18
+ <img src="https://w7.pngwing.com/pngs/448/255/png-transparent-themis-lady-justice-justice-lady-hand-logo-monochrome-thumbnail.png" alt="Lady Justice" width="200"/>
19
+ </div>
20
+
21
+ ## Overview
22
+
23
+ Nyaya-Mitra (न्याय-मित्र) symbolizes:
24
+ - ⚖️ Justice (Nyaya)
25
+ - 🤝 Friendship (Mitra)
26
+ - 🔍 Knowledge
27
+ - 💡 Guidance
28
+
29
+ [Rest of the README content remains the same...]
30
+ ## Overview
31
+
32
+ Nyaya-Mitra is an advanced AI-powered legal assistant designed to help Indian citizens understand and navigate the newly implemented criminal laws:
33
+
34
+ - **Bharatiya Nyaya Sanhita (BNS)** - Replacing Indian Penal Code
35
+ - **Bharatiya Nagarik Suraksha Sanhita (BNSS)** - Replacing Code of Criminal Procedure
36
+ - **Bharatiya Sakshya Adhiniyam (BSA)** - Replacing Indian Evidence Act
37
+
38
+ ## Features
39
+
40
+ - 📚 **Comprehensive Legal Information**: Access detailed information about BNS, BNSS, and BSA
41
+ - 🔍 **Intelligent Search**: Find relevant legal provisions using natural language queries
42
+ - 📝 **Document Guidance**: Get information about required documents for legal procedures
43
+ - 💡 **Simplified Explanations**: Complex legal concepts explained in simple terms
44
+ - 🔗 **Source Citations**: All information backed by relevant sections from official documents
45
+
46
+ ## Technology Stack
47
+
48
+ - **AI Engine**: Mistral AI
49
+ - **Embeddings**: Sentence Transformers
50
+ - **Vector Store**: ChromaDB
51
+ - **UI Framework**: Gradio
52
+ - **PDF Processing**: PyPDF2
53
+ - **Language**: Python 3.8+
54
+
55
+ ## Installation
56
+
57
+ 1. Clone the repository:
58
+ ```bash
59
+ git clone https://huggingface.co/spaces/veerukhannan/nyaya-mitra
60
+ cd nyaya-mitra
61
+
62
+ This README provides:
63
+ 1. Clear project description
64
+ 2. Feature overview
65
+ 3. Technical details
66
+ 4. Installation instructions
67
+ 5. Usage examples
68
+ 6. Important disclaimers
69
+ 7. Contribution guidelines
70
+
71
+
72
 
73
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference