Skip to content

Commit 02f869a

Browse files
authored
Cleanup: header levels, missing comma in code, add 'citation' (#3886)
Closes some small PRs - fixes #3845 fixes #3782 fixes #3629
1 parent ca05021 commit 02f869a

File tree

4 files changed

+22
-21
lines changed

4 files changed

+22
-21
lines changed

docs/migration-guides/classic-iqp-to-cloud-iqp.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ QiskitRuntimeService.save_account(
132132
channel="ibm_quantum_platform", # `channel` distinguishes between different account types.
133133
instance="instance-CRN or instance-name", # Optionally copy the instance CRN or name from the Instance section on the dashboard.
134134
name="account-name", # Optionally name this set of credentials.
135-
overwrite=True # Only needed if you already have Cloud credentials.
135+
overwrite=True, # Only needed if you already have Cloud credentials.
136136
set_as_default=True # Only needed if you want these credentials to be used as the default account.
137137
# This is recommended if you have an IQP classic account set as the default.
138138
)

docs/support/faq.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ For research papers, we encourage authors to acknowledge IBM Quantum® by usi
1717

1818
> We acknowledge the use of IBM Quantum services for this work. The views expressed are those of the authors, and do not reflect the official policy or position of IBM or the IBM Quantum team.
1919
20-
Paper references should be cited as follows:
20+
Paper references should use the following citation:
2121

2222
> IBM Quantum. https://<span>quantum.cloud.ibm.com</span>/, YYYY
2323
@@ -33,7 +33,7 @@ Example of citing an IBM Quantum program:
3333
3434
## How do I cite IBM Quantum Composer in my research?
3535

36-
Example of citing IBM Quantum Composer:
36+
Example citation for IBM Quantum Composer:
3737

3838
> IBM Quantum Composer. 2025. url: https://<span>quantum.cloud.ibm.com/composer</span>
3939

docs/tutorials/compilation-methods-for-hamiltonian-simulation-circuits.ipynb

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,9 @@
109109
"id": "c3a31b4d-d679-4657-b372-ba19bcaf8eca",
110110
"metadata": {},
111111
"source": [
112-
"# Part 1: Efficient SU2 Circuit\n",
112+
"## Part 1: Efficient SU2 Circuit\n",
113113
"\n",
114-
"## Step 1: Map classical inputs to a quantum problem\n",
114+
"### Step 1: Map classical inputs to a quantum problem\n",
115115
"\n",
116116
"In this section, we explore the `efficient_su2` circuit, a hardware-efficient ansatz commonly used in variational quantum algorithms (such as VQE) and quantum machine-learning tasks. The circuit consists of alternating layers of single-qubit rotations and entangling gates arranged in a circular pattern, designed to explore the quantum state space effectively while maintaining manageable depth.\n",
117117
"\n",
@@ -153,7 +153,7 @@
153153
"id": "d6671456-9b17-42bb-b94a-d42a29e6fad9",
154154
"metadata": {},
155155
"source": [
156-
"## Step 2: Optimize problem for quantum hardware execution\n",
156+
"### Step 2: Optimize problem for quantum hardware execution\n",
157157
"\n",
158158
"This step is the main focus of the tutorial. Here, we aim to optimize quantum circuits for efficient execution on real quantum hardware. Our primary objective is to reduce circuit depth and gate count, which are key factors in improving execution fidelity and mitigating hardware noise.\n",
159159
"\n",
@@ -277,7 +277,7 @@
277277
"id": "a16c8082-d0f1-462f-ad10-ebd7d87a0d82",
278278
"metadata": {},
279279
"source": [
280-
"### Transpile and capture metrics\n",
280+
"#### Transpile and capture metrics\n",
281281
"\n",
282282
"To compare the performance of the compilation methods, we define a function that transpiles the input circuit and captures relevant metrics in a consistent manner. This includes the total circuit depth, overall gate count, and transpilation time.\n",
283283
"\n",
@@ -800,7 +800,7 @@
800800
"id": "167834f1-00a7-4190-99e4-d221d1952357",
801801
"metadata": {},
802802
"source": [
803-
"### Results graph\n",
803+
"#### Results graph\n",
804804
"\n",
805805
"As we define a function to consistently capture metrics, we will also define one to graph the metrics. Here, we will plot the two-qubit depth, gate count, and runtime for each compilation method across the circuits."
806806
]
@@ -909,7 +909,7 @@
909909
"id": "f75e8e3a-803f-4386-a60a-b088faa3c81a",
910910
"metadata": {},
911911
"source": [
912-
"### Analysis of SU2 circuit compilation results\n",
912+
"#### Analysis of SU2 circuit compilation results\n",
913913
"\n",
914914
"In this experiment, we compare two transpilation methods — Qiskit's SABRE transpiler and the AI-powered transpiler — on a set of `efficient_su2` circuits. Since these circuits do not include any `PauliEvolutionGate` operations, the Rustiq plugin is not included in this comparison.\n",
915915
"\n",
@@ -928,19 +928,19 @@
928928
"id": "4c3b2aa8-8187-488a-8e5b-197cf26085bb",
929929
"metadata": {},
930930
"source": [
931-
"# Part 2: Hamiltonian simulation circuit\n",
931+
"## Part 2: Hamiltonian simulation circuit\n",
932932
"\n",
933-
"## Step 1: Investigate circuits with `PauliEvolutionGate`\n",
933+
"### Step 1: Investigate circuits with `PauliEvolutionGate`\n",
934934
"\n",
935935
"In this section, we investigate quantum circuits constructed using `PauliEvolutionGate`, which enables efficient simulation of Hamiltonians. We will analyze how different compilation methods optimize these circuits across various Hamiltonians.\n",
936936
"\n",
937-
"### Hamiltonians used in the benchmark\n",
937+
"#### Hamiltonians used in the benchmark\n",
938938
"\n",
939939
"The Hamiltonians used in this benchmark describe pairwise interactions between qubits, including terms such as $ZZ$, $XX$, and $YY$. These Hamiltonians are commonly used in quantum chemistry, condensed matter physics, and materials science, where they model systems of interacting particles.\n",
940940
"\n",
941941
"For reference, users can explore a broader set of Hamiltonians in this paper: [Efficient Hamiltonian Simulation on Noisy Quantum Devices](https://arxiv.org/pdf/2306.13126).\n",
942942
"\n",
943-
"### Benchmark source: Hamlib and Benchpress\n",
943+
"#### Benchmark source: Hamlib and Benchpress\n",
944944
"\n",
945945
"The circuits used in this benchmark are drawn from the [Hamlib benchmark repository](https://github.com/SRI-International/QC-App-Oriented-Benchmarks/tree/master/hamlib), which contains realistic Hamiltonian simulation workloads.\n",
946946
"\n",
@@ -1011,7 +1011,7 @@
10111011
"id": "9690d94d-7d38-45d3-b37d-85eaf268dbd6",
10121012
"metadata": {},
10131013
"source": [
1014-
"## Step 2: Optimize problem for quantum hardware execution\n",
1014+
"### Step 2: Optimize problem for quantum hardware execution\n",
10151015
"\n",
10161016
"As in the previous example, we will use the same backend to ensure consistency in our comparisons. Since the pass managers (`pm_sabre`, `pm_ai`, and `pm_rustiq`) have already been initialized, we can directly proceed with transpiling the Hamiltonian circuits using each method.\n",
10171017
"\n",
@@ -1535,7 +1535,7 @@
15351535
"id": "e4f6aa23-d528-4d66-92e0-31d29c522792",
15361536
"metadata": {},
15371537
"source": [
1538-
"### Analysis of Hamiltonian circuit compilation results\n",
1538+
"#### Analysis of Hamiltonian circuit compilation results\n",
15391539
"\n",
15401540
"In this section, we evaluate the performance of three transpilation methods — SABRE, the AI-powered transpiler, and Rustiq — on quantum circuits constructed with `PauliEvolutionGate`, which are commonly used in Hamiltonian simulation tasks.\n",
15411541
"\n",
@@ -1564,7 +1564,7 @@
15641564
"id": "9a747477-1dc1-4706-b844-d29570fb5844",
15651565
"metadata": {},
15661566
"source": [
1567-
"## Step 3: Execute using Qiskit primitives"
1567+
"### Step 3: Execute using Qiskit primitives"
15681568
]
15691569
},
15701570
{
@@ -1580,7 +1580,7 @@
15801580
"id": "bb4c4c67-a7e8-4ca1-a5d6-908a2e1d27e5",
15811581
"metadata": {},
15821582
"source": [
1583-
"## Step 4: Post-process and return result in desired classical format"
1583+
"### Step 4: Post-process and return result in desired classical format"
15841584
]
15851585
},
15861586
{
@@ -1597,6 +1597,7 @@
15971597
"metadata": {},
15981598
"source": [
15991599
"## References\n",
1600+
"\n",
16001601
"[1] \"LightSABRE: A Lightweight and Enhanced SABRE Algorithm\". H. Zou, M. Treinish, K. Hartman, A. Ivrii, J. Lishman et al. https://arxiv.org/abs/2409.08368\n",
16011602
"\n",
16021603
"[2] \"Practical and efficient quantum circuit synthesis and transpiling with Reinforcement Learning\". D. Kremer, V. Villar, H. Paik, I. Duran, I. Faro, J. Cruz-Benito et al. https://arxiv.org/abs/2405.13196\n",

docs/tutorials/global-data-quantum-optimizer.ipynb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@
9090
"id": "ab6114f0-fad3-4f44-809d-3ff966f2b2ea",
9191
"metadata": {},
9292
"source": [
93-
"# Setup"
93+
"## Setup"
9494
]
9595
},
9696
{
@@ -125,7 +125,7 @@
125125
"id": "0856b7ca-8cf5-457d-ac08-df83a02852af",
126126
"metadata": {},
127127
"source": [
128-
"# Step 1: Read the input portfolio\n",
128+
"## Step 1: Read the input portfolio\n",
129129
"\n",
130130
"In this step, we load historical data for the seven selected assets from the IBEX 35 index, specifically from **November 1, 2022** to **April 1, 2023**.\n",
131131
"\n",
@@ -234,7 +234,7 @@
234234
"id": "fbd9f5aa-dc2d-48bb-805f-ae0d55aedc54",
235235
"metadata": {},
236236
"source": [
237-
"# Step 2: Define the problem inputs"
237+
"## Step 2: Define the problem inputs"
238238
]
239239
},
240240
{
@@ -358,7 +358,7 @@
358358
"id": "7bc6ac05-5c0b-418e-9978-8dd5bdcd97c4",
359359
"metadata": {},
360360
"source": [
361-
"# Step 3: Analyze the optimization results"
361+
"## Step 3: Analyze the optimization results"
362362
]
363363
},
364364
{

0 commit comments

Comments
 (0)