Retrieval Augmented Generation Intro Project
1.0.0
The Retireval Augmented Generation（RAG）プロジェクトへようこそ！ ？このプロジェクトの目的は、Jupyterノートブック環境でPythonコードを使用してRAGの実用的なアプリケーションを導入および実証することです。 LlamainDexはここで利用されています。 RAGを学習して実験することは、教育的で楽しいものであるべきだと信じています！ ？
プロジェクトはいくつかのフォルダーに編成されています。
ファイル：このフォルダーには、参照用の重要なファイルが含まれています。
readme.md ：あなたは現在このファイルを読んでいます！プロジェクトの概要を提供します。Intro of Retrieval Augmented Generation (RAG) and application demos_Henry.pdf ：このファイルは背景情報を説明し、RAGを使用した実践的な実験の追加情報を提供します。それは始めるために必見です！ Python_env ：このフォルダーには、 NLP.ymlファイルがあります。このYAMLファイルをインポートして、コードをシームレスに実行するための専用のPython環境を作成します。
コード： codeフォルダーには3つのJupyterノートブックファイルが含まれており、それぞれが異なる実験を表しています。
1_Basic_RAG_Pipeline.ipynb ：このノートブックは、基本的なRAGパイプラインを示しています。これは、Ragの基礎を理解するための素晴らしい出発点です。2_Sentence_window_retrieval.ipynb ：このノートブックでは、ragを使用した文ウィンドウ検索の概念を調査します。 RAGが特定のコンテキストウィンドウから情報を取得する方法を発見してください。3_Auto-merging_Retrieval.ipynb ：このノートブックでは、自動マースの検索と生成プロセスの改善方法について学びます。エキサイティングなもの！データ： dataフォルダーは、検索のために独自の関心のあるドキュメントを保存できる場所です。今のところ、 Henry.txtという名前の例を含めました。ぼろきれを試すために、自分のドキュメントに自由に置き換えてください。
共通：このフォルダー内には、 openAI.envファイルがあります。このファイルにOpenAI APIキーを追加して、OpenAIモデルとのシームレスな対話を可能にすることを忘れないでください。
ぼろきれの旅を始めるには、次の手順に従ってください。
このプロジェクトリポジトリをローカルマシンにクローンまたはダウンロードしてください。
python_envフォルダーにNLP.ymlファイルをインポートして、専用のPython環境を作成します。これにより、すべての依存関係が適切にインストールされます。
commonフォルダーで、 openAI.envファイルを開き、OpenAI APIキーを入力します。このステップは、OpenAIモデルにアクセスするために重要です。
filesフォルダーIntro of Retrieval Augmented Generation (RAG) and application demos_Henry.pdfファイルのイントロを読んで、プロジェクトに慣れてください。重要な背景情報と実践的な実験を提供します。
codeフォルダーで、3つのjupyterノートブックファイル（ 1_Basic_RAG_Pipeline.ipynb 、 2_Sentence_window_retrieval.ipynb 、および3_Auto-merging_Retrieval.ipynb ）を調べます。ノートブックを実行して、Ragが動作しているのを確認してください！
提供された例を変更するか、 dataフォルダーで独自のドキュメントを使用してRAGを試してください。自由に創造的になり、楽しんでください！ ？
おめでとう！現在、検索拡張生成（RAG）を学習、適用し、楽しむために必要な情報とツールを装備しています。このプロジェクトがあなたの好奇心を刺激し、提供されたJupyterノートブックを使用してぼろぼろのエキサイティングな世界を探求することを奨励することを願っています。ハッピージェネレーション！ ？
ご質問がある場合、またはさらにサポートが必要な場合は、お気軽にご連絡ください。あなたのぼろきらの旅を楽しんでください！ ？
