RAG Financial Risk Assessment

Herramienta de evaluación de riesgos financieros basados ​​en trapo

Descripción general

La herramienta de evaluación de riesgos financieros basados ​​en RAG está diseñada para aprovechar técnicas de generación de recuperación (RAG) de recuperación (RAG) para evaluar el riesgo financiero utilizando modelos de IA avanzados. Este proyecto tiene como objetivo proporcionar información sobre los datos financieros y ayudar en la evaluación de riesgos a través de una tubería automatizada.

Estructura de proyectos

• src/ : contiene los principales archivos de código fuente.

  • __init__.py : archivo de inicialización para el módulo src .
  • retriever.py : implementa la recuperación de datos utilizando un modelo Retriever.
  • generator.py : implementa la generación de texto utilizando un modelo de generador.
  • main.py : Script principal para ejecutar la tubería RAG.
  • config.py : configuración de configuración para el proyecto.
  • utils/ : funciones de utilidad y ayudantes.
    • data_processing.py : Funciones de procesamiento y limpieza de datos.
    • model_utils.py : funciones auxiliar para operaciones de modelo.
    • logging_utils.py : funciones de registro para depuración.
  • tests/ : contiene una unidad y pruebas de integración.
    • test_retriever.py : pruebas unitarias para el módulo Retriever.
    • test_generator.py : pruebas unitarias para el módulo generador.
    • test_main.py : pruebas para la tubería principal.
  • pipelines/ : tuberías personalizadas para flujos de trabajo complejos.
    • risk_assessment_pipeline.py : tubería específica para la evaluación de riesgos financieros.

• data/ : Almacenamiento y gestión de datos.

  • raw/ : conjuntos de datos sin procesar.
  • processed/ : datos procesados ​​listos para el análisis.

• config/ : archivos de configuración.

  • default_config.yaml : configuración general para el proyecto.
  • logging_config.yaml : configuración de registro.
  • pipeline_config.yaml : configuraciones específicas de la tubería.

• logs/ : registros relacionados con el proyecto.

• notebooks/ : cuadernos Jupyter para experimentación y análisis.

  • RAG_pipeline_demo.ipynb : demostración de la tubería RAG.
  • EDA.ipynb : Notebook de análisis de datos exploratorios (EDA).

Instalación

1. Clon el repositorio:

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

2. Crear un entorno virtual y activarlo:

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

3. Instale las dependencias requeridas:

   pip install -r requirements.txt

4. Configurar variables de entorno (si es necesario):

    export OPENAI_API_KEY= < your_openai_api_key > 

Uso

1. Ejecute la tubería de trapo :

   python src/main.py

   Esto ejecutará la tubería RAG para la evaluación de riesgos financieros.

2. Portátil de demostración :

   Abra y ejecute notebooks/RAG_pipeline_demo.ipynb en un entorno de cuaderno Jupyter para ver una demostración de la tubería RAG.

3. Análisis de datos exploratorios (EDA) :

   Explore el conjunto de datos y realice EDA usando notebooks/EDA.ipynb .

Configuración

Los archivos de configuración se encuentran en el directorio config/ :

• default_config.yaml : configuraciones generales y configuraciones de modelos.
• logging_config.yaml : Configuración para registro y depuración.
• pipeline_config.yaml : configuraciones específicas para la tubería RAG.

Pruebas

Para ejecutar la unidad y las pruebas de integración, use:

pytest src/tests/

Contribución

¡Las contribuciones son bienvenidas! Abra un problema o envíe una solicitud de extracción en GitHub.

Licencia

Este proyecto tiene licencia bajo la licencia MIT; consulte el archivo de licencia para obtener más detalles.

Contacto

Para cualquier pregunta o soporte, comuníquese con [email protected].