Skip to content

Commit ced1ebd

Browse files
authored
[Docs] Tweaks to tutorial
- Add download links. - Fix tutorial title. - Fix table of contents.
1 parent 911f862 commit ced1ebd

5 files changed

Lines changed: 20 additions & 9 deletions

examples/tutorial 1 - Using a Quantum Device to Extract Machine-Learning Features.ipynb

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
"source": [
77
"# Tutorial 1: using a Quantum Device to extract machine-learning features\n",
88
"\n",
9+
"(download this tutorial [here](https://github.com/pasqal-io/quantum-evolution-kernel/blob/main/examples/tutorial%201%20-%20Using%20a%20Quantum%20Device%20to%20Extract%20Machine-Learning%20Features.ipynb))\n",
10+
"\n",
911
"The companion library is a machine-learning tool that uses a quantum device to predict similarities and properties of graphs. In this tutorial, we will reproduce first part of the [QEK paper](https://journals.aps.org/pra/abstract/10.1103/PhysRevA.107.042615) using the library's high-level API. The high-level goal of this tutorial is to predict toxicity properties of molecules, using quantum machine learning, but of course, the mechanisms involved are much more generic.\n",
1012
"\n",
1113
"By the end of this notebook, you will know how to:\n",
@@ -97,7 +99,7 @@
9799
"cell_type": "markdown",
98100
"metadata": {},
99101
"source": [
100-
"# Creating and executing a feature extractor from an emulator\n",
102+
"## Creating and executing a feature extractor from an emulator\n",
101103
"\n",
102104
"The easiest way to process a graph is to compile and execute it for an emulator. QEK is built on top of Pulser, which provides several emulators. The simplest of these emulators is the `QutipEmulator`, which QEK uses for the `QutipExtractor`:"
103105
]
@@ -162,7 +164,7 @@
162164
"cell_type": "markdown",
163165
"metadata": {},
164166
"source": [
165-
"# Creating and executing a feature extractor on a physical QPU\n",
167+
"## Creating and executing a feature extractor on a physical QPU\n",
166168
"\n",
167169
"Once you have checked that low qubit sequences provide the results you expect on an emulator, you will generally want to move to a QPU.\n",
168170
"For this, you will need either physical access to a QPU, or an account with [PASQAL Cloud](https://docs.pasqal.cloud), which provides\n",
@@ -344,7 +346,7 @@
344346
"cell_type": "markdown",
345347
"metadata": {},
346348
"source": [
347-
"# What now?\n",
349+
"## What now?\n",
348350
"\n",
349351
"What we have seen so far covers the use of a Quantum Device to extract machine-learning features.\n",
350352
"\n",

examples/tutorial 1a - Using a Quantum Device to Extract Machine-Learning Features - low-level.ipynb

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
"cell_type": "markdown",
55
"metadata": {},
66
"source": [
7-
"# Tutorial 1: using a Quantum Device to extract machine-learning features\n",
7+
"# Tutorial 1 (low-level variant): using a Quantum Device to extract machine-learning features\n",
8+
"\n",
9+
"(download this tutorial [here](https://github.com/pasqal-io/quantum-evolution-kernel/blob/main/examples/tutorial%201a%20-%20Using%20a%20Quantum%20Device%20to%20Extract%20Machine-Learning%20Features%20-%20low-level.ipynb))\n",
810
"\n",
911
"This notebook reproduces the first part of the [QEK paper](https://journals.aps.org/pra/abstract/10.1103/PhysRevA.107.042615) using the library's low-level API.\n",
1012
"\n",
@@ -188,7 +190,7 @@
188190
"metadata": {},
189191
"source": [
190192
"\n",
191-
"# Executing the compiled graphs on an emulator\n",
193+
"## Executing the compiled graphs on an emulator\n",
192194
"\n",
193195
"While our objective is to run the compiled graphs on a physical QPU, it is generally a good idea to test out some of these compiled graphs on an emulator first. For this example, we'll use the QutipEmulator, the simplest emulator provided with Pulser."
194196
]
@@ -233,7 +235,7 @@
233235
"cell_type": "markdown",
234236
"metadata": {},
235237
"source": [
236-
"# Executing compiled graphs on a QPU\n",
238+
"## Executing compiled graphs on a QPU\n",
237239
"\n",
238240
"Once you have checked that the compiled graphs work on an emulator, you will probably want to move to a QPU. Execution on a QPU takes\n",
239241
"resources polynomial in the number of qubits, which hopefully means an almost exponential speedup for large number of qubits.\n",
@@ -413,7 +415,7 @@
413415
"cell_type": "markdown",
414416
"metadata": {},
415417
"source": [
416-
"# What now?\n",
418+
"## What now?\n",
417419
"\n",
418420
"What we have seen so far covers the use of a Quantum Device to extract machine-learning features.\n",
419421
"\n",

examples/tutorial 1b - Training SVM QEK - low-level - generic dataset.ipynb

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@
44
"cell_type": "markdown",
55
"metadata": {},
66
"source": [
7-
"## Tutorial 1b: Training a SVM using QEK\n",
7+
"## Tutorial 2 (variant): Training a SVM using QEK\n",
8+
"\n",
9+
"(download this tutorial [here](https://github.com/pasqal-io/quantum-evolution-kernel/blob/main/examples/tutorial%201b%20-%20Training%20SVM%20QEK%20-%20low-level%20-%20generic%20dataset.ipynb))\n",
10+
"\n",
811
"\n",
912
"This tutorial demonstrates how to create a classification model using the QEK kernel with a generic database. By the end of this guide, you will know how to:\n",
1013
"\n",

examples/tutorial 2 - Machine-Learning with the Quantum EvolutionKernel.ipynb

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@
55
"id": "80370a5d",
66
"metadata": {},
77
"source": [
8-
"# Tutorial 2: Quantum Evolution Kernel-Based Machine Learning Tutorial"
8+
"# Tutorial 2: Quantum Evolution Kernel-Based Machine Learning Tutorial\n",
9+
"\n",
10+
"(download this tutorial [here](https://github.com/pasqal-io/quantum-evolution-kernel/blob/main/examples/tutorial%202%20-%20Machine-Learning%20with%20the%20Quantum%20EvolutionKernel.ipynb))\n"
911
]
1012
},
1113
{

mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ theme:
4646

4747
markdown_extensions:
4848
- admonition # for notes
49+
- pymdownx.details # for collapsible
4950
- pymdownx.arithmatex: # for mathjax
5051
generic: true
5152
- pymdownx.highlight:
@@ -60,6 +61,7 @@ plugins:
6061
- mkdocs-jupyter:
6162
include: ["*.ipynb"]
6263
execute: True
64+
include_source: True
6365
remove_tag_config:
6466
remove_input_tags:
6567
- ignore_warnings

0 commit comments

Comments
 (0)