Legal_Expert_Contract_Advisor_Using_Precision_RAG

Vertragslag- und Vertragslag -System

Überblick

Dieses Projekt zielt darauf ab, ein hochpräzisetztes Rechtsexpertensystem für den Q & A unter Verwendung der Abruf Generation (RAG) zu entwickeln. Das System nutzt die NLP-Techniken (Advanced Natural Language Processing), um genaue und kontextbezogene Antworten auf Fragen zu rechtlichen Verträgen zu erhalten, und integriert ein leistungsstarkes Sprachmodell in einen benutzerdefinierten Abrufmechanismus, um genaue und kontextbezogene Antworten auf vertragliche Abfragen zu erhalten.

Inhaltsverzeichnis

• Überblick
• Projektstruktur
• Installation
• Verwendung
• Entwicklung
• Auswertung
• Optimierungstechniken
• Beitragen
• Lizenz
• Anerkennung
• Kontakt

Merkmale

• RAG-Pipeline (Abruf-Augmented Generation) für Vertragsgeschäfts- und Antworten
• Anpassbare Retriever- und Generatorkomponenten
• Bewertungsrahmen unter Verwendung von Ragas -Metriken
• Optimierungstechniken für eine verbesserte Leistung

Projektstruktur

 Legal_Expert_Contract_Advisor_Using_Precision_RAG/
├── data/
│   ├── raw/
│   ├── processed/
│   └── evaluation/
├── notebooks/
│   ├── 1_data_exploration.ipynb
│   ├── 2_rag_implementation.ipynb
│   └── 3_evaluation_and_optimization.ipynb
├── src/
│   ├── data/
│   │   ├── __init__.py
│   │   ├── preprocess.py
│   │   └── load_data.py
│   ├── models/
│   │   ├── __init__.py
│   │   ├── retriever.py
│   │   └── generator.py
│   ├── evaluation/
│   │   ├── __init__.py
│   │   └── metrics.py
│   └── utils/
│       ├── __init__.py
│       └── helpers.py
├── tests/
│   ├── test_data.py
│   ├── test_models.py
│   └── test_evaluation.py
├── config.yaml
├── requirements.txt
├── setup.py
├── main.py
├── .gitignore
└── README.md

• data/ : Enthält rohe und verarbeitete Datendateien
• notebooks/ : Jupyter -Notizbücher zur Erkundung, Implementierung und Bewertung
• src/ : Quellcode für das Lappensystem
  • data/ : Datenladen- und Vorverarbeitungsskripte
  • models/ : Retriever- und Generatormodellimplementierungen
  • evaluation/ : Bewertungsmetriken und Skripte
  • utils/ : Helferfunktionen und Dienstprogramme
• tests/ : Unit -Tests für verschiedene Komponenten
• config.yaml : Konfigurationsdatei für Projekteinstellungen
• requirements.txt : Liste der Projektabhängigkeiten
• setup.py : Setup -Skript für das Projekt einrichten
• main.py : Haupteintrittspunkt für das Ausführen des Lappensystems

Installation

1. Klonen Sie das Repository

git clone https://github.com/dev-abuke/Legal_Expert_Contract_Advisor_Using_Precision_RAG.git

2. Navigieren Sie zum Projektverzeichnis

 cd Legal_Expert_Contract_Advisor_Using_Precision_RAG

3. Erstellen Sie eine virtuelle Umgebung

python -m venv venv

4. Aktivieren Sie die Umgebung

 source venv/bin/activate  # On Windows, use venvScriptsactivate

3. Installieren Sie die erforderlichen Abhängigkeiten:

pip install -r requirements.txt

Verwendung

1. Bereiten Sie Ihre Vertragsdaten vor und platzieren Sie sie in das data/raw/ Verzeichnis.

2. Die Daten vorarbeiten

python src/data/preprocess.py

3. Führen Sie das Lappensystem aus

python main.py

4. Bewerten Sie die Systemleistung:

python src/evaluation/evaluate.py

Entwicklung

• Verwenden Sie die Jupyter -Notizbücher in notebooks/ Verzeichnis für Exploration und Prototyping.
• Implementieren Sie die Kernfunktionalität im src/ Verzeichnis.
• Fügen Sie Unit -Tests in die tests/ Verzeichnisse hinzu.
• Verwenden Sie die Projekteinstellungen konfiguriert. config.yaml

Auswertung

Die Leistung des Systems wird anhand der folgenden Metriken bewertet

• Abrufpräzision und Rückruf
• Antwort Relevanz
• Sachliche Genauigkeit
• Antwortkohärenz

Ausführliche Ergebnisse und Analyse finden Sie im Bewertungsnotizbuch.

Optimierungstechniken

Dieses Projekt untersucht verschiedene Optimierungstechniken, einschließlich

1. Fortgeschrittene Einbettungsmodelle zum Abrufen
2. Hybrid -Suchmethoden
3. Abfragebehandlung
4. Chunking -Strategien
5. Schnelltechnik

Beitragen

Beiträge zur Verbesserung des Systems sind willkommen. Bitte befolgen Sie diese Schritte:

1. Geben Sie das Repository auf
2. Erstellen Sie eine neue Filiale ( git checkout -b feature/your-feature ).
3. Nehmen Sie Ihre Änderungen vor und begehen Sie sie ( git commit -am 'Add new feature' ).
4. Drücken Sie in den Zweig ( git push origin feature/your-feature
5. Erstellen Sie eine neue Pull -Anfrage

Lizenz

Dieses Projekt ist unter der MIT -Lizenz lizenziert - Einzelheiten finden Sie in der Lizenzdatei.

Anerkennung

• 10 Akademie zur Bereitstellung der Herausforderung und der Lernmöglichkeit
• Lizzyai für die Projektinspiration und Anleitung

Kontakt

Bei Fragen eröffnen Sie bitte ein Problem in diesem Repository oder wenden Sie sich an Abubeker Shamil.