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

Tutorial restructure draft #44

Closed
wants to merge 51 commits into from
Closed
Show file tree
Hide file tree
Changes from 39 commits
Commits
Show all changes
51 commits
Select commit Hold shift + click to select a range
de0f921
Draft tutorial 1 restructure
brandenchan Oct 11, 2022
e6a5693
Add title
brandenchan Oct 11, 2022
ac87643
Add link
brandenchan Oct 11, 2022
a2c3f36
Fix titles
brandenchan Oct 11, 2022
9d128a3
Add final message
brandenchan Oct 11, 2022
acad49e
Fix some links
brandenchan Oct 13, 2022
04470d7
Incorporate reviewer feedback
brandenchan Oct 13, 2022
d1a0524
Incorporate reviewer feedback
brandenchan Oct 14, 2022
b558a66
Regenerate markdown
brandenchan Oct 14, 2022
b99af07
Create second tutorial
brandenchan Oct 25, 2022
464ba3c
Clear output
brandenchan Nov 1, 2022
1ea723e
Create finetuning tutorial
brandenchan Nov 2, 2022
3dd310d
Create distillation tutorial
brandenchan Nov 2, 2022
8e4cc8b
Rename tutorial
brandenchan Nov 2, 2022
080b588
Test and refine distillation tutorial
brandenchan Nov 3, 2022
8b8d792
Fix first tutorial
brandenchan Nov 3, 2022
fbf252e
Run and test tutorial 2
brandenchan Nov 3, 2022
2411b4e
Run and test tutorial 3
brandenchan Nov 3, 2022
a8bfce2
Run and test tutorial 3
brandenchan Nov 3, 2022
b939038
Run and test tutorial 4
brandenchan Nov 3, 2022
f3d24c6
Rename tutorial 4
brandenchan Nov 4, 2022
f0f57a4
Oxford comma
brandenchan Nov 4, 2022
0daaaa4
Incorporate reviewer feedback for tutorial 2
brandenchan Nov 8, 2022
babafeb
Merge branch 'tutorial_restructure_draft' of https://github.com/deeps…
brandenchan Nov 8, 2022
4a8334b
Incorporate reviewer feedback for tutorial 3
brandenchan Nov 8, 2022
e3db636
Incorporate reviewer feedback for tutorial 4
brandenchan Nov 8, 2022
405ed89
Move new tutorials into folder
brandenchan Nov 14, 2022
dff7aae
Merge main
brandenchan Nov 14, 2022
fba5806
Update index
brandenchan Nov 14, 2022
0ed9fd7
Remove prereqs
brandenchan Nov 14, 2022
4c711fa
Regenerate markdowns
brandenchan Nov 14, 2022
0eb9de3
Update index.toml
brandenchan Nov 16, 2022
a7318c5
Update index.toml
brandenchan Nov 16, 2022
7e7b4f3
Update tutorials/03_finetune_a_reader.ipynb
brandenchan Nov 16, 2022
7c437c4
Update tutorials/03_finetune_a_reader.ipynb
brandenchan Nov 16, 2022
f04a193
Incorporate Reviewer feedback
brandenchan Nov 16, 2022
627ec52
Regenerate markdown
brandenchan Nov 16, 2022
a52d1bc
Edit colab env setup sections
brandenchan Nov 16, 2022
2dc469a
Regenerate MD files
brandenchan Nov 16, 2022
11b1d33
Incorporate reviewer feedback
brandenchan Nov 22, 2022
f4c77f6
Set use_bm25 argument
brandenchan Nov 23, 2022
65fa864
Merge main
brandenchan Nov 29, 2022
1843731
Update naming
brandenchan Nov 29, 2022
b785f56
Delete old md and regenerate new md
brandenchan Nov 29, 2022
10d3329
Update index.toml and readme
brandenchan Nov 29, 2022
1296fc8
minor changes for new tutorial structure
TuanaCelik Nov 30, 2022
f0f90c8
add bm25 and lg updates
agnieszka-m Dec 5, 2022
5776b81
update with bm25
agnieszka-m Dec 6, 2022
fc737de
Update links and retriever
agnieszka-m Dec 6, 2022
0c7bee8
Update links
agnieszka-m Dec 6, 2022
d31cc90
update the gpu links
agnieszka-m Dec 7, 2022
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
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ To contribute to the tutorials please check out our [Contributing Guidelines](./

## Tutorials

1. [Basic QA Pipeline](./tutorials/01_Basic_QA_Pipeline.ipynb)
2. [Fine Tune a Model on Your Data](./tutorials/02_Finetune_a_model_on_your_data.ipynb)
3. [Basic QA Pipeline Without Elasticsearch](./tutorials/03_Basic_QA_Pipeline_without_Elasticsearch.ipynb)
1. [Build Your First Question Answering System](./tutorials/01_build_your_first_question_answering_system.ipynb)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd suggest adding "Tutorial" to the title so that it's clear what it is right from the start. So this one would be: Tutorial: Build Your First.."

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have now added them into the title of the notebooks but I don't think it is necessary to have this in the readme where this numbered list is already entitled "Tutorials".

2. [Build a Scalable Question Answering System](./tutorials/02_build_a_scalable_question_answering_system.ipynb)
3. [Fine-Tune a Reader](./tutorials/03_finetune_a_reader.ipynb)
4. [FAQ Style QA](./tutorials/04_FAQ_style_QA.ipynb)
5. [Evaluation](./tutorials/05_Evaluation.ipynb)
6. [Better Retrieval via Embedding Retrieval](./tutorials/06_Better_Retrieval_via_Embedding_Retrieval.ipynb)
Expand All @@ -36,3 +36,4 @@ To contribute to the tutorials please check out our [Contributing Guidelines](./
17. [Audio](./tutorials/17_Audio.ipynb)
18. [Generative Pseudo Labeling](./tutorials/18_GPL.ipynb)
19. [Text-to-Image search](./tutorials/19_Text_to_Image_search_pipeline_with_MultiModal_Retriever.ipynb)
21. [Distill a Reader](./tutorials/04_distill_a_reader.ipynb)
38 changes: 23 additions & 15 deletions index.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,28 @@ toc = true
colab = "https://colab.research.google.com/github/deepset-ai/haystack-tutorials/blob/main/tutorials/"

[[tutorial]]
title = "Build Your First QA System"
title = "Build Your First Question Answering System"
description = "Get Started by creating a Retriever Reader pipeline."
level = "beginner"
weight = 10
notebook = "01_Basic_QA_Pipeline.ipynb"
aliases = ["first-qa-system"]
notebook = "01_build_your_first_question_answering_system.ipynb"
aliases = ["first-qa-system", "01_Basic_QA_Pipeline.ipynb"]

[[tutorial]]
title = "Fine-Tuning a Model on Your Own Data"
title = "Build a Scalable Question Answering System"
description = "Create a scalable Retriever-Reader pipeline with an Elasticsearch DocumentStore."
level = "beginner"
weight = 15
notebook = "02_build_a_scalable_question_answering_system.ipynb"
aliases = ["without-elasticsearch", "03_Basic_QA_Pipeline_without_Elasticsearch.ipynb", "scalable-qa-system"]

[[tutorial]]
title = "Fine-Tune a Reader"
description = "Improve the performance of your Reader by performing fine-tuning."
brandenchan marked this conversation as resolved.
Show resolved Hide resolved
level = "intermediate"
weight = 50
notebook = "02_Finetune_a_model_on_your_data.ipynb"
aliases = ["fine-tuning-a-model"]

[[tutorial]]
title = "Build a QA System Without Elasticsearch"
description = "Create a Retriever Reader pipeline that requires no external database dependencies."
level = "beginner"
weight = 15
notebook = "03_Basic_QA_Pipeline_without_Elasticsearch.ipynb"
aliases = ["without-elasticsearch"]
notebook = "03_finetune_a_reader.ipynb"
aliases = ["fine-tuning-a-model", "02_Finetune_a_model_on_your_data.ipynb", "fine-tune-reader"]

[[tutorial]]
title = "Utilizing Existing FAQs for Question Answering"
Expand Down Expand Up @@ -153,4 +153,12 @@ description = "Use a MultiModalRetriever to build a cross-modal search pipeline.
level = "intermediate"
weight = 95
notebook = "19_Text_to_Image_search_pipeline_with_MultiModal_Retriever.ipynb"
aliases = ["multimodal"]
aliases = ["multimodal"]

[[tutorial]]
title = "Distill a Reader"
description = "Transfer a Reader's question answering ability to a smaller, more efficient model."
level = "intermediate"
weight = 115
notebook = "21_distill_a_reader.ipynb"
aliases = ["distill-reader"]
Loading