Skip to content

Commit c276304

Browse files
committed
Remove 1.x tutorials
* Remove 1.x related codes from the workflows * remove haystack_v2 tag
1 parent 79960dd commit c276304

31 files changed

+10
-67166
lines changed

.github/workflows/nightly.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ jobs:
1919
env:
2020
GH_TOKEN: ${{ github.token }}
2121
run: |
22-
# Get tutorial notebooks for v2
22+
# Get tutorial notebooks
2323
VERSION=$(gh api /repos/deepset-ai/haystack/releases | \
2424
jq -r '[.[].tag_name | select(test("^v2.[0-9]+.[0-9]+$"))] | first')
2525
NOTEBOOKS=$(python ./scripts/generate_matrix.py --haystack-version "$VERSION" --include-main)
2626
echo "matrix_v2={\"include\":$NOTEBOOKS}" >> "$GITHUB_OUTPUT"
2727
28-
run-tutorials-v2:
28+
run-tutorials:
2929
needs: generate-matrix
3030
runs-on: ubuntu-latest
3131
container: deepset/haystack:base-${{ matrix.haystack_version }}
Lines changed: 2 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,9 @@
1-
name: Run Haystack 2.x Tutorials
1+
name: Run Haystack Tutorials
22

33
on:
44
pull_request:
55
paths:
66
- "tutorials/*.ipynb"
7-
# Exclude all v1.x tutorials, we can remove this when we drop support for it
8-
- "!tutorials/01_Basic_QA_Pipeline.ipynb"
9-
- "!tutorials/02_Finetune_a_model_on_your_data.ipynb"
10-
- "!tutorials/03_Scalable_QA_System.ipynb"
11-
- "!tutorials/04_FAQ_style_QA.ipynb"
12-
- "!tutorials/05_Evaluation.ipynb"
13-
- "!tutorials/06_Better_Retrieval_via_Embedding_Retrieval.ipynb"
14-
- "!tutorials/07_RAG_Generator.ipynb"
15-
- "!tutorials/08_Preprocessing.ipynb"
16-
- "!tutorials/09_DPR_training.ipynb"
17-
- "!tutorials/10_Knowledge_Graph.ipynb"
18-
- "!tutorials/11_Pipelines.ipynb"
19-
- "!tutorials/12_LFQA.ipynb"
20-
- "!tutorials/13_Question_generation.ipynb"
21-
- "!tutorials/14_Query_Classifier.ipynb"
22-
- "!tutorials/15_TableQA.ipynb"
23-
- "!tutorials/16_Document_Classifier_at_Index_Time.ipynb"
24-
- "!tutorials/17_Audio.ipynb"
25-
- "!tutorials/18_GPL.ipynb"
26-
- "!tutorials/19_Text_to_Image_search_pipeline_with_MultiModal_Retriever.ipynb"
27-
- "!tutorials/20_Using_Haystack_with_REST_API.ipynb"
28-
- "!tutorials/21_Customizing_PromptNode.ipynb"
29-
- "!tutorials/23_Answering_Multihop_Questions_with_Agents.ipynb"
30-
- "!tutorials/22_Pipeline_with_PromptNode.ipynb"
31-
- "!tutorials/24_Building_Chat_App.ipynb"
32-
- "!tutorials/25_Customizing_Agent.ipynb"
33-
- "!tutorials/26_Hybrid_Retrieval.ipynb"
347

358
jobs:
369
generate-matrix:
@@ -48,7 +21,7 @@ jobs:
4821
env:
4922
GH_TOKEN: ${{ github.token }}
5023
run: |
51-
# Get tutorial notebooks for v2
24+
# Get tutorial notebooks
5225
VERSION=$(gh api /repos/deepset-ai/haystack/releases | \
5326
jq -r '[.[].tag_name | select(test("^v2.[0-9]+.[0-9]+$"))] | first')
5427
NOTEBOOKS=$(python ./scripts/generate_matrix.py --haystack-version "$VERSION" --include-main)
@@ -60,34 +33,6 @@ jobs:
6033
with:
6134
matrix: true
6235
files: tutorials/*.ipynb
63-
# Ignore all 1.x tutorials, we can remove this as soon as we drop support for it
64-
files_ignore: |
65-
tutorials/01_Basic_QA_Pipeline.ipynb
66-
tutorials/02_Finetune_a_model_on_your_data.ipynb
67-
tutorials/03_Scalable_QA_System.ipynb
68-
tutorials/04_FAQ_style_QA.ipynb
69-
tutorials/05_Evaluation.ipynb
70-
tutorials/06_Better_Retrieval_via_Embedding_Retrieval.ipynb
71-
tutorials/07_RAG_Generator.ipynb
72-
tutorials/08_Preprocessing.ipynb
73-
tutorials/09_DPR_training.ipynb
74-
tutorials/10_Knowledge_Graph.ipynb
75-
tutorials/11_Pipelines.ipynb
76-
tutorials/12_LFQA.ipynb
77-
tutorials/13_Question_generation.ipynb
78-
tutorials/14_Query_Classifier.ipynb
79-
tutorials/15_TableQA.ipynb
80-
tutorials/16_Document_Classifier_at_Index_Time.ipynb
81-
tutorials/17_Audio.ipynb
82-
tutorials/18_GPL.ipynb
83-
tutorials/19_Text_to_Image_search_pipeline_with_MultiModal_Retriever.ipynb
84-
tutorials/20_Using_Haystack_with_REST_API.ipynb
85-
tutorials/21_Customizing_PromptNode.ipynb
86-
tutorials/23_Answering_Multihop_Questions_with_Agents.ipynb
87-
tutorials/22_Pipeline_with_PromptNode.ipynb
88-
tutorials/24_Building_Chat_App.ipynb
89-
tutorials/25_Customizing_Agent.ipynb
90-
tutorials/26_Hybrid_Retrieval.ipynb
9136

9237
- name: Filter non changed notebooks
9338
id: filter

index.toml

Lines changed: 0 additions & 290 deletions
Original file line numberDiff line numberDiff line change
@@ -3,296 +3,6 @@ layout = "tutorial"
33
toc = true
44
colab = "https://colab.research.google.com/github/deepset-ai/haystack-tutorials/blob/main/tutorials/"
55

6-
[[tutorial]]
7-
title = "Build Your First Question Answering System"
8-
description = "Get Started by creating a Retriever Reader pipeline."
9-
level = "beginner"
10-
weight = 10
11-
notebook = "01_Basic_QA_Pipeline.ipynb"
12-
aliases = [
13-
"first-qa-system",
14-
"without-elasticsearch",
15-
"03_basic_qa_pipeline_without_elasticsearch",
16-
]
17-
completion_time = "15 min"
18-
created_at = 2023-01-11
19-
hidden = true
20-
21-
[[tutorial]]
22-
title = "Fine-Tuning a Model on Your Own Data"
23-
description = "Improve the performance of your Reader by performing fine-tuning."
24-
level = "intermediate"
25-
weight = 50
26-
notebook = "02_Finetune_a_model_on_your_data.ipynb"
27-
aliases = ["fine-tuning-a-model"]
28-
created_at = 2021-08-12
29-
completion_time = "15 min"
30-
needs_gpu = true
31-
hidden = true
32-
33-
[[tutorial]]
34-
title = "Build a Scalable Question Answering System"
35-
description = "Create a scalable Retriever Reader pipeline that uses an ElasticsearchDocumentStore."
36-
level = "beginner"
37-
weight = 15
38-
notebook = "03_Scalable_QA_System.ipynb"
39-
aliases = []
40-
completion_time = "20 min"
41-
created_at = 2023-01-11
42-
hidden = true
43-
44-
[[tutorial]]
45-
title = "Utilizing Existing FAQs for Question Answering"
46-
description = "Create a smarter way to answer new questions using your existing FAQ documents."
47-
level = "beginner"
48-
weight = 20
49-
notebook = "04_FAQ_style_QA.ipynb"
50-
aliases = ["existing-faqs"]
51-
created_at = 2021-08-12
52-
hidden = true
53-
54-
[[tutorial]]
55-
title = "Evaluation of a QA System"
56-
description = "Learn how to evaluate the performance of individual nodes as well as entire pipelines."
57-
level = "advanced"
58-
weight = 105
59-
notebook = "05_Evaluation.ipynb"
60-
aliases = ["evaluation"]
61-
created_at = 2021-08-12
62-
hidden = true
63-
64-
[[tutorial]]
65-
title = "Better Retrieval with Embedding Retrieval"
66-
description = "Use Transformer based dense Retrievers to improve your system’s performance."
67-
level = "intermediate"
68-
weight = 55
69-
notebook = "06_Better_Retrieval_via_Embedding_Retrieval.ipynb"
70-
aliases = ["embedding-retrieval"]
71-
created_at = 2022-03-08
72-
hidden = true
73-
74-
[[tutorial]]
75-
title = "Generative QA with RAGenerator"
76-
description = "Try out a generative model in place of the extractive Reader."
77-
level = "intermediate"
78-
weight = 60
79-
notebook = "07_RAG_Generator.ipynb"
80-
aliases = []
81-
created_at = 2021-08-12
82-
haystack_version = "1.17.2"
83-
hidden = true
84-
sitemap_exclude = true
85-
86-
[[tutorial]]
87-
title = "Preprocessing Your Documents"
88-
description = "Start converting, cleaning, and splitting Documents using Haystack’s preprocessing capabilities."
89-
level = "beginner"
90-
weight = 25
91-
notebook = "08_Preprocessing.ipynb"
92-
aliases = ["preprocessing"]
93-
created_at = 2021-08-12
94-
hidden = true
95-
96-
[[tutorial]]
97-
title = "Training Your Own Dense Passage Retrieval Model"
98-
description = "Learn about training a Dense Passage Retrieval model and the data needed to do so."
99-
level = "advanced"
100-
weight = 110
101-
notebook = "09_DPR_training.ipynb"
102-
aliases = ["train-dpr"]
103-
created_at = 2021-08-12
104-
needs_gpu = true
105-
hidden = true
106-
107-
[[tutorial]]
108-
title = "Question Answering on a Knowledge Graph"
109-
description = "Experiment with a question answering system that draws upon knowledge graph.h"
110-
level = "advanced"
111-
weight = 120
112-
notebook = "10_Knowledge_Graph.ipynb"
113-
aliases = ["knowledge-graph"]
114-
created_at = 2021-08-12
115-
haystack_version = "1.16.1"
116-
hidden = true
117-
sitemap_exclude = true
118-
119-
[[tutorial]]
120-
title = "How to Use Pipelines"
121-
description = "Learn about the many ways which you can route queries through the nodes in a pipeline."
122-
level = "beginner"
123-
weight = 40
124-
notebook = "11_Pipelines.ipynb"
125-
aliases = ["pipelines"]
126-
created_at = 2021-08-12
127-
hidden = true
128-
129-
[[tutorial]]
130-
title = "Generative QA with Seq2SeqGenerator"
131-
description = "Try out a generative model in place of the extractive Reader."
132-
level = "intermediate"
133-
weight = 70
134-
notebook = "12_LFQA.ipynb"
135-
aliases = ["lfqa"]
136-
created_at = 2021-08-12
137-
haystack_version = "1.17.2"
138-
hidden = true
139-
sitemap_exclude = true
140-
141-
[[tutorial]]
142-
title = "Question Generation"
143-
description = "Generate a set of questions that can be answered by a given Document."
144-
level = "intermediate"
145-
weight = 75
146-
notebook = "13_Question_generation.ipynb"
147-
aliases = ["question-generation"]
148-
created_at = 2021-08-12
149-
needs_gpu = true
150-
hidden = true
151-
152-
[[tutorial]]
153-
title = "Query Classifier"
154-
description = "Classify incoming queries so that they can be routed to the nodes that are best at handling them."
155-
level = "intermediate"
156-
weight = 80
157-
notebook = "14_Query_Classifier.ipynb"
158-
aliases = ["query-classifier"]
159-
created_at = 2021-08-12
160-
hidden = true
161-
162-
[[tutorial]]
163-
title = "Open-Domain QA on Tables"
164-
description = "Perform question answering on tabular data."
165-
level = "advanced"
166-
weight = 130
167-
notebook = "15_TableQA.ipynb"
168-
aliases = ["table-qa"]
169-
created_at = 2021-08-12
170-
hidden = true
171-
172-
[[tutorial]]
173-
title = "Document Classification at Index Time"
174-
description = "Generate and attach classification labels to your Documents when indexing."
175-
level = "intermediate"
176-
weight = 85
177-
notebook = "16_Document_Classifier_at_Index_Time.ipynb"
178-
aliases = ["doc-class-index"]
179-
created_at = 2021-08-12
180-
hidden = true
181-
182-
[[tutorial]]
183-
title = "Make Your QA Pipelines Talk!"
184-
description = "Convert text Answers into speech."
185-
level = "intermediate"
186-
weight = 90
187-
notebook = "17_Audio.ipynb"
188-
aliases = ["audio"]
189-
created_at = 2022-06-07
190-
hidden = true
191-
sitemap_exclude = true
192-
193-
[[tutorial]]
194-
title = "Generative Pseudo Labeling for Domain Adaptation"
195-
description = "Use a Retriever and a query generator to perform unsupervised domain adaptation."
196-
level = "advanced"
197-
weight = 140
198-
notebook = "18_GPL.ipynb"
199-
aliases = ["gpl"]
200-
created_at = 2022-06-07
201-
needs_gpu = true
202-
hidden = true
203-
204-
[[tutorial]]
205-
title = "Text-To-Image Search Pipeline with Multimodal Retriever"
206-
description = "Use a MultiModalRetriever to build a cross-modal search pipeline."
207-
level = "intermediate"
208-
weight = 95
209-
notebook = "19_Text_to_Image_search_pipeline_with_MultiModal_Retriever.ipynb"
210-
aliases = ["multimodal"]
211-
completion_time = "20 min"
212-
created_at = 2022-07-11
213-
hidden = true
214-
215-
[[tutorial]]
216-
title = "Using Haystack with REST API"
217-
description = "Create a production-ready pipeline and interact with Haystack REST API."
218-
level = "advanced"
219-
weight = 115
220-
notebook = "20_Using_Haystack_with_REST_API.ipynb"
221-
aliases = ["using-haystack-with-rest-api"]
222-
colab = false
223-
completion_time = "30 min"
224-
created_at = 2023-01-11
225-
hidden = true
226-
227-
[[tutorial]]
228-
title = "Customizing PromptNode for NLP Tasks"
229-
description = "Use PromptNode and PromptTemplate for your custom NLP tasks"
230-
level = "intermediate"
231-
weight = 57
232-
notebook = "21_Customizing_PromptNode.ipynb"
233-
aliases = ["customizing-promptnode"]
234-
completion_time = "20 min"
235-
created_at = 2023-02-16
236-
hidden = true
237-
238-
[[tutorial]]
239-
title = "Answering Multihop Questions with Agents"
240-
description = "Use Agent to answer multihop questions with extractive models"
241-
level = "intermediate"
242-
weight = 63
243-
notebook = "23_Answering_Multihop_Questions_with_Agents.ipynb"
244-
aliases = ["multihop-qa-with-agents"]
245-
completion_time = "10 min"
246-
created_at = 2023-03-27
247-
hidden = true
248-
249-
[[tutorial]]
250-
title = "Creating a Generative QA Pipeline with Retrieval-Augmentation"
251-
description = "Use a large language model in your search system through PromptNode"
252-
level = "intermediate"
253-
weight = 61
254-
notebook = "22_Pipeline_with_PromptNode.ipynb"
255-
aliases = ["pipeline-with-promptnode", "retrieval-augmented-generation"]
256-
completion_time = "15 min"
257-
created_at = 2023-03-13
258-
featured = true
259-
hidden = true
260-
261-
[[tutorial]]
262-
title = "Building a Conversational Chat App"
263-
description = "Use ConversationalAgent to build a human-like chat application"
264-
level = "intermediate"
265-
weight = 64
266-
notebook = "24_Building_Chat_App.ipynb"
267-
aliases = ["building-chat-app"]
268-
completion_time = "10 min"
269-
created_at = 2023-05-30
270-
hidden = true
271-
272-
[[tutorial]]
273-
title = "Customizing Agent to Chat with Your Documents"
274-
description = "Advanced Customizations for Agents with Memory"
275-
level = "advanced"
276-
weight = 117
277-
notebook = "25_Customizing_Agent.ipynb"
278-
aliases = ["customizing-agent"]
279-
completion_time = "15 min"
280-
created_at = 2023-07-19
281-
featured = true
282-
hidden = true
283-
284-
[[tutorial]]
285-
title = "Creating a Hybrid Retrieval Pipeline"
286-
description = "Learn how to combine Retrievers to enhance retrieval"
287-
level = "intermediate"
288-
weight = 63
289-
notebook = "26_Hybrid_Retrieval.ipynb"
290-
aliases = ["hybrid-retrieval"]
291-
completion_time = "15 min"
292-
created_at = 2023-10-10
293-
featured = true
294-
hidden = true
295-
2966
[[tutorial]]
2977
title = "Creating Your First QA Pipeline with Retrieval-Augmentation"
2988
description = "Build your first generative QA pipeline with OpenAI GPT models"

0 commit comments

Comments
 (0)