Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add RAG Pipeline tutorial for Haystack 2.0 #257

Merged
merged 4 commits into from
Dec 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/run_tutorials.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ jobs:
"tutorials/23_Answering_Multihop_Questions_with_Agents.ipynb"
"tutorials/24_Building_Chat_App.ipynb"
"tutorials/25_Customizing_Agent.ipynb"
"tutorials/27_First_RAG_Pipeline.ipynb"
)
for changed_file in ${{ steps.files.outputs.all_changed_files }}; do
if [[ $changed_file == *".ipynb" ]]; then
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,4 @@ To contribute to the tutorials, please check out our [Contributing Guidelines](.
| [Building a Conversational Chat App](./tutorials/24_Building_Chat_App.ipynb) | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/deepset-ai/haystack-tutorials/blob/main/tutorials/24_Building_Chat_App.ipynb) |
| [Customizing Agent to Chat with Your Documents](./tutorials/25_Customizing_Agent.ipynb) | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/deepset-ai/haystack-tutorials/blob/main/tutorials/25_Customizing_Agent.ipynb) |
| [Creating a Hybrid Retrieval Pipeline](./tutorials/26_Hybrid_Retrieval.ipynb) | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/deepset-ai/haystack-tutorials/blob/main/tutorials/26_Hybrid_Retrieval.ipynb) |
| [Your First QA Pipeline with Retrieval-Augmentation](./tutorials/27_First_RAG_Pipeline.ipynb) | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/deepset-ai/haystack-tutorials/blob/main/tutorials/27_First_RAG_Pipeline.ipynb) |
13 changes: 12 additions & 1 deletion index.toml
Original file line number Diff line number Diff line change
Expand Up @@ -263,4 +263,15 @@ notebook = "26_Hybrid_Retrieval.ipynb"
aliases = ["hybrid-retrieval"]
completion_time = "15 min"
created_at = 2023-10-10
featured = true
featured = true

[[tutorial]]
title = "Creating Your First QA Pipeline with Retrieval-Augmentation"
description = "Build your first generative QA pipeline with OpenAI GPT models"
level = "beginner"
weight = 5
notebook = "27_First_RAG_Pipeline.ipynb"
aliases = []
completion_time = "10 min"
created_at = 2023-12-05
haystack_2 = true
1 change: 1 addition & 0 deletions scripts/generate_markdowns.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ def generate_frontmatter(config, tutorial):
layout: {config["layout"]}
featured: {tutorial.get("featured", False)}
haystack_version: "{tutorial.get("haystack_version", "latest")}"
haystack_2: {tutorial.get("haystack_2", False)}
hidden: {tutorial.get("hidden", False)}
sitemap_exclude: {tutorial.get("sitemap_exclude", False)}
colab: {tutorial.get("colab", f'{config["colab"]}{tutorial["notebook"]}')}
Expand Down
4 changes: 4 additions & 0 deletions scripts/generate_matrix.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@ def read_index(path):
# so there's nothing to test
continue

if tutorial.get("haystack_2", False):
# Haystack 2.0 tutorials should be skipped for now
continue

version = tutorial.get("haystack_version", args.version)
if version[0] != "v":
version = f"v{version}"
Expand Down
Loading