RAG Financial Risk Assessment

Ferramenta de avaliação de risco financeiro baseado em RAG

Visão geral

A Ferramenta de Avaliação de Risco Financeiro baseado em RAG foi projetado para alavancar técnicas de geração agente-agmentada por recuperação (RAG) para avaliar o risco financeiro usando modelos avançados de IA. Este projeto tem como objetivo fornecer informações sobre dados financeiros e ajudar na avaliação de riscos por meio de um pipeline automatizado.

Estrutura do projeto

• src/ : contém os principais arquivos de código -fonte.

  • __init__.py : arquivo de inicialização do módulo src .
  • retriever.py : implementa a recuperação de dados usando um modelo Retriever.
  • generator.py : implementa a geração de texto usando um modelo gerador.
  • main.py : Script principal para executar o pipeline RAG.
  • config.py : configuração de configurações para o projeto.
  • utils/ : funções e ajudantes de utilidade.
    • data_processing.py : Funções de processamento e limpeza de dados.
    • model_utils.py : funções auxiliares para operações de modelo.
    • logging_utils.py : Funções de log para depuração.
  • tests/ : Contém testes de unidade e integração.
    • test_retriever.py : testes de unidade para o módulo Retriever.
    • test_generator.py : testes de unidade para o módulo gerador.
    • test_main.py : testes para o pipeline principal.
  • pipelines/ : Pipelines personalizados para fluxos de trabalho complexos.
    • risk_assessment_pipeline.py : Pipeline específico para avaliação de riscos financeiros.

• data/ : armazenamento e gerenciamento de dados.

  • raw/ : conjuntos de dados brutos.
  • processed/ : Dados processados ​​prontos para análise.

• config/ : Arquivos de configuração.

  • default_config.yaml : configuração geral do projeto.
  • logging_config.yaml : configuração de log.
  • pipeline_config.yaml : configurações específicas do pipeline.

• logs/ : logs relacionados ao projeto.

• notebooks/ : Notebooks Jupyter para experimentação e análise.

  • RAG_pipeline_demo.ipynb : demonstração do pipeline RAG.
  • EDA.ipynb : Notebook de Análise de Dados Exploratórios (EDA).

Instalação

1. Clone o repositório:

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

2. Crie um ambiente virtual e ative -o:

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

3. Instale as dependências necessárias:

   pip install -r requirements.txt

4. Configure variáveis ​​de ambiente (se necessário):

    export OPENAI_API_KEY= < your_openai_api_key > 

Uso

1. Execute o pipeline RAG :

   python src/main.py

   Isso executará o oleoduto RAG para avaliação de riscos financeiros.

2. Caderno de demonstração :

   Abra e execute notebooks/RAG_pipeline_demo.ipynb em um ambiente de notebook Jupyter para ver uma demonstração do pipeline RAG.

3. Análise de dados exploratórios (EDA) :

   Explore o conjunto de dados e execute o EDA usando notebooks/EDA.ipynb .

Configuração

Os arquivos de configuração estão localizados na config/ diretório:

• default_config.yaml : Configurações gerais e configurações de modelo.
• logging_config.yaml : configurações para log e depuração.
• pipeline_config.yaml : configurações específicas para o pipeline RAG.

Teste

Para executar a unidade e os testes de integração, use:

pytest src/tests/

Contribuição

As contribuições são bem -vindas! Abra um problema ou envie uma solicitação de tração no Github.

Licença

Este projeto está licenciado sob a licença do MIT - consulte o arquivo de licença para obter detalhes.

Contato

Para qualquer dúvida ou suporte, entre em contato com [email protected].