Skip to content

Adjust the template to reflect the most recent cookbooks #448

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.

Sign up for GitHub

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

Open
kacperlukawski wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −21
Open

Adjust the template to reflect the most recent cookbooks #448

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
31 changes: 10 additions & 21 deletions tutorials/template.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
"\n",
"- **Level**: *Who is this tutorial for? Choose one of the options: Beginner, Intermediate, Advanced.*\n",
"- **Time to complete**: *Enter the time it takes to complete this tutorial, in minutes.*\n",
"- **Nodes Used**: *List the nodes used in this tutorial, for example: `FARMReader`.*\n",
"- **Components Used**: *List the Haystack components used, with links to docs, for example: [`OpenAIChatGenerator`](https://docs.haystack.deepset.ai/docs/openaichatgenerator).*\n",
"- **Prerequisites**: *List prerequisites, for example: OpenAI API key. Or write \"None\".*\n",
"- **Goal**: After completing this tutorial, you will have achieved/learned about.. *here state the goal of the tutorial. What will the users have done when they complete it?*"
]
},
Expand All @@ -25,10 +26,9 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## Task 1\n",
"## Installing Haystack\n",
"\n",
"*Divide your tutorial into tasks. Each task is a separate section. The title of the sections should start with a verb in the -ing form, for example: Installing Haystack, Preparing the Collab Environment, and so on.*\n",
"*Divide your instructions into steps:*\n",
"*Rename this section and all subsequent task sections with a descriptive -ing verb phrase (for example: Installing Haystack, Initializing the DocumentStore, Building the Pipeline). Divide your instructions into steps:*\n",
"*1.*\n",
"*2.*\n",
"*3.*"
Expand All @@ -46,22 +46,18 @@
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Task 2"
]
"source": "## Task 2"
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Task 3"
]
"source": "## Task 3"
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Next Steps\n",
"## What's next\n",
"\n",
"*Are there any pages, tutorials, or guides that could be useful to read after completing this tutorial? Are there any other tasks the user should complete now? If yes, list them here. If no, delete this section.*"
]
Expand All @@ -75,19 +71,12 @@
"*Leave this section as is. It's a footer that we add to all our tutorials.*\n",
"\n",
"\n",
"This [Haystack](https://github.com/deepset-ai/haystack/) notebook was made with love by [deepset](https://deepset.ai/) in Berlin, Germany\n",
"🎉 Congratulations! You've completed this tutorial!\n",
"\n",
"We bring NLP to the industry via open source! \n",
"Our focus: Industry specific language models & large scale QA systems. \n",
" \n",
"Some of our other work: \n",
"- [German BERT](https://deepset.ai/german-bert)\n",
"- [GermanQuAD and GermanDPR](https://deepset.ai/germanquad)\n",
"To stay up to date on the latest Haystack developments, you can [sign up for our newsletter](https://landing.deepset.ai/haystack-community-updates) or [join Haystack Discord community](https://discord.com/invite/xYvH6drSmA).\n",
"\n",
"Get in touch:\n",
"[Twitter](https://twitter.com/deepset_ai) | [LinkedIn](https://www.linkedin.com/company/deepset-ai/) | [Discord](https://discord.com/invite/VBpFzsgRVF) | [GitHub Discussions](https://github.com/deepset-ai/haystack/discussions) | [Haystack Website](https://deepset.ai)\n",
"\n",
"By the way: [we're hiring!](https://www.deepset.ai/jobs)\n"
"[X](https://x.com/Haystack_AI) | [LinkedIn](https://www.linkedin.com/showcase/haystack-ai-framework/) | [Discord](https://discord.com/invite/xYvH6drSmA) | [GitHub Discussions](https://github.com/deepset-ai/haystack/discussions) | [Haystack Website](https://haystack.deepset.ai)\n"
]
}
],
Expand Down