Retrieval Augmented Generation Intro Project

Вступление в поисковое образование (RAG) Intro Project ??

Добро пожаловать в проект поиска дополненного поколения (RAG)! ? Этот проект направлен на внедрение и продемонстрирование практических применений RAG с использованием кода Python в ноутбуке Jupyter. LmamainDex используется здесь. Мы считаем, что обучение и экспериментирование с RAG должно быть как образовательным, так и веселым! ?

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

Проект организован в несколько папок:

• Файлы : эта папка содержит важные файлы для вашей ссылки:

  • readme.md : В настоящее время вы читаете этот файл! Он предоставляет обзор проекта.
  • Intro of Retrieval Augmented Generation (RAG) and application demos_Henry.pdf : Этот файл объясняет справочную информацию и предоставляет дополнительную информацию об практических экспериментах с использованием RAG. Это обязательное прочитание, чтобы начать!

• python_env : В этой папке вы найдете файл NLP.yml . Импортируйте этот файл YAML, чтобы создать выделенную среду Python для плавного запуска кода.

• Код : папка code содержит три файла ноутбука Jupyter, каждый из которых представляет собой другой эксперимент:

  • 1_Basic_RAG_Pipeline.ipynb : этот ноутбук демонстрирует основной тряпичный трубопровод. Это отличная отправная точка для понимания основ тряпки.
  • 2_Sentence_window_retrieval.ipynb : В этой записной книжке исследуется концепция поиска окна предложения с использованием Rag. Узнайте, как тряпка может получить информацию из определенного окна контекста.
  • 3_Auto-merging_Retrieval.ipynb : в этой ноутбуке вы узнаете о поиске автоматического получения и о том, как он улучшает процесс генерации. Захватывающие вещи!

• Данные : папка data - это то, где вы можете хранить свои собственные документы, представляющие интерес для поиска. На данный момент мы включили пример файла с именем Henry.txt . Не стесняйтесь заменить его собственными документами, чтобы экспериментировать с тряпкой.

• Общее : Внутри этой папки вы найдете файл openAI.env . Не забудьте добавить свой ключ API OpenAI в этот файл, чтобы обеспечить бесшовное взаимодействие с моделями OpenAI.

Начиная

Чтобы начать свое путешествие по тряпке, следуйте этим шагам:

1. Клонировать или загрузить этот репозиторий проекта на местную машину.

2. Импортируйте файл NLP.yml в папке python_env , чтобы создать выделенную среду Python. Это гарантирует, что все зависимости будут правильно установлены.

3. В common папке откройте файл openAI.env и введите свой ключ API OpenAI. Этот шаг имеет решающее значение для доступа к моделям OpenAI.

4. Ознакомьтесь с проектом, прочитав Intro of Retrieval Augmented Generation (RAG) and application demos_Henry.pdf в папке files . Он предоставляет важную справочную информацию и практические эксперименты.

5. Исследуйте три файла ноутбука Jupyter ( 1_Basic_RAG_Pipeline.ipynb , 2_Sentence_window_retrieval.ipynb и 3_Auto-merging_Retrieval.ipynb ) в папке code . Запустите ноутбуки, чтобы увидеть тряпку в действии!

6. Экспериментируйте с RAG, изменяя предоставленные примеры или используя свои собственные документы в папке data . Не стесняйтесь проявлять творческий подход и повеселиться с этим! ?

Заключение ?

Поздравляю! Теперь вы оснащены необходимой информацией и инструментами для обучения, применения и удовольствия от поиска дополненного поколения (RAG). Мы надеемся, что этот проект вызывает ваше любопытство и побуждает вас исследовать захватывающий мир тряпки, используя предоставленные ноутбуки Jupyter. Счастливого генерирования! ?

Если у вас есть какие -либо вопросы или вам нужна дополнительная помощь, пожалуйста, не стесняйтесь обращаться. Наслаждайтесь своим тряпным путешествием! ?