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

Fix/turtorials typo and bugs #108

Merged
merged 12 commits into from
Dec 12, 2024
8 changes: 4 additions & 4 deletions docs/tutorial/algebraic_operator.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Write Hamiltonian algebraically\n",
"# Write Hamiltonian Algebraically\n",
"This tutorial explains how to create a Qamomile Hamiltonian using an algebraic modeler `jijmodeling`.\n",
"\n",
"Using this functionality will allow you to create Hamiltonians in a more intuitive way."
Expand All @@ -24,8 +24,8 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## Write algebraic Hamiltonian\n",
"Let us write Heisenberg model without the exiternal field with periodic boundary condition by using qamomile modeler in this tutorial.\n",
"## Write Algebraic Hamiltonian\n",
"Let us write Heisenberg model without the external field with periodic boundary condition by using qamomile modeler in this tutorial.\n",
"\n",
"To define Pauli Operator Expression we need to use `qm_m.PauliExpr`.\n",
"In the Heisenberg model, there are $X$, $Y$ and $Z$ Pauli Operator, so let us define them first."
Expand Down Expand Up @@ -106,7 +106,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## Build Qamomile Hamiltonian from algebraic Hamiltonian Expression\n",
"## Build Qamomile Hamiltonian from Algebraic Hamiltonian Expression\n",
"We can build qamomile `Hamiltonian` by inserting the value into `HamiltonianExpr`.\n",
"\n",
"Let us create some data to insert first. \n",
Expand Down
123 changes: 67 additions & 56 deletions docs/tutorial/alternating_ansatz_graph_coloring.ipynb

Large diffs are not rendered by default.

59 changes: 32 additions & 27 deletions docs/tutorial/building_quantum_circuits.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,25 @@
"\n",
"## Introduction\n",
"Welcome to this tutorial on building quantum circuits with Qamomile! While Qamomile is primarily designed for quantum optimization tasks, it also offers powerful capabilities for constructing arbitrary quantum circuits. This tutorial will guide you through the process of creating and manipulating quantum circuits using Qamomile's unique intermediate representation.\n",
"Prerequisites\n",
"Before we begin, make sure you have:\n",
"\n",
"## Qamomile installed in your Python environment\n",
"Basic understanding of quantum computing concepts\n",
"Familiarity with Python programming\n",
"\n",
"## Prerequisites\n",
"Before we begin, make sure you have:\n",
"\n",
"- Qamomile Installed in your Python Environment\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Getting Started\n",
"First, let's import the necessary modules from Qamomile:"
]
},
{
"cell_type": "code",
"execution_count": 40,
"execution_count": 1,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -38,7 +43,7 @@
},
{
"cell_type": "code",
"execution_count": 41,
"execution_count": 2,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -55,7 +60,7 @@
},
{
"cell_type": "code",
"execution_count": 42,
"execution_count": 3,
"metadata": {},
"outputs": [],
"source": [
Expand Down Expand Up @@ -87,7 +92,7 @@
},
{
"cell_type": "code",
"execution_count": 43,
"execution_count": 4,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -104,7 +109,7 @@
},
{
"cell_type": "code",
"execution_count": 44,
"execution_count": 5,
"metadata": {},
"outputs": [
{
Expand Down Expand Up @@ -135,7 +140,7 @@
},
{
"cell_type": "code",
"execution_count": 45,
"execution_count": 6,
"metadata": {},
"outputs": [
{
Expand Down Expand Up @@ -173,7 +178,7 @@
},
{
"cell_type": "code",
"execution_count": 46,
"execution_count": 7,
"metadata": {},
"outputs": [
{
Expand Down Expand Up @@ -208,7 +213,7 @@
},
{
"cell_type": "code",
"execution_count": 47,
"execution_count": 8,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -225,7 +230,7 @@
},
{
"cell_type": "code",
"execution_count": 48,
"execution_count": 9,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -241,7 +246,7 @@
},
{
"cell_type": "code",
"execution_count": 49,
"execution_count": 10,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -257,7 +262,7 @@
},
{
"cell_type": "code",
"execution_count": 50,
"execution_count": 11,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -275,16 +280,16 @@
},
{
"cell_type": "code",
"execution_count": 51,
"execution_count": 12,
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"{'01': 510, '10': 490}"
"{'01': 504, '10': 496}"
]
},
"execution_count": 51,
"execution_count": 12,
"metadata": {},
"output_type": "execute_result"
}
Expand All @@ -306,7 +311,7 @@
},
{
"cell_type": "code",
"execution_count": 52,
"execution_count": 13,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -326,7 +331,7 @@
},
{
"cell_type": "code",
"execution_count": 53,
"execution_count": 14,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -340,16 +345,16 @@
},
{
"cell_type": "code",
"execution_count": 54,
"execution_count": 15,
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"Counter({1: 530, 2: 470})"
"Counter({1: 504, 2: 496})"
]
},
"execution_count": 54,
"execution_count": 15,
"metadata": {},
"output_type": "execute_result"
}
Expand All @@ -376,7 +381,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "qamomile-s0Pfpxir-py3.10",
"display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
},
Expand All @@ -390,9 +395,9 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.13"
"version": "3.10.6"
}
},
"nbformat": 4,
"nbformat_minor": 2
"nbformat_minor": 4
}
253 changes: 56 additions & 197 deletions docs/tutorial/graph_partition.ipynb

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/tutorial/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Welcome to the Qamomile tutorial! This guide will help you get started with Qamo

- **Qiskit**
- **Quri-parts**

- **Qutip**


## Tutorials
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you also update the title to "Write Hamiltonian Algebraically"?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed

Expand Down
63 changes: 31 additions & 32 deletions docs/tutorial/vertex_cover.ipynb

Large diffs are not rendered by default.

Loading