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]。