Skip to content

Commit fe75743

Browse files
authored
[Doc] Reorganizing doc, again (#85)
1 parent c97e896 commit fe75743

File tree

4 files changed

+17
-12
lines changed

4 files changed

+17
-12
lines changed

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ Users setting their first steps into quantum computing will learn how to impleme
1818

1919
The GitHub repository is open for contributions!
2020

21-
Don't forget to read the [Contributor License Agreement](https://github.com/pasqal-io/quantum-evolution-kernel/blob/main/docs/index.md).
21+
Don't forget to read the [Contributor License Agreement](CONTRIBUTOR AGREEMENT.md).

docs/tutorials.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
1-
# Quantum Extraction
1+
# High-Level tutorials
22

3-
These tutorials will teach you how to use the quantum APIs for feature-extraction:
3+
These tutorials will guide you, step-to-step, from loading graphs to machine learning.
44

55
1. [Using a Quantum Device to extract machine-learning features (high-level)](https://github.com/pasqal-io/quantum-evolution-kernel/blob/main/examples/tutorial%201%20-%20Using%20a%20Quantum%20Device%20to%20Extract%20Machine-Learning%20Features.ipynb);
6-
2. [Using a Quantum Device to extract machine-learning features (low-level)](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);
6+
2. [Machine Learning with the Quantum Evolution Kernel](https://github.com/pasqal-io/quantum-evolution-kernel/blob/main/examples/tutorial%202%20-%20Machine-Learning%20with%20the%20Quantum%20EvolutionKernel.ipynb)
77

8-
# Machine Learning
98

10-
1. [Machine Learning with the Quantum Evolution Kernel](https://github.com/pasqal-io/quantum-evolution-kernel/blob/main/examples/tutorial%202%20-%20Machine-Learning%20with%20the%20Quantum%20EvolutionKernel.ipynb)
9+
# Going lower-level
10+
11+
At some point, you may decide that you need more control, or wish to understand better how the pipeline works. These tutorials will guide you through the same features using lower-level APIs.
12+
13+
1. [Using a Quantum Device to extract machine-learning features (low-level)](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);

mkdocs.yml

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,14 @@ repo_name: "Quantum Evolution Kernel"
44

55
nav:
66
- Overview: index.md
7-
- Installation: installation.md
8-
- Usage: usage.md
9-
- Tutorials: tutorials.md
7+
- Getting started:
8+
- Installation: installation.md
9+
- Usage: usage.md
10+
- Tutorials: tutorials.md
1011
- Reference: $api/qek.***
11-
- License: LICENSE.md
12-
- CLA: CONTRIBUTOR AGREEMENT.md
12+
- Open-source:
13+
- Licence (MIT-Derived): LICENSE.md
14+
- Contributor Agreement: CONTRIBUTOR AGREEMENT.md
1315

1416
theme:
1517
name: material

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
66
name = "quantum-evolution-kernel"
77
description = "A Python library designed for the machine learning community to help users design quantum-driven similarity metrics for graphs and to use them inside kernel-based machine learning algorithms for graph data.ide the right environment to explore new ideas - both in terms of methodologies and data domain - while always interacting with a simple and intuitive QPU interface."
88
readme = "README.md"
9-
version = "0.2.8"
9+
version = "0.2.9"
1010
requires-python = ">=3.10,<3.13"
1111
license = { text = "MIT-derived" }
1212
keywords = ["quantum"]

0 commit comments

Comments
 (0)