haystack-tutorials

1
{
2
 "cells": [
3
  {
4
   "cell_type": "markdown",
5
   "metadata": {},
6
   "source": [
7
    "# Tutorial: *Give your tutorial a meaningful title starting with an imperative, for example: \"Build Your First QA System\"*\n",
8
    "\n",
9
    "- **Level**: *Who is this tutorial for? Choose one of the options: Beginner, Intermediate, Advanced.*\n",
10
    "- **Time to complete**: *Enter the time it takes to complete this tutorial, in minutes.*\n",
11
    "- **Nodes Used**: *List the nodes used in this tutorial, for example: `FARMReader`.*\n",
12
    "- **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?*"
13
   ]
14
  },
15
  {
16
   "cell_type": "markdown",
17
   "metadata": {},
18
   "source": [
19
    "## Overview\n",
20
    "\n",
21
    "*Here provide a short description of the tutorial. What does it teach? What's its expected outcome?*"
22
   ]
23
  },
24
  {
25
   "cell_type": "markdown",
26
   "metadata": {},
27
   "source": [
28
    "## Preparing the Colab Environment\n",
29
    "\n",
30
    "- [Enable GPU Runtime in Colab](https://docs.haystack.deepset.ai/docs/enabling-gpu-acceleration#enabling-the-gpu-in-colab)\n",
31
    "- [Set logging level to INFO](https://docs.haystack.deepset.ai/docs/log-level)"
32
   ]
33
  },
34
  {
35
   "cell_type": "markdown",
36
   "metadata": {},
37
   "source": [
38
    "## Task 1\n",
39
    "\n",
40
    "*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",
41
    "*Divide your instructions into steps:*\n",
42
    "*1.*\n",
43
    "*2.*\n",
44
    "*3.*"
45
   ]
46
  },
47
  {
48
   "cell_type": "code",
49
   "execution_count": null,
50
   "metadata": {},
51
   "outputs": [],
52
   "source": [
53
    "# Add some code to run, if applicable."
54
   ]
55
  },
56
  {
57
   "cell_type": "markdown",
58
   "metadata": {},
59
   "source": [
60
    "## Task 2"
61
   ]
62
  },
63
  {
64
   "cell_type": "markdown",
65
   "metadata": {},
66
   "source": [
67
    "## Task 3"
68
   ]
69
  },
70
  {
71
   "cell_type": "markdown",
72
   "metadata": {},
73
   "source": [
74
    "## Next Steps\n",
75
    "\n",
76
    "*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.*"
77
   ]
78
  },
79
  {
80
   "cell_type": "markdown",
81
   "metadata": {},
82
   "source": [
83
    "## About us\n",
84
    "\n",
85
    "*Leave this section as is. It's a footer that we add to all our tutorials.*\n",
86
    "\n",
87
    "\n",
88
    "This [Haystack](https://github.com/deepset-ai/haystack/) notebook was made with love by [deepset](https://deepset.ai/) in Berlin, Germany\n",
89
    "\n",
90
    "We bring NLP to the industry via open source!  \n",
91
    "Our focus: Industry specific language models & large scale QA systems.  \n",
92
    "  \n",
93
    "Some of our other work: \n",
94
    "- [German BERT](https://deepset.ai/german-bert)\n",
95
    "- [GermanQuAD and GermanDPR](https://deepset.ai/germanquad)\n",
96
    "\n",
97
    "Get in touch:\n",
98
    "[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",
99
    "\n",
100
    "By the way: [we're hiring!](https://www.deepset.ai/jobs)\n"
101
   ]
102
  }
103
 ],
104
 "metadata": {
105
  "kernelspec": {
106
   "display_name": "Python 3.9.6 64-bit",
107
   "language": "python",
108
   "name": "python3"
109
  },
110
  "language_info": {
111
   "name": "python",
112
   "version": "3.9.6"
113
  },
114
  "orig_nbformat": 4,
115
  "vscode": {
116
   "interpreter": {
117
    "hash": "31f2aee4e71d21fbe5cf8b01ff0e069b9275f58929596ceb00d14d90e3e16cd6"
118
   }
119
  }
120
 },
121
 "nbformat": 4,
122
 "nbformat_minor": 2
123
}
124