Skip to content

first-pass through tutorials for copyediting #3004

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

Merged
merged 41 commits into from
May 1, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
056e0e8
Update advanced-techniques-for-qaoa.ipynb
abbycross Apr 16, 2025
128cdcf
no longer IBM Quantum channel-specific
abbycross Apr 16, 2025
27920f5
Update advanced-techniques-for-qaoa.ipynb
abbycross Apr 16, 2025
d6853c9
fix arrow
abbycross Apr 16, 2025
aae0899
reduce scrolling
abbycross Apr 16, 2025
6484b7f
Merge branch 'main' into ajc/copyedits
abbycross Apr 17, 2025
149aa08
Merge branch 'main' into ajc/copyedits
abbycross Apr 22, 2025
d1550bd
Merge branch 'main' into ajc/copyedits
abbycross Apr 24, 2025
dcd7fce
prepend with /docs/
abbycross Apr 24, 2025
137d101
clear output
abbycross Apr 24, 2025
07e104c
tweaks for consistency
abbycross Apr 24, 2025
a8e1bf4
Un-bold
abbycross Apr 24, 2025
966da10
copyedit first section
abbycross Apr 24, 2025
573c0ac
Merge branch 'main' into ajc/copyedits
abbycross Apr 28, 2025
aac54db
add blog link
abbycross Apr 28, 2025
208832d
prepend w/ docs dir
abbycross Apr 28, 2025
3ca99cc
Rename files per #2992
abbycross Apr 28, 2025
c0bf43a
Update qiskit_bot.yaml
abbycross Apr 28, 2025
7132c78
Update notebook-testing.toml
abbycross Apr 28, 2025
fc25bd0
next chunk
abbycross Apr 28, 2025
9efc5ff
finish copyedit of QTS tutorial
abbycross Apr 28, 2025
f573f5f
Update approximate-quantum-compilation-for-time-evolution.ipynb
abbycross Apr 28, 2025
0cf8ef4
fix broken links
abbycross Apr 29, 2025
6ec0787
fix
abbycross Apr 29, 2025
0c3dd0a
remove specified channel
abbycross Apr 29, 2025
d032331
rmv kyiv from remaining spots in guides
abbycross Apr 29, 2025
315e1a4
tox e fix
abbycross Apr 29, 2025
8432b8c
rmv source_files
abbycross Apr 29, 2025
a18400b
Update with new titles
abbycross Apr 29, 2025
c06e98e
rename heisenberg-chain to spin-chain-vqe
abbycross Apr 29, 2025
ae6d51e
final two titles
abbycross Apr 29, 2025
35e4ec9
Update qiskit_bot.yaml
abbycross Apr 29, 2025
e09e784
Update notebook-testing.toml
abbycross Apr 29, 2025
316bd92
Merge branch 'main' into ajc/copyedits
abbycross Apr 30, 2025
2741425
cleanup qiskit_bot
abbycross Apr 30, 2025
4f25fe3
remove "omit backend" statement
abbycross Apr 30, 2025
9582e5b
apply code review changes
abbycross Apr 30, 2025
05b01c5
Apply suggestions from code review
beckykd May 1, 2025
c35e5c1
address comments
beckykd May 1, 2025
79b6aee
Merge branch 'ajc/copyedits' of https://github.com/Qiskit/documentati…
beckykd May 1, 2025
f296f77
edit
beckykd May 1, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/guides/functions.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@
},
{
"cell_type": "code",
"execution_count": 5,
"execution_count": null,
"id": "9b9a7a3c-cc98-4c19-93cd-f59793515c70",
"metadata": {},
"outputs": [
Expand All @@ -281,7 +281,7 @@
"job = ibm_cf.run(\n",
" pubs=[(circuit, observable)],\n",
" instance=instance,\n",
" backend_name=backend_name, # E.g. \"ibm_kyiv\"\n",
" backend_name=backend_name, # E.g. \"ibm_fez\"\n",
Copy link
Collaborator

Choose a reason for hiding this comment

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

E.g. is one of those Latin abbreviations that we aren't supposed to use. Maybe you want to address these in your follow up PR?

")\n",
"\n",
"job.job_id"
Expand Down
62 changes: 29 additions & 33 deletions docs/guides/get-qpu-information.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"cells": [
{
"cell_type": "markdown",
"id": "cb8aed01-2218-4524-b769-94e3f481b25f",
"id": "b58546f5-fe44-488d-b402-b723a5eff5f4",
"metadata": {},
"source": [
"# Get backend information with Qiskit\n",
Expand All @@ -21,7 +21,7 @@
},
{
"cell_type": "markdown",
"id": "3eccac60-3e0f-4f55-ad2d-f19620105ad3",
"id": "8e0f7648-b359-4492-b88d-26566ca78af6",
"metadata": {
"tags": [
"version-info"
Expand All @@ -42,15 +42,15 @@
},
{
"cell_type": "markdown",
"id": "fb232c67-5b12-4125-b786-aca54bd734c2",
"id": "d3be18e3-d1b5-49c4-a82e-c3e5ecbd5491",
"metadata": {},
"source": [
"This page explains how to use Qiskit to find information about your available backends."
]
},
{
"cell_type": "markdown",
"id": "915e21a1-edd8-40a8-a230-2105a024b81c",
"id": "76d675eb-ad62-4436-9649-7cb6837e16f0",
"metadata": {},
"source": [
"## List backends\n",
Expand All @@ -64,7 +64,7 @@
},
{
"cell_type": "markdown",
"id": "5a858078-ac19-4ee8-9642-d8d08c8ee58c",
"id": "8a169a1d-0a02-41cd-89b0-5d606114866d",
"metadata": {},
"source": [
"<LegacyContent>\n",
Expand All @@ -78,17 +78,15 @@
{
"cell_type": "code",
"execution_count": 1,
"id": "1dfa3af8-686d-420c-8b58-b8e687816fec",
"id": "ad5d41fc-2bb5-4a32-b8bb-8dbc48ef2337",
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"[<IBMBackend('ibm_brisbane')>,\n",
" <IBMBackend('ibm_sherbrooke')>,\n",
" <IBMBackend('ibm_torino')>,\n",
" <IBMBackend('ibm_kyiv')>,\n",
" <IBMBackend('test_eagle_us-east')>]"
" <IBMBackend('ibm_torino')>]"
]
},
"execution_count": 1,
Expand All @@ -107,7 +105,7 @@
},
{
"cell_type": "markdown",
"id": "2e3a18e2-1130-4fb6-a57d-d7226b4268b7",
"id": "88565803-2450-45e1-9075-720d9c57681e",
"metadata": {},
"source": [
"The [`QiskitRuntimeService.backend()`](../api/qiskit-ibm-runtime/qiskit-runtime-service#backend) method (note that this is singular: *backend*) takes the name of the backend as the input parameter and returns an [`IBMBackend`](../api/qiskit-ibm-runtime/ibm-backend) instance representing that particular backend:"
Expand All @@ -116,7 +114,7 @@
{
"cell_type": "code",
"execution_count": 2,
"id": "25a40e79-a494-40e6-9558-17f4418a0efc",
"id": "cd1fd069-fe00-4865-8ee5-ba788fa405ba",
"metadata": {},
"outputs": [
{
Expand All @@ -136,7 +134,7 @@
},
{
"cell_type": "markdown",
"id": "3ba97c22-330f-4eed-8e44-e538f94c2974",
"id": "4bcbb09a-30c0-4b7e-af9f-71a501fc1c47",
"metadata": {},
"source": [
"## Filter backends\n",
Expand All @@ -152,21 +150,19 @@
},
{
"cell_type": "code",
"execution_count": 3,
"id": "dbadd7dd-1272-4973-9ad8-5fd5a40ea008",
"execution_count": 2,
"id": "f9611008-cae5-451b-98a8-a59ae281b33e",
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"[<IBMBackend('ibm_brisbane')>,\n",
" <IBMBackend('ibm_sherbrooke')>,\n",
" <IBMBackend('ibm_torino')>,\n",
" <IBMBackend('ibm_kyiv')>,\n",
" <IBMBackend('test_eagle_us-east')>]"
" <IBMBackend('ibm_torino')>]"
]
},
"execution_count": 3,
"execution_count": 2,
"metadata": {},
"output_type": "execute_result"
}
Expand All @@ -177,25 +173,25 @@
},
{
"cell_type": "markdown",
"id": "b2d15581-56d8-4719-8e35-a8cbf0abd0c3",
"id": "89f7fe95-5fcd-4838-a26a-0ca4aa0882e4",
"metadata": {},
"source": [
"Use these keyword arguments to filter by any attribute in backend configuration ([JSON schema](https://github.com/Qiskit/ibm-quantum-schemas/blob/main/schemas/backend_configuration_schema.json)) or status ([JSON schema](https://github.com/Qiskit/ibm-quantum-schemas/blob/main/schemas/backend_status_schema.json)). A similar method is [`QiskitRuntimeService.least_busy()`](../api/qiskit-ibm-runtime/qiskit-runtime-service#least_busy), which takes the same filters as `backends()` but returns the backend that matches the filters and has the least number of jobs pending in the queue:"
]
},
{
"cell_type": "code",
"execution_count": 4,
"id": "061ef5dc-cd72-4f7a-b4a0-c7cbaffd4169",
"execution_count": 3,
"id": "89d7a8c6-05e8-4ef8-8e50-bc5ead67a436",
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"<IBMBackend('ibm_kyiv')>"
"<IBMBackend('ibm_torino')>"
]
},
"execution_count": 4,
"execution_count": 3,
"metadata": {},
"output_type": "execute_result"
}
Expand All @@ -206,7 +202,7 @@
},
{
"cell_type": "markdown",
"id": "4dc42491-6a03-4e49-bd26-905187edd45b",
"id": "9ab8d5ff-b8ce-4562-8226-95f88bae9438",
"metadata": {},
"source": [
"## Static backend information\n",
Expand All @@ -219,7 +215,7 @@
{
"cell_type": "code",
"execution_count": 5,
"id": "7c963d4f-9792-4d76-97c8-93aa95c6f791",
"id": "a42c128e-6559-498b-a313-8f1be787ab23",
"metadata": {},
"outputs": [
{
Expand All @@ -245,15 +241,15 @@
},
{
"cell_type": "markdown",
"id": "cf5b994a-2434-43df-8e37-c063f1fbe3ce",
"id": "48237011-bd39-4481-8df7-5264620aa6f3",
"metadata": {},
"source": [
"For a full list of attributes, see the [`IBMBackend` API documentation](/docs/api/qiskit-ibm-runtime/ibm-backend)."
]
},
{
"cell_type": "markdown",
"id": "fe84b143-8a73-4bd9-b6a4-b3a023e72964",
"id": "c7c38144-478e-4c31-b050-82078de0f505",
"metadata": {},
"source": [
"## Dynamic backend information\n",
Expand All @@ -269,7 +265,7 @@
{
"cell_type": "code",
"execution_count": 6,
"id": "f1a82580-cd98-4654-94d2-eec8ccc9f7ad",
"id": "94da1ff9-d491-4d78-8720-29141ab1dddf",
"metadata": {},
"outputs": [
{
Expand All @@ -289,7 +285,7 @@
},
{
"cell_type": "markdown",
"id": "f96efd0b-3d35-4ab5-b7b1-ef182c6eed31",
"id": "1d3002ef-e196-4d02-b0d7-b84d1a75ce30",
"metadata": {},
"source": [
"### Instruction properties\n",
Expand All @@ -300,7 +296,7 @@
{
"cell_type": "code",
"execution_count": 7,
"id": "582de91f-62b4-464c-b9c8-f84af948a06a",
"id": "dc15db13-bf2a-4934-8ef6-cacfb953fde6",
"metadata": {},
"outputs": [
{
Expand All @@ -320,7 +316,7 @@
},
{
"cell_type": "markdown",
"id": "d5da7085-163f-4cdc-930a-4fc00832480a",
"id": "2d304e9f-6e76-4876-bbb2-b6b768f3f9e3",
"metadata": {},
"source": [
"The following cell shows the properties for a measurement operation (including the readout error) on qubit 0."
Expand All @@ -329,7 +325,7 @@
{
"cell_type": "code",
"execution_count": 8,
"id": "f6b9e34e-2ef7-4340-8e33-828dd18c8e9d",
"id": "810d55d0-2f60-4bce-a1c2-254e2b989b90",
"metadata": {},
"outputs": [
{
Expand All @@ -349,7 +345,7 @@
},
{
"cell_type": "markdown",
"id": "2385a454-d097-4f63-925f-8609433f3bd7",
"id": "4ba1c604-b4b9-498d-ac29-9cb3a9644e09",
"metadata": {},
"source": [
"## Next steps\n",
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/instances.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -111,10 +111,10 @@ print(service.instances())
# Optional: Specify it at service level.
# This becomes the default unless overwritten.
service = QiskitRuntimeService(channel='ibm_quantum', instance="hub1/group1/project1")
backend1 = service.backend("ibm_kyiv")
backend1 = service.backend("ibm_fez")

# Optional: Specify it at the backend level, which overwrites the service-level specification when this backend is used.
backend2 = service.backend("ibm_kyiv", instance="hub2/group2/project2")
backend2 = service.backend("ibm_fez", instance="hub2/group2/project2")

sampler1 = SamplerV2(mode=backend1) # this will use hub1/group1/project1
sampler2 = SamplerV2(mode=backend2) # this will use hub2/group2/project2
Expand Down
6 changes: 3 additions & 3 deletions docs/guides/q-ctrl-optimization-solver.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@
},
{
"cell_type": "code",
"execution_count": 12,
"execution_count": null,
"id": "16c66d64",
"metadata": {},
"outputs": [],
Expand All @@ -315,7 +315,7 @@
" problem=problem_as_str,\n",
" problem_type=\"maxcut\",\n",
" instance=instance,\n",
" backend_name=backend_name, # E.g. \"ibm_kyiv\"\n",
" backend_name=backend_name, # E.g. \"ibm_fez\"\n",
")"
]
},
Expand Down Expand Up @@ -540,7 +540,7 @@
"mvc_job = solver.run(\n",
" problem=srepr(cost_function),\n",
" instance=instance,\n",
" backend_name=backend_name, # E.g. \"ibm_kyiv\"\n",
" backend_name=backend_name, # E.g. \"ibm_fez\"\n",
")"
]
},
Expand Down
10 changes: 4 additions & 6 deletions docs/guides/q-ctrl-performance-management.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@
},
{
"cell_type": "code",
"execution_count": 6,
"execution_count": null,
"id": "26952e1f",
"metadata": {},
"outputs": [],
Expand All @@ -255,7 +255,7 @@
" primitive=\"estimator\",\n",
" pubs=estimator_pubs,\n",
" instance=instance,\n",
" backend_name=backend_name, # E.g. \"ibm_kyiv\", or omit to default to the least busy device\n",
" backend_name=backend_name,\n",
")"
]
},
Expand Down Expand Up @@ -397,11 +397,9 @@
"- ibm_cleveland\n",
"- ibm_fez\n",
"- ibm_kawasaki\n",
"- ibm_kyiv\n",
"- ibm_nazca\n",
"- ibm_quebec\n",
"- ibm_rensselaer\n",
"- ibm_sherbrooke\n",
"- ibm_strasbourg\n",
"- ibm_torino\n",
"\n",
Expand Down Expand Up @@ -488,7 +486,7 @@
},
{
"cell_type": "code",
"execution_count": 11,
"execution_count": null,
"id": "2595df84",
"metadata": {},
"outputs": [],
Expand All @@ -498,7 +496,7 @@
" primitive=\"sampler\",\n",
" pubs=sampler_pubs,\n",
" instance=instance,\n",
" backend_name=backend_name, # Such as \"ibm_kyiv\", or omit to default to the least busy device\n",
" backend_name=backend_name,\n",
")"
]
},
Expand Down
12 changes: 2 additions & 10 deletions docs/guides/serverless-run-first-workload.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -141,18 +141,10 @@
},
{
"cell_type": "code",
"execution_count": 3,
"execution_count": null,
"id": "ebefb5ac-c8a8-4350-b16f-0677f0e412e5",
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"ibm_kyiv\n"
]
}
],
"outputs": [],
"source": [
"from qiskit_ibm_runtime import QiskitRuntimeService\n",
"\n",
Expand Down
Loading