Skip to content

Commit 892d3f5

Browse files
beckykdabbycross
beckykd
and
abbycross
authored
Fixes for new topics (#2756)
I walked through all of the topics that use cloudcontent tags to make sure there was no funny business. Then I fixed any funny business that I found. --------- Co-authored-by: abbycross <[email protected]>
1 parent 2c344a4 commit 892d3f5

39 files changed

+231
-159
lines changed

‎docs/guides/algorithmiq-tem.ipynb

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,17 @@
1616
"# Tensor-network error mitigation (TEM): A Qiskit Function by Algorithmiq\n",
1717
"\n",
1818
"<LegacyContent>\n",
19-
"<Admonition type=\"note\">\n",
20-
"This documentation is relevant to IBM Quantum&reg; Platform Classic. If you need the newer version, go to the new [IBM Quantum Platform documentation.](https://quantum.cloud.ibm.com/docs/guides/algorithmiq-tem)\n",
19+
"<Admonition type=\"note\" title=\"Notes\">\n",
20+
"* This documentation is relevant to IBM Quantum&reg; Platform Classic. If you need the newer version, go to the new [IBM Quantum Platform documentation.](https://quantum.cloud.ibm.com/docs/guides/algorithmiq-tem)\n",
21+
"* Qiskit Functions are an experimental feature available only to IBM Quantum&reg; Premium Plan users. They are in preview release status and subject to change.\n",
2122
"</Admonition>\n",
2223
"</LegacyContent>\n",
2324
"<CloudContent>\n",
24-
"<Admonition type=\"note\">\n",
25-
"This documentation is relevant to the new IBM Quantum&reg; Platform. If you need the previous version, return to the [IBM Quantum Platform Classic documentation.](https://docs.quantum.ibm.com/guides/algorithmiq-tem)\n",
25+
"<Admonition type=\"note\" title=\"Notes\">\n",
26+
"* This documentation is relevant to the new IBM Quantum&reg; Platform. If you need the previous version, return to the [IBM Quantum Platform Classic documentation.](https://docs.quantum.ibm.com/guides/algorithmiq-tem)\n",
27+
"* Qiskit Functions are an experimental feature available only to IBM Quantum&reg; Premium Plan users. They are in preview release status and subject to change.\n",
2628
"</Admonition>\n",
2729
"</CloudContent>\n",
28-
"<Admonition type=\"note\">\n",
29-
"Qiskit Functions are an experimental feature available only to IBM Quantum&reg; Premium Plan users. They are in preview release status and subject to change.\n",
30-
"</Admonition>\n",
3130
"\n",
3231
"## Overview\n",
3332
"\n",

‎docs/guides/choose-execution-mode.mdx

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,17 @@ description: Choose the right execution mode for Qiskit Runtime - sessions, batc
66
<span id="sessions-versus-batch-usage" />
77
# Choose the right execution mode
88

9+
<LegacyContent>
10+
<Admonition type="note">
11+
This documentation is relevant to IBM Quantum&reg; Platform Classic. If you need the newer version, go to the new [IBM Quantum Platform documentation.](https://quantum.cloud.ibm.com/docs/guides/choose-execution-mode)
12+
</Admonition>
13+
</LegacyContent>
14+
<CloudContent>
15+
<Admonition type="note">
16+
This documentation is relevant to the new IBM Quantum&reg; Platform. If you need the previous version, return to the [IBM Quantum Platform Classic documentation.](https://docs.quantum.ibm.com/guides/choose-execution-mode)
17+
</Admonition>
18+
</CloudContent>
19+
920
Utility-scale workloads can take many hours to complete, so it is important that both the classical and quantum resources are scheduled efficiently to streamline the execution. Execution modes provide flexibility in balancing the cost and time tradeoff to use resources optimally for your workloads. There are several aspects to consider when choosing which execution mode to use, such as overall execution time (maximum time to live, or TTL) and time between jobs (interactive TTL).
1021

1122
The benefits of each are summarized below:
@@ -32,8 +43,10 @@ Generally, use batch mode unless you have workloads that don’t have all inputs
3243
- Use **batch** mode to submit multiple primitive jobs simultaneously to shorten processing time.
3344
- Use **session** mode for iterative workloads, or if you need dedicated access to the QPU.
3445
- Always use **job** mode to submit a single primitive request.
35-
- Because _sessions are generally more expensive_, it is recommended that you use batch whenever you don't need the additional benefits from using sessions.\
36-
<CloudContent>- Open Plan users cannot submit session jobs.</CloudContent>
46+
- Because _sessions are generally more expensive_, it is recommended that you use batch whenever you don't need the additional benefits from using sessions.
47+
<CloudContent>
48+
- Open Plan users cannot submit session jobs.
49+
</CloudContent>
3750

3851
To ensure the most efficient use of the execution modes, the following practices are recommended:
3952

‎docs/guides/estimate-job-run-time.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,17 @@ After submitting a job to the IBM Quantum channel, you can see an estimation for
6363

6464
Quantum time is the duration, in seconds, a QPU is committed to fulfilling a user request.
6565

66+
<LegacyContent>
6667
<Admonition type="note" title="Notes">
6768
- This only applies to jobs that use primitives.
6869
- This is not yet available on the Qiskit Runtime on IBM Cloud&reg; channel.
6970
</Admonition>
71+
</LegacyContent>
72+
<CloudContent>
73+
<Admonition type="note">
74+
This only applies to jobs that use primitives.
75+
</Admonition>
76+
</CloudContent>
7077

7178
Example:
7279

‎docs/guides/execute-on-hardware.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,17 @@ description: Run circuits on hardware and return output from a quantum computer.
55

66
# Execute on target hardware
77

8+
<LegacyContent>
9+
<Admonition type="note">
10+
This documentation is relevant to IBM Quantum&reg; Platform Classic. If you need the newer version, go to the new [IBM Quantum Platform documentation.](https://quantum.cloud.ibm.com/docs/guides/execute-on-hardware)
11+
</Admonition>
12+
</LegacyContent>
13+
<CloudContent>
14+
<Admonition type="note">
15+
This documentation is relevant to the new IBM Quantum&reg; Platform. If you need the previous version, return to the [IBM Quantum Platform Classic documentation.](https://docs.quantum.ibm.com/guides/execute-on-hardware)
16+
</Admonition>
17+
</CloudContent>
18+
819
![All Qiskit pattern steps are shown (Map the problem, Optimize for hardware, Execute on hardware, and Post-process results), with 'Execute on hardware' emphasized. Executing on hardware uses only the Qiskit Runtime service.](/images/qiskit-patterns/execute.svg)
920

1021
The "execute on hardware" step of a Qiskit pattern involves running your circuits on hardware

‎docs/guides/execution-modes-rest-api.mdx

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,17 @@ description: How to run a quantum computing job in a Qiskit Runtime session.
55

66
# Execution modes using REST API
77

8+
<LegacyContent>
9+
<Admonition type="note">
10+
This documentation is relevant to IBM Quantum&reg; Platform Classic. If you need the newer version, go to the new [IBM Quantum Platform documentation.](https://quantum.cloud.ibm.com/docs/guides/execution-modes-rest-api)
11+
</Admonition>
12+
</LegacyContent>
13+
<CloudContent>
14+
<Admonition type="note">
15+
This documentation is relevant to the new IBM Quantum&reg; Platform. If you need the previous version, return to the [IBM Quantum Platform Classic documentation.](https://docs.quantum.ibm.com/guides/execution-modes-rest-api)
16+
</Admonition>
17+
</CloudContent>
18+
819
You can run your Qiskit primitive workloads using REST APIs in one of three execution modes, depending on your needs: job, session, and batch. This topic explains these modes.
920

1021
<Admonition type="note">
@@ -19,11 +30,15 @@ In job mode, a single primitive request of the Estimator or the Sampler is made
1930

2031
A session is a Qiskit Runtime feature that lets you efficiently run multi-job iterative workloads on quantum computers. Using sessions helps avoid delays caused by queuing each job separately, which can be particularly useful for iterative tasks that require frequent communication between classical and quantum resources. More details about Sessions can be found in the [documentation](./execution-modes).
2132

22-
<CloudContent>Note that Open Plan users cannot submit session jobs.</CloudContent>
33+
<CloudContent>
34+
<Admonition type="note">
35+
Open Plan users cannot submit session jobs.
36+
</Admonition>
37+
</CloudContent>
2338

2439
### Start a session
2540

26-
Begin with creating a session and obtaining a session ID.
41+
Begin by creating a session and obtaining a session ID.
2742

2843
<LegacyContent>
2944
```python
@@ -44,7 +59,7 @@ payload = json.dumps({
4459
"instance": "hub1/group1/project1",
4560
})
4661

47-
response = requests.request("POST", sessionsUrl, data=payload, headers=headersList)
62+
response = requests.request("POST", sessionsUrl, data=payload, headers=headersList)
4863

4964
sessionId = response.json()['id']
5065

@@ -144,7 +159,7 @@ Session closure response ok?: True
144159

145160
## Batch mode with REST API
146161

147-
Alternatively, you can submit a batch job by specifying the `mode` in the request payload. Batch mode can help shorten processing time if all jobs can be provided at the outset. More details about batch mode can be found in the [documentation](./run-jobs-batch).
162+
Alternatively, you can submit a batch job by specifying the `mode` in the request payload. Batch mode can help shorten processing time if all jobs can be provided at the outset. Learn about batch mode in the [introduction to execution modes](./execution-modes#batch-mode) guide.
148163

149164
<LegacyContent>
150165
```python

‎docs/guides/execution-modes.mdx

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,17 @@ description: An overview of the available execution modes in Qiskit Runtime; ses
55
---
66
# Introduction to Qiskit Runtime execution modes
77

8+
<LegacyContent>
9+
<Admonition type="note">
10+
This documentation is relevant to IBM Quantum&reg; Platform Classic. If you need the newer version, go to the new [IBM Quantum Platform documentation.](https://quantum.cloud.ibm.com/docs/guides/execution-modes)
11+
</Admonition>
12+
</LegacyContent>
13+
<CloudContent>
14+
<Admonition type="note">
15+
This documentation is relevant to the new IBM Quantum&reg; Platform. If you need the previous version, return to the [IBM Quantum Platform Classic documentation.](https://docs.quantum.ibm.com/guides/execution-modes)
16+
</Admonition>
17+
</CloudContent>
18+
819
When Qiskit Runtime was introduced, users could only execute circuits as individual jobs. As different types of quantum workloads emerged, the need for different scheduling strategies became evident. The execution modes determine how your jobs are scheduled, and choosing the right execution mode allows your workload to run efficiently within your budget. There are three execution modes: job, session, and batch.
920

1021
## Job mode
@@ -40,7 +51,9 @@ To run in session mode, specify `mode=session` when instantiating a primitive, o
4051
<Admonition type="note" title="Notes">
4152
- The queuing time does not decrease for the first job submitted within a session. Therefore, sessions do not provide any benefits when running a single job.
4253
- Sessions do not work on simulators because simulators do not have a queue.
43-
<CloudContent> - Open Plan users cannot submit session jobs.</CloudContent>
54+
<CloudContent>
55+
- Open Plan users cannot submit session jobs.
56+
</CloudContent>
4457
</Admonition>
4558

4659
## Basic workflow

‎docs/guides/functions.ipynb

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,15 @@
77
"source": [
88
"# Introduction to Qiskit Functions\n",
99
"<LegacyContent>\n",
10-
"<Admonition type=\"note\">\n",
11-
"This documentation is relevant to IBM Quantum&reg; Platform Classic. If you need the newer version, go to the new [IBM Quantum Platform documentation.]( https://quantum.cloud.ibm.com/docs/guides/functions)\n",
10+
"<Admonition type=\"note\" title=\"Notes\">\n",
11+
"* This documentation is relevant to IBM Quantum&reg; Platform Classic. If you need the newer version, go to the new [IBM Quantum Platform documentation.]( https://quantum.cloud.ibm.com/docs/guides/functions)\n",
12+
"* Qiskit Functions are an experimental feature available only to IBM Quantum&reg; Premium Plan users. They are in preview release status and subject to change.\n",
1213
"</Admonition>\n",
1314
"</LegacyContent>\n",
1415
"<CloudContent>\n",
15-
"<Admonition type=\"note\">\n",
16-
"This documentation is relevant to the new IBM Quantum&reg; Platform. If you need the previous version, return to the [IBM Quantum Platform Classic documentation.](https://docs.quantum.ibm.com/guides/functions)\n",
16+
"<Admonition type=\"note\" title=\"Notes\">\n",
17+
"* This documentation is relevant to the new IBM Quantum&reg; Platform. If you need the previous version, return to the [IBM Quantum Platform Classic documentation.](https://docs.quantum.ibm.com/guides/functions)\n",
18+
"* Qiskit Functions are an experimental feature available only to IBM Quantum&reg; Premium Plan users. They are in preview release status and subject to change.\n",
1719
"</Admonition>\n",
1820
"</CloudContent>"
1921
]
@@ -55,10 +57,6 @@
5557
"id": "098d8fd4-1558-40df-a1b1-ad70fdef8863",
5658
"metadata": {},
5759
"source": [
58-
"<Admonition type=\"note\">\n",
59-
"Qiskit Functions are an experimental feature available only to IBM Quantum&reg; Premium Plan users. They are in preview release status and subject to change.\n",
60-
"</Admonition>\n",
61-
"\n",
6260
"Qiskit Functions simplify and accelerate utility-scale algorithm discovery and application development, by abstracting away parts of the quantum software development workflow. In this way, Qiskit Functions free up time normally spent hand-writing code and fine-tuning experiments.\n",
6361
"\n",
6462
"![Overview of Qiskit Functions](/images/guides/functions/functions-overview.svg)\n",
@@ -81,15 +79,20 @@
8179
"\n",
8280
"### Install Qiskit Functions Catalog client\n",
8381
"\n",
82+
"<LegacyContent>\n",
8483
"1. To start using Qiskit Functions, install the IBM Qiskit Functions Catalog client:\n",
8584
"\n",
8685
" ```\n",
8786
" pip install qiskit-ibm-catalog\n",
8887
" ```\n",
89-
"<LegacyContent>\n",
9088
"1. Retrieve your API token from the [IBM Quantum account page](https://quantum.ibm.com/account), and activate your Python virtual environment. See the [installation instructions](/guides/install-qiskit#local) if you do not already have a virtual environment set up.\n",
9189
"</LegacyContent>\n",
9290
"<CloudContent>\n",
91+
"1. To start using Qiskit Functions, install the IBM Qiskit Functions Catalog client:\n",
92+
"\n",
93+
" ```\n",
94+
" pip install qiskit-ibm-catalog\n",
95+
" ```\n",
9396
"1. Retrieve your API token from the [IBM Quantum Platform dashboard](https://quantum.cloud.ibm.com/), and activate your Python virtual environment. See the [installation instructions](/guides/install-qiskit#local) if you do not already have a virtual environment set up.\n",
9497
"</CloudContent>\n",
9598
"\n",
@@ -181,7 +184,7 @@
181184
"id": "5154cbea-ccfa-42ea-a9ef-c31699c3b2c0",
182185
"metadata": {},
183186
"source": [
184-
"4. Once you have authenticated, you can list the functions from the Qiskit Functions Catalog that you have access to:"
187+
"4. After you have authenticated, you can list the functions from the Qiskit Functions Catalog that you have access to:"
185188
]
186189
},
187190
{
@@ -225,7 +228,7 @@
225228
"source": [
226229
"### Run enabled functions\n",
227230
"\n",
228-
"Once a catalog object has been instantiated, you can select a function using `catalog.load(provider/function-name)`:"
231+
"After a catalog object has been instantiated, you can select a function using `catalog.load(provider/function-name)`:"
229232
]
230233
},
231234
{
@@ -346,7 +349,7 @@
346349
"source": [
347350
"### Retrieve results\n",
348351
"\n",
349-
"Once a program is `DONE`, you can use `job.results()` to fetch the result. This output format varies with each function, so be sure to follow the specific documentation:"
352+
"After a program is `DONE`, you can use `job.results()` to fetch the result. This output format varies with each function, so be sure to follow the specific documentation:"
350353
]
351354
},
352355
{
@@ -373,7 +376,7 @@
373376
"id": "76c32136-f449-454c-896b-ff9d0edf9abc",
374377
"metadata": {},
375378
"source": [
376-
"At any time, you can also cancel a job:"
379+
"You can also cancel a job at any time:"
377380
]
378381
},
379382
{
@@ -445,7 +448,7 @@
445448
"source": [
446449
"### Fetch error messages\n",
447450
"\n",
448-
"If a program status is `ERROR`, use `job.result()` to fetch the error message to help debug as follows:"
451+
"If a program status is `ERROR`, use `job.result()` to fetch the error message as follows:"
449452
]
450453
},
451454
{

‎docs/guides/get-started-with-primitives.ipynb

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,29 @@
77
"source": [
88
"# Get started with primitives\n",
99
"\n",
10-
"The steps in this topic describe how to set up primitives, explore the options you can use to configure them, and invoke them in a program.\n",
11-
"\n",
10+
"<LegacyContent>\n",
11+
"<Admonition type=\"note\">\n",
12+
"* This documentation is relevant to IBM Quantum&reg; Platform Classic. If you need the newer version, go to the new [IBM Quantum Platform documentation.](https://quantum.cloud.ibm.com/docs/guides/get-started-with-primitives)\n",
13+
" * While this documentation uses the primitives from Qiskit Runtime, which allow you to use IBM&reg; backends, the primitives can be run on any provider by using the [backend primitives](#backend) instead. Additionally, you can use the *reference* primitives to run on a local statevector simulator. See [Exact simulation with Qiskit primitives](/guides/simulate-with-qiskit-sdk-primitives) for details.\n",
14+
"</Admonition>\n",
15+
"</LegacyContent>\n",
16+
"<CloudContent>\n",
1217
"<Admonition type=\"note\">\n",
13-
" While this documentation uses the primitives from Qiskit Runtime, which allow you to use IBM&reg; backends, the primitives can be run on any provider by using the [backend primitives](#backend) instead. Additionally, you can use the *reference* primitives to run on a local statevector simulator. See [Exact simulation with Qiskit primitives](simulate-with-qiskit-sdk-primitives) for details.\n",
18+
"* This documentation is relevant to the new IBM Quantum&reg; Platform. If you need the previous version, return to the [IBM Quantum Platform Classic documentation.](https://docs.quantum.ibm.com/guides/get-started-with-primitives)\n",
19+
"* While this documentation uses the primitives from Qiskit Runtime, which allow you to use IBM&reg; backends, the primitives can be run on any provider by using the [backend primitives](#backend) instead. Additionally, you can use the *reference* primitives to run on a local statevector simulator. See [Exact simulation with Qiskit primitives](/guides/simulate-with-qiskit-sdk-primitives) for details.\n",
1420
"</Admonition>\n",
21+
"</CloudContent>\n",
22+
"\n",
23+
"The steps in this topic describe how to set up primitives, explore the options you can use to configure them, and invoke them in a program.\n",
1524
"\n",
1625
"<Admonition type=\"note\" title=\"Using Fractional Gates\">\n",
17-
" If you wish to use the newly supported [fractional gates](./fractional-gates), you will need to set `use_fractional_gates=True` when requesting a backend from a `QiskitRuntimeService` instance. For example:\n",
26+
" To use the newly supported [fractional gates](./fractional-gates), set `use_fractional_gates=True` when requesting a backend from a `QiskitRuntimeService` instance. For example:\n",
1827
" ```python\n",
1928
" service = QiskitRuntimeService()\n",
2029
" fractional_gate_backend = service.least_busy(use_fractional_gates=True)\n",
2130
" ```\n",
2231
"\n",
23-
" However, note that this is an experimental feature and may change in the future.\n",
32+
" Note that this is an experimental feature and might change in the future.\n",
2433
"</Admonition>"
2534
]
2635
},

0 commit comments

Comments
 (0)