RAG Financial Risk Assessment

基於抹布的財務風險評估工具

概述

基於RAG的財務風險評估工具旨在利用檢索型發電（RAG）技術來使用先進的AI模型來評估財務風險。該項目旨在提供有關財務數據的見解，並通過自動管道來協助風險評估。

項目結構

• src/ ：包含主要源代碼文件。

  • __init__.py src的初始化文件。
  • retriever.py ：使用獵犬模型實現數據檢索。
  • generator.py ：使用生成器模型實現文本生成。
  • main.py ：運行RAG管道的主要腳本。
  • config.py ：項目的配置設置。
  • utils/ ：公用事業功能和助手。
    • data_processing.py ：數據處理和清潔功能。
    • model_utils.py ：用於模型操作的輔助功能。
    • logging_utils.py ：調試的記錄功能。
  • tests/ ：包含單元和集成測試。
    • test_retriever.py ：檢索器模塊的單元測試。
    • test_generator.py ：發電機模塊的單元測試。
    • test_main.py ：主管線的測試。
  • pipelines/ ：複雜工作流的自定義管道。
    • risk_assessment_pipeline.py ：特定於財務風險評估的管道。

• data/ ：數據存儲和管理。

  • raw/ ：RAW數據集。
  • processed/ ：已處理的數據準備進行分析。

• config/ ：配置文件。

  • default_config.yaml ：項目的常規配置。
  • logging_config.yaml ：記錄配置。
  • pipeline_config.yaml ：特定於管道的配置。

• logs/ ：與項目相關的日誌。

• notebooks/ ：用於實驗和分析的Jupyter筆記本。

  • RAG_pipeline_demo.ipynb ：抹布管道的演示。
  • EDA.ipynb ：探索性數據分析（EDA）筆記本。

安裝

1. 克隆存儲庫：

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

2. 創建虛擬環境並激活它：

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

3. 安裝所需的依賴項：

   pip install -r requirements.txt

4. 設置環境變量（如果需要）：

    export OPENAI_API_KEY= < your_openai_api_key > 

用法

1. 運行抹布管道：

   python src/main.py

   這將執行破布管道進行財務風險評估。

2. 演示筆記本：

   在jupyter筆記本電腦環境中打開並運行notebooks/RAG_pipeline_demo.ipynb以查看抹布管道的演示。

3. 探索性數據分析（EDA） ：

   探索數據集並使用notebooks/EDA.ipynb執行EDA。

配置

配置文件位於config/目錄中：

• default_config.yaml ：一般設置和模型配置。
• logging_config.yaml ：用於記錄和調試的設置。
• pipeline_config.yaml ：抹布管道的特定配置。

測試

要運行單元和集成測試，請使用：

pytest src/tests/

貢獻

歡迎捐款！請在GitHub上開設問題或提交拉動請求。

執照

該項目是根據MIT許可證獲得許可的 - 有關詳細信息，請參見許可證文件。

接觸

如有任何疑問或支持，請聯繫[email protected]。