Retrieval Augmented Generation Intro Project

Projeto de Introdução de Geração Aumentada (RAG) Recuperação ??

Bem -vindo ao projeto de geração aumentada de recuperação (RAG)! ? Este projeto tem como objetivo introduzir e demonstrar as aplicações práticas do RAG usando o código Python em um ambiente de notebook Jupyter. O LLlandeindex é utilizado aqui. Acreditamos que aprender e experimentar o RAG deve ser educacional e divertido! ?

Estrutura do projeto

O projeto está organizado em várias pastas:

• Arquivos : Esta pasta contém arquivos importantes para sua referência:

  • readme.md : Você está lendo este arquivo atualmente! Ele fornece uma visão geral do projeto.
  • Intro of Retrieval Augmented Generation (RAG) and application demos_Henry.pdf : Este arquivo explica as informações em segundo plano e fornece informações adicionais de experimentos práticos usando RAG. É uma leitura obrigatória para começar!

• Python_env : Nesta pasta, você encontrará o arquivo NLP.yml . Importe este arquivo YAML para criar um ambiente Python dedicado para executar o código sem problemas.

• Código : A pasta de code contém três arquivos de notebook Jupyter, cada um representando um experimento diferente:

  • 1_Basic_RAG_Pipeline.ipynb : Este notebook demonstra o pipeline básico do RAG. É um ótimo ponto de partida para entender os fundamentos do RAG.
  • 2_Sentence_window_retrieval.ipynb : Este notebook explora o conceito de recuperação da janela de frases usando o RAG. Descubra como o RAG pode recuperar informações de uma janela de contexto específica.
  • 3_Auto-merging_Retrieval.ipynb : Neste notebook, você aprenderá sobre a recuperação de Mergamento automático e como ela melhora o processo de geração. Coisas emocionantes!

• Dados : A pasta data é onde você pode armazenar seus próprios documentos de interesse para recuperação. Por enquanto, incluímos um exemplo de arquivo chamado Henry.txt . Sinta -se à vontade para substituí -lo por seus próprios documentos para experimentar o RAG.

• Comum : Dentro desta pasta, você encontrará o arquivo openAI.env . Não se esqueça de adicionar sua tecla API OpenAI neste arquivo para permitir a interação perfeita com os modelos OpenAI.

Começando

Para começar sua jornada de pano, siga estas etapas:

1. Clone ou faça o download deste repositório de projeto para sua máquina local.

2. Importe o arquivo NLP.yml na pasta python_env para criar um ambiente Python dedicado. Isso garante que todas as dependências sejam instaladas corretamente.

3. Na pasta common , abra o arquivo openAI.env e digite sua chave da API do OpenAI. Esta etapa é crucial para acessar os modelos OpenAI.

4. Familiarize -se com o projeto lendo a Intro of Retrieval Augmented Generation (RAG) and application demos_Henry.pdf na pasta files . Ele fornece informações básicas importantes e experimentos práticos.

5. Explore os três arquivos de notebook Jupyter ( 1_Basic_RAG_Pipeline.ipynb , 2_Sentence_window_retrieval.ipynb e 3_Auto-merging_Retrieval.ipynb ) na pasta code . Execute os notebooks para ver Rag em ação!

6. Experimente o RAG modificando os exemplos fornecidos ou usando seus próprios documentos na pasta de data . Sinta -se à vontade para ser criativo e se divertir com isso! ?

Conclusão?

Parabéns! Agora você está equipado com as informações e ferramentas necessárias para aprender, aplicar e se divertir com a geração aumentada de recuperação (RAG). Esperamos que este projeto desencadeie sua curiosidade e incentive você a explorar o emocionante mundo do RAG usando os notebooks Jupyter fornecidos. Feliz geração! ?

Se você tiver alguma dúvida ou precisar de mais assistência, não hesite em alcançar. Aproveite sua jornada de pano! ?