docs format changes #2139

assafb · 2024-10-15T18:07:30Z

No description provided.

review-notebook-app · 2024-10-15T18:07:35Z

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

qiskit-bot · 2024-10-15T18:07:36Z

Thanks for contributing to Qiskit documentation!

Before your PR can be merged, it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient. Thanks! 🙌

One or more of the following people are relevant to this code:

docs/guides/qedma-qesem.ipynb

pandasa123 · 2024-10-16T01:48:48Z

docs/guides/qedma-qesem.ipynb

+    "\n",
+    "| Name |  Type | Description | Required | Default |  Example |\n",
+    "| -----| ------| ------------| -------- | ------- | -------- |\n",
+    "| `pubs` | [EstimatorPubLike](https://github.com/Qiskit/qiskit/blob/5121a0fda8d4e49d47d16a28e1d21046a09d008b/qiskit/primitives/containers/estimator_pub.py#L202-L207) |This is the main input. The `Pub` contains 2-4 elements: a circuit, one or more observables, 0 or a single set of parameter values, and an optional precision. If a precision was not specified, then the `default_precision` from `options` will be used|  Yes|  N/A |  `[(circuit, [obs1,obs2,obs3], parameter_values, 0.03)]`  |\n",


The link to this should be /guides/primitive-input-output

pandasa123 · 2024-10-16T01:50:25Z

docs/guides/qedma-qesem.ipynb

+    "\n",
+    "| Option |  Choices | Description | Default |\n",
+    "| -----| -----------| -------- | ------- | \n",
+    "| `estimate_time_only` |  True / False  | Specifies whether to execute the mitigation process or only get QPU time estimation | True|\n",


Does this mean estimate_time_only is True by default, and does not run on hardware by default?

@pandasa123 That is correct. The reason is that error mitigation inherently comes with an exponential overhead, so it's better for the user to request execution explicitly to avoid mistakes where they might start the process without realizing it could consume several hours of their monthly QPU time quota. Moreover, in our SaaS offering, we have implemented a two-stage process where the user cannot begin execution without first estimating the QPU usage. Consider it as a safety switch which protects the user from making mistakes.

@assafb, just checked with the team. estimate_time_only should be False by default to be consistent across all CFs

pandasa123 · 2024-10-16T01:52:32Z

docs/guides/qedma-qesem.ipynb

+    "| `0` | Minimal transpilation: the mitigated circuit will closely resemble the input circuit structurally. Circuits provided in level 0 should match the device connectivity and should be specified in terms of the following gates: CX, Rzz(α), and standard single-qubit gates (U, x, sx, rz, etc). Barriers will be respected in the layerification step. |\n",
+    "\n",
+    "<Admonition type=\"note\">\n",
+    "Qiskit barriers are typically used to specify the layers of two-qubit gates in quantum circuits. In level 0, QESEM preserves the layers specified by the barriers. In level 1, the layers specified by the barriers are considered as one transpilation alternative when minimizing QPU time.\n",


I think "Qiskit barriers" feels odd? This should read "In Qiskit, barriers"?

CC: @abbycross

Let me know how you recommend to phrase it.

How about "Barrier operations are typically used..." (just leave off Qiskit altogether)?

Co-authored-by: abbycross <[email protected]>

jyu00 · 2024-10-17T12:34:03Z

docs/guides/qedma-qesem.ipynb

-    "    }\n",
-    ")"
+    "    metadata={}\n",
+    ")\n"


I think it'd be helpful to have code showing how to use the primitive results, instead of showing only the type. E.g. print(f"Expectation value from pub 0 is {result[0].data.evs}")

abbycross · 2024-10-17T14:16:01Z

I tried to make a change directly to your branch but because it's a fork I may not have the right permissions. Instead, I opened a PR with my own fork to push a change to your fork :) Qedma#1

The needed change is to add some terms to the spelling dictionary

docs/guides/qedma-qesem.ipynb

blakejohnson · 2024-10-18T19:33:14Z

docs/guides/qedma-qesem.ipynb

@@ -37,40 +37,56 @@
   "id": "74823696",


default_precision needs to define a default as it says what to do if a precision is not specified by a PUB.

Reply via ReviewNB

blakejohnson · 2024-10-18T19:33:14Z

docs/guides/qedma-qesem.ipynb

@@ -37,40 +37,56 @@
   "id": "74823696",


Having an example where stds includes values > 1 reads strangely. Was that intentional?

Reply via ReviewNB

That was a typo. Fixed

Update cspell

…ntation into docs-updates

docs/guides/qedma-qesem.ipynb

Co-authored-by: abbycross <[email protected]>

…ocs-updates

frankharkins · 2024-10-29T16:35:28Z

For some reason I can't push to this branch. To fix the lint error, someone will need to run the following commands:

git pull https://github.com/Qiskit/documentation.git main
# You should now be in a merge conflict. To fix, reset the notebook and re-lint it.
git restore docs/guides/qedma-qesem.ipynb --source 50ed9daeb09712c8eb0db384eb3946ed84f1a7f1
tox -e fix
git add .
git commit

EDIT: Alternatively, you can also merge Qedma#2

pacomf · 2024-10-31T18:07:58Z

@assafb can you address previous comment about lint issues to merge the PR? :)

Pull main

assafb · 2024-11-01T09:20:40Z

@pacomf @frankharkins I merged Qedma#2

docs format changes

c411273

abbycross reviewed Oct 15, 2024

View reviewed changes

docs/guides/qedma-qesem.ipynb Outdated Show resolved Hide resolved

docs/guides/qedma-qesem.ipynb Outdated Show resolved Hide resolved

docs/guides/qedma-qesem.ipynb Outdated Show resolved Hide resolved

docs/guides/qedma-qesem.ipynb Outdated Show resolved Hide resolved

pandasa123 suggested changes Oct 16, 2024

View reviewed changes

assafb and others added 5 commits October 16, 2024 13:13

Update docs/guides/qedma-qesem.ipynb

3ea72dd

Co-authored-by: abbycross <[email protected]>

Update docs/guides/qedma-qesem.ipynb

08ef9ef

Co-authored-by: abbycross <[email protected]>

Update docs/guides/qedma-qesem.ipynb

bcbcdd7

Co-authored-by: abbycross <[email protected]>

Update docs/guides/qedma-qesem.ipynb

764095a

Co-authored-by: abbycross <[email protected]>

review updates

9ae8139

jyu00 reviewed Oct 17, 2024

View reviewed changes

Update cspell

14b338f

blakejohnson reviewed Oct 18, 2024

View reviewed changes

assafb added 3 commits October 20, 2024 13:59

Merge pull request #1 from abbycross/patch-1

9e09d08

Update cspell

IBM review updates

2a2c471

Merge branch 'docs-updates' of https://github.com/Qedma/qiskit-docume…

2f9eb8c

…ntation into docs-updates

abbycross reviewed Oct 21, 2024

View reviewed changes

docs/guides/qedma-qesem.ipynb Outdated Show resolved Hide resolved

assafb and others added 4 commits October 22, 2024 09:30

Update docs/guides/qedma-qesem.ipynb

03c757f

Co-authored-by: abbycross <[email protected]>

remove redundant sections

92eee9d

remove redundant sections

50ed9da

Merge branch 'main' of https://github.com/Qiskit/documentation into d…

3b56f44

…ocs-updates

This was referenced Oct 29, 2024

Pull main Qedma/qiskit-documentation#2

Merged

Format notebooks with Ruff #2199

Merged

Merge pull request #2 from Qiskit/docs-updates

74f35f2

Pull main

frankharkins approved these changes Nov 1, 2024

View reviewed changes

frankharkins added this pull request to the merge queue Nov 1, 2024

Merged via the queue into Qiskit:main with commit ff0bd17 Nov 1, 2024
4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs format changes #2139

docs format changes #2139

assafb commented Oct 15, 2024

review-notebook-app bot commented Oct 15, 2024

qiskit-bot commented Oct 15, 2024

pandasa123 Oct 16, 2024

assafb Oct 20, 2024

pandasa123 Oct 16, 2024

assafb Oct 16, 2024

pandasa123 Oct 17, 2024

assafb Oct 20, 2024

pandasa123 Oct 16, 2024

assafb Oct 16, 2024

abbycross Oct 17, 2024

jyu00 Oct 17, 2024

abbycross commented Oct 17, 2024

blakejohnson Oct 18, 2024 •

edited

Loading

blakejohnson Oct 18, 2024 •

edited

Loading

assafb Oct 20, 2024

frankharkins commented Oct 29, 2024 •

edited

Loading

pacomf commented Oct 31, 2024

assafb commented Nov 1, 2024

docs format changes #2139

docs format changes #2139

Conversation

assafb commented Oct 15, 2024

review-notebook-app bot commented Oct 15, 2024

qiskit-bot commented Oct 15, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abbycross commented Oct 17, 2024

blakejohnson Oct 18, 2024 • edited Loading

Choose a reason for hiding this comment

blakejohnson Oct 18, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

frankharkins commented Oct 29, 2024 • edited Loading

pacomf commented Oct 31, 2024

assafb commented Nov 1, 2024

blakejohnson Oct 18, 2024 •

edited

Loading

blakejohnson Oct 18, 2024 •

edited

Loading

frankharkins commented Oct 29, 2024 •

edited

Loading