RAG Financial Risk Assessment

Instrument zur Bewertung des finanziellen Risikos für das finanzielle Risiko

Überblick

Das Tool zur Bewertung von Rag-basierten finanziellen Risikobewertung ist so konzipiert, dass die Techniken (RAGMent-Generation von Abrufsgeneration) zur Bewertung des finanziellen Risikos mithilfe fortschrittlicher KI-Modelle bewertet werden. Dieses Projekt zielt darauf ab, Einblicke in Finanzdaten zu geben und die Risikobewertung durch eine automatisierte Pipeline zu unterstützen.

Projektstruktur

• src/ : Enthält die Hauptquellcodedateien.

  • __init__.py : Initialisierungsdatei für das src -Modul.
  • retriever.py : Implementiert das Abrufen von Daten mit einem Retriever -Modell.
  • generator.py : Implementiert die Textgenerierung mit einem Generatormodell.
  • main.py : Hauptskript zum Ausführen der RAG -Pipeline.
  • config.py : Konfigurationseinstellungen für das Projekt.
  • utils/ : Versorgungsfunktionen und Helfer.
    • data_processing.py : Datenverarbeitung und Reinigungsfunktionen.
    • model_utils.py : Helferfunktionen für Modellvorgänge.
    • logging_utils.py : Protokollierungsfunktionen zum Debuggen.
  • tests/ : Enthält Einheits- und Integrationstests.
    • test_retriever.py : Unit -Tests für das Retriever -Modul.
    • test_generator.py : Unit -Tests für das Generatormodul.
    • test_main.py : Tests für die Hauptpipeline.
  • pipelines/ : Benutzerdefinierte Pipelines für komplexe Workflows.
    • risk_assessment_pipeline.py : Pipeline spezifisch für die Bewertung des finanziellen Risikos.

• data/ : Datenspeicherung und -verwaltung.

  • raw/ : Rohdatensätze.
  • processed/ : verarbeitete Daten zur Analyse bereit.

• config/ : Konfigurationsdateien.

  • default_config.yaml : Allgemeine Konfiguration für das Projekt.
  • logging_config.yaml : Protokollierungskonfiguration.
  • pipeline_config.yaml : pipeline-spezifische Konfigurationen.

• logs/ : Protokolle im Zusammenhang mit dem Projekt.

• notebooks/ : Jupyter -Notizbücher zum Experimentieren und Analysen.

  • RAG_pipeline_demo.ipynb : Demonstration der Lag -Pipeline.
  • EDA.ipynb : EDA -Notizbuch für Explorationsdatenanalyse (EDA).

Installation

1. Klonen Sie das Repository:

   git clone < repository_url >
   cd RAG-Financial-Risk-Assessment

2. Erstellen Sie eine virtuelle Umgebung und aktivieren Sie sie:

   python -m venv venv
   source venv/bin/activate  # On Windows use `venvScriptsactivate`

3. Installieren Sie die erforderlichen Abhängigkeiten:

   pip install -r requirements.txt

4. Richten Sie Umgebungsvariablen ein (falls erforderlich):

    export OPENAI_API_KEY= < your_openai_api_key > 

Verwendung

1. Führen Sie die Lag -Pipeline aus :

   python src/main.py

   Dadurch wird die Rag -Pipeline für die Bewertung des finanziellen Risikos ausgeführt.

2. Demo -Notizbuch :

   Öffnen und führen Sie notebooks/RAG_pipeline_demo.ipynb in einer Jupyter -Notebook -Umgebung aus, um eine Demonstration der Rag -Pipeline zu sehen.

3. Explorationsdatenanalyse (EDA) :

   Erkunden Sie den Datensatz und führen Sie EDA mit notebooks/EDA.ipynb durch.

Konfiguration

Die Konfigurationsdateien befinden sich im config/ Verzeichnis:

• default_config.yaml : Allgemeine Einstellungen und Modellkonfigurationen.
• logging_config.yaml : Einstellungen zum Protokollieren und Debuggen.
• pipeline_config.yaml : spezifische Konfigurationen für die RAG -Pipeline.

Testen

Verwenden Sie, um die Einheiten- und Integrationstests auszuführen:

pytest src/tests/

Beitrag

Beiträge sind willkommen! Bitte öffnen Sie eine Ausgabe oder senden Sie eine Pull -Anfrage auf GitHub.

Lizenz

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

Kontakt

Für Fragen oder Support wenden Sie sich bitte an [email protected].