RAG Financial Risk Assessment

Инструмент оценки финансового риска на основе тряпки

Обзор

Инструмент оценки финансового риска, основанный на RAG, предназначен для использования методов поиска-аугированного поколения (RAG) для оценки финансового риска с использованием передовых моделей искусственного интеллекта. Этот проект направлен на то, чтобы дать представление о финансовых данных и оказания помощи в оценке рисков с помощью автоматизированного трубопровода.

Структура проекта

• src/ : содержит основные файлы исходного кода.

  • __init__.py : файл инициализации для модуля src .
  • retriever.py : реализует поиск данных с помощью модели ретривера.
  • generator.py : реализует генерацию текста с помощью модели генератора.
  • main.py : главный сценарий для запуска тряпичного трубопровода.
  • 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/ : тетради Юпитера для экспериментов и анализа.

  • RAG_pipeline_demo.ipynb : демонстрация Rag Pipeline.
  • 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. Демо -ноутбука :

   Откройте и запустите notebooks/RAG_pipeline_demo.ipynb в среде ноутбука Юпитера, чтобы увидеть демонстрацию трубопровода Rag.

3. Исследовательский анализ данных (EDA) :

   Исследуйте набор данных и выполните EDA, используя notebooks/EDA.ipynb .

Конфигурация

Файлы конфигурации расположены в config/ каталоге:

• default_config.yaml : общие настройки и конфигурации модели.
• logging_config.yaml : Настройки ведения журнала и отладки.
• pipeline_config.yaml : конкретные конфигурации для тряпичного трубопровода.

Тестирование

Чтобы запустить устройства и интеграционные тесты, используйте:

pytest src/tests/

Вклад

Взносы приветствуются! Пожалуйста, откройте проблему или отправьте запрос на привлечение на GitHub.

Лицензия

Этот проект лицензирован по лицензии MIT - для получения подробной информации см. Файл лицензии.

Контакт

По любым вопросам или поддержке, пожалуйста, свяжитесь с [email protected].