Unify primitive version tab title format #1629
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Compiling a list of the most common fixes we make when editing documentation, for the curious author who might want a reference. --------- Co-authored-by: Eric Arellano <[email protected]> Co-authored-by: Rebecca Dimock <[email protected]>
`SamplerV2.run()` has a flexible argument style. It always needs a list, but each element can either be a single `QuantumCircuit` or it can be a tuple like `(my_circuit,)` or `(my_circuit, None, 123)`. These two lines are functionally equivalent: ```python sampler.run([circuit1, circuit2]) ``` ```python sampler.run([(circuit1,), (circuit2,)]) ``` But the first one is simpler and easier to understand. So, this PR consistently switches to that style. When we do need the tuple-syntax, we now put each tuple on a dedicated line so that it's easier to see each distinct tuple.
Continuation of Qiskit#971 > The circuit visualizations are most valuable in the build stage of the circuit. This splits the results visualization into a separate file for the analysis/post-processing stage. Additionally, it makes sense to split the quantum information visualizations into the verify (or learning) step. ### Preview quick links - [analyze/visualize-results](https://qiskit-docs-preview-pr-977.1799mxdls7qz.us-south.codeengine.appdomain.cloud/analyze/visualize-results) - [build-new/circuit-visualization](https://qiskit-docs-preview-pr-977.1799mxdls7qz.us-south.codeengine.appdomain.cloud/build-new/circuit-visualization) - [build-new/plot-quantum-states](https://qiskit-docs-preview-pr-977.1799mxdls7qz.us-south.codeengine.appdomain.cloud/build-new/plot-quantum-states) --------- Co-authored-by: nick bronn <[email protected]> Co-authored-by: Kevin J. Sung <[email protected]> Co-authored-by: abbycross <[email protected]>
Turns out the math blocks (latex expressions between double dollars `$$`) can't be indented more than once without making the pages not render. After introducing the MDX components for classes, functions, and attributes on Qiskit#1026, we can't guarantee only one level of indentation, and this PR adds a new function to remove the indentation as a postprocess of all the MDX files. Example of a math expression that was not rendering before: 
Also explain what to install to get the notebooks working locally. Tested on macOS Apple Silicon. The Linux requirements come from CI but weren't tested locally.
Fixes Qiskit#1110 and another mismatch I found doing a read-through
closes Qiskit#1128 --------- Co-authored-by: Jessie Yu <[email protected]>
…ges (Qiskit#1020) Closes Qiskit#319 --------- Co-authored-by: Frank Harkins <[email protected]>
The circuit basics page is introductory, such as defining what a circuit is. It makes more sense to present before the circuit library. That follows our Qiskit 101 presentation structure.
Originally created in Qiskit/qiskit-ibm-runtime#231 Co-authored-by: Ikko Hamamura <[email protected]> Co-authored-by: Jessie Yu <[email protected]> Co-authored-by: Junye Huang <[email protected]> Co-authored-by: Kevin Tian <[email protected]> Co-authored-by: Rathish Cholarajan <[email protected]> Co-authored-by: Rebecca Dimock <[email protected]> Co-authored-by: Sanket Panda <[email protected]>
Originally created in Qiskit/qiskit-ibm-runtime#235 Co-authored-by: ElePT <[email protected]> Co-authored-by: Frank Harkins <[email protected]> Co-authored-by: Ikko Hamamura <[email protected]> Co-authored-by: Jessie Yu <[email protected]> Co-authored-by: Jim Garrison <[email protected]> Co-authored-by: Junye Huang <[email protected]> Co-authored-by: Kevin Tian <[email protected]> Co-authored-by: Paul Nation <[email protected]> Co-authored-by: Rathish Cholarajan <[email protected]> Co-authored-by: Rebecca Dimock <[email protected]> Co-authored-by: Sanket Panda <[email protected]> Co-authored-by: jspark971 <[email protected]> Co-authored-by: kevin-tian <[email protected]> Co-authored-by: lerongil <[email protected]>
Originally created in Qiskit/qiskit-ibm-runtime#888 Co-authored-by: Frank Harkins <[email protected]> Co-authored-by: Hwajung Kang <[email protected]> Co-authored-by: Ikko Hamamura <[email protected]> Co-authored-by: Kevin Tian <[email protected]> Co-authored-by: Rebecca Dimock <[email protected]> Co-authored-by: Sanket Panda <[email protected]>
Originally created in Qiskit/qiskit-ibm-runtime#416 Co-authored-by: Frank Harkins <[email protected]> Co-authored-by: Ikko Hamamura <[email protected]> Co-authored-by: Jessie Yu <[email protected]> Co-authored-by: Kevin Tian <[email protected]> Co-authored-by: Paul Nation <[email protected]> Co-authored-by: Rebecca Dimock <[email protected]> Co-authored-by: Sanket Panda <[email protected]> Co-authored-by: Tushar Mittal <[email protected]> Co-authored-by: adcorcol <[email protected]>
Originally created in Qiskit/qiskit-ibm-runtime#236 Co-authored-by: Frank Harkins <[email protected]> Co-authored-by: Ikko Hamamura <[email protected]> Co-authored-by: Jessie Yu <[email protected]> Co-authored-by: Jim Garrison <[email protected]> Co-authored-by: Kevin Tian <[email protected]> Co-authored-by: Luciano Bello <[email protected]> Co-authored-by: Paul Nation <[email protected]> Co-authored-by: Rathish Cholarajan <[email protected]> Co-authored-by: Rebecca Dimock <[email protected]> Co-authored-by: Sanket Panda <[email protected]> Co-authored-by: beckykd <[email protected]> Co-authored-by: kevin-tian <[email protected]>
We have a new hub on IBM Quantum dedicated to testing docs content.
These haven't been generated in a long time. For Qiskit, this brings in precise GitHub source code links from Qiskit#517.
This file originally existed in an inner-source repository. Co-authored-by: Roy Elkabetz <[email protected]>
This file originally existed in an inner-source repository. Co-authored-by: Roy Elkabetz <[email protected]>
This file originally existed in an inner-source repository.
These three notebooks lived in an inner-source repository. Moving to this repo as part of Qiskit#1135.
Adds the runtime tutorial notebooks as per Qiskit#1135. I couldn't use the same approach as Qiskit#91 as the file history is broken in the runtime repo, but since there were few enough files I used `git log --follow` to find the original PR and all authors that touched the files.
Continuation of Qiskit#956 [Link to preview](https://qiskit-docs-preview-pr-1099.1799mxdls7qz.us-south.codeengine.appdomain.cloud/analyze/save-and-retrieve). --------- Co-authored-by: nick bronn <[email protected]> Co-authored-by: abbycross <[email protected]>
Closes Qiskit#1120 This PR changes the script to use the `name` extracted from the `signature` of the attributes instead of using the `id` to create the `<h3>`s. This behavior was changed in Qiskit#1026, but It broke a couple of headings. It also fixes two attributes of `qiskit.algorithms.eigensolvers.VQD` manually modifying the artifacts stored in [Box](https://ibm.ent.box.com/folder/246867452622?s=tqmvw6ldivzkhh934nhufan4rg3dregr) for versions 0.39, 0.40, 0.41, 0.42, 0.43, 0.44, 0.45 and 0.46. See more at Qiskit#1120
We run notebooks that submit jobs twice a month to check they don't raise errors, but we currently throw away the results. This PR uploads the executed notebooks as an artifact so we can inspect the outputs and update the files in this repo with more recent output. See https://github.com/Qiskit/documentation/actions/runs/8645293171 for an example of this working. --------- Co-authored-by: Eric Arellano <[email protected]>
Adds the new tutorial notebooks to the same tests as the documentation notebooks. Most tutorials run jobs on IBM Quantum so will only be tested fortnightly in the cron job workflow. Part of Qiskit#1136
I didn't realise `Path.rglob` doesn't support braces expansion. Instead, we just avoid hidden folders (there are a bunch of notebooks from libraries in `.tox/**`).
Closes Qiskit#1083 Closes Qiskit#1130 Changes can be viewed here: https://qiskit-docs-preview-pr-1088.1799mxdls7qz.us-south.codeengine.appdomain.cloud/api/migration-guides/qiskit-runtime FYI @jyu00 @ElePT --------- Co-authored-by: Jessie Yu <[email protected]> Co-authored-by: Elena Peña Tapia <[email protected]>
Part of Qiskit#1025 --------- Co-authored-by: Arnau Casau <[email protected]>
This PR converts the qiskit-ibm-runtime 0.23.0 to historical and generates the docs of version 0.24.0 and dev. Commands used: ```bash npm run make-historical -- -p qiskit-ibm-runtime npm run gen-api -- -p qiskit-ibm-runtime -v 0.24.0 npm run gen-api -- -p qiskit-ibm-runtime -v 0.25.0-dev --dev ```
After a meeting about Qiskit#1301, we decided the most appropriate action was to link out to the existing "Product updates" page.
…iskit#1541) Turns out we don't want to do this any more.
Related to Qiskit#1286 --------- Co-authored-by: Rebecca Dimock <[email protected]>
Co-authored-by: abbycross <[email protected]> Co-authored-by: Frank Harkins <[email protected]>
Each time the fortnightly cron job runs, I usually make a PR updating the notebooks in this repo with the output of the cron job. This PR automates that process. As well as saving some manual work, this also means I can review those PRs too. See frankharkins#10 for an example of this working.
…rectory (Qiskit#1545) Bumps the npm_and_yarn group with 1 update in the / directory: [braces](https://github.com/micromatch/braces). Updates `braces` from 3.0.2 to 3.0.3 <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/micromatch/braces/commit/74b2db2938fad48a2ea54a9c8bf27a37a62c350d"><code>74b2db2</code></a> 3.0.3</li> <li><a href="https://github.com/micromatch/braces/commit/88f1429a0f47e1dd3813de35211fc97ffda27f9e"><code>88f1429</code></a> update eslint. lint, fix unit tests.</li> <li><a href="https://github.com/micromatch/braces/commit/415d660c3002d1ab7e63dbf490c9851da80596ff"><code>415d660</code></a> Snyk js braces 6838727 (<a href="https://redirect.github.com/micromatch/braces/issues/40">#40</a>)</li> <li><a href="https://github.com/micromatch/braces/commit/190510f79db1adf21d92798b0bb6fccc1f72c9d6"><code>190510f</code></a> fix tests, skip 1 test in test/braces.expand</li> <li><a href="https://github.com/micromatch/braces/commit/716eb9f12d820b145a831ad678618731927e8856"><code>716eb9f</code></a> readme bump</li> <li><a href="https://github.com/micromatch/braces/commit/a5851e57f45c3431a94d83fc565754bc10f5bbc3"><code>a5851e5</code></a> Merge pull request <a href="https://redirect.github.com/micromatch/braces/issues/37">#37</a> from coderaiser/fix/vulnerability</li> <li><a href="https://github.com/micromatch/braces/commit/2092bd1fb108d2c59bd62e243b70ad98db961538"><code>2092bd1</code></a> feature: braces: add maxSymbols (<a href="https://github.com/micromatch/braces/issues/">https://github.com/micromatch/braces/issues/</a>...</li> <li><a href="https://github.com/micromatch/braces/commit/9f5b4cf47329351bcb64287223ffb6ecc9a5e6d3"><code>9f5b4cf</code></a> fix: vulnerability (<a href="https://security.snyk.io/vuln/SNYK-JS-BRACES-6838727">https://security.snyk.io/vuln/SNYK-JS-BRACES-6838727</a>)</li> <li><a href="https://github.com/micromatch/braces/commit/98414f9f1fabe021736e26836d8306d5de747e0d"><code>98414f9</code></a> remove funding file</li> <li><a href="https://github.com/micromatch/braces/commit/665ab5d561c017a38ba7aafd92cc6655b91d8c14"><code>665ab5d</code></a> update keepEscaping doc (<a href="https://redirect.github.com/micromatch/braces/issues/27">#27</a>)</li> <li>Additional commits viewable in <a href="https://github.com/micromatch/braces/compare/3.0.2...3.0.3">compare view</a></li> </ul> </details> <br /> [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore <dependency name> major version` will close this group update PR and stop Dependabot creating any more for the specific dependency's major version (unless you unignore this specific dependency's major version or upgrade to it yourself) - `@dependabot ignore <dependency name> minor version` will close this group update PR and stop Dependabot creating any more for the specific dependency's minor version (unless you unignore this specific dependency's minor version or upgrade to it yourself) - `@dependabot ignore <dependency name>` will close this group update PR and stop Dependabot creating any more for the specific dependency (unless you unignore this specific dependency or upgrade to it yourself) - `@dependabot unignore <dependency name>` will remove all of the ignore conditions of the specified dependency - `@dependabot unignore <dependency name> <ignore condition>` will remove the ignore condition of the specified dependency and ignore conditions You can disable automated security fix PRs for this repo from the [Security Alerts page](https://github.com/Qiskit/documentation/network/alerts). </details> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Part of Qiskit#1462 This PR prepares our checks for the guides migration to get green CI when we make the change. Changes: - Added API docs links to `ignore.ts`. Those links need to be updated from the other repos and from the Box artifacts for historical versions. Once the migration is done we'll have redirects set up for those links as explained [here](Qiskit#1461). - Added some words to the cspell dictionary and fixed other complaints from the checker - Added a script to fix the Qiskit bot files by changing the paths to `guides/`. The PR also changes the ignores we had to `guides/`, leaving the old ones that should be removed once the migration is done. - Fixed the `update_internal_links.py` script to switch over more links and consider the migration guides. - Added entries for the notebooks with their names on the `guides/` folder. Once the migration is done, we need to remove the old ones.
Closes Qiskit#1439 Decompose is basically only used here to visualize the circuit correctly. If it wasn't, it just be an opaque block when calling `draw()`
Closes Qiskit#1504. --------- Co-authored-by: Rebecca Dimock <[email protected]>
… in-depth Operator coverage to separate page (Qiskit#1517) Closes Qiskit#1440 @kevinsung, here's what I have so far in terms of content to include. I think it might be worth mentioning the overloaded operators for the `SparsePauliOp` class and demonstrate some of the algebra that can be done. --------- Co-authored-by: Kevin J. Sung <[email protected]>
Closes Qiskit#1554 Removing Abby M as an automatic assignee from bug reports too. After the docs reorg, can reword the title of the bug issue for Platform docs by indicating it's for anything in the /guides/ directory. --------- Co-authored-by: Eric Arellano <[email protected]>
This is a new file since we came up with the original docs migration plan. <details><summary>circuit-execution left ToC</summary> <img width="268" alt="Screenshot 2024-06-04 at 1 02 20 PM" src="https://github.com/Qiskit/documentation/assets/14852634/25d74746-e1df-4687-9155-450a2c418000"> </details> <details><summary>circuit-execution patterns index page</summary> <img width="440" alt="Screenshot 2024-06-04 at 1 03 00 PM" src="https://github.com/Qiskit/documentation/assets/14852634/97ab4324-a263-41ac-b4a3-48760e048878"> </details> <details><summary>operator-class left ToC</summary> <img width="258" alt="Screenshot 2024-06-18 at 1 57 36 PM" src="https://github.com/Qiskit/documentation/assets/14852634/c96df34b-e3b3-4a0a-b847-d70286239d72"> </details> <details><summary>operator-class patterns index page</summary> <img width="424" alt="Screenshot 2024-06-18 at 1 54 50 PM" src="https://github.com/Qiskit/documentation/assets/14852634/9cd034ca-463a-4fa9-87dc-b94791922abe"> </details> <details><summary>error-mitigation-and-suppression-techniques left ToC</summary> <img width="260" alt="Screenshot 2024-06-18 at 1 57 11 PM" src="https://github.com/Qiskit/documentation/assets/14852634/e6d0c74e-6ca2-4263-a592-a797cc8acec8"> </details> <details><summary>error-mitigation-and-suppression-techniques patterns index page</summary> <img width="398" alt="Screenshot 2024-06-18 at 1 56 47 PM" src="https://github.com/Qiskit/documentation/assets/14852634/c4f13b5c-7177-4f01-b6a3-374613aaf809"> </details>
Closes Qiskit#1486 added a note at https://docs.quantum.ibm.com/run/run-jobs-batch --------- Co-authored-by: Frank Harkins <[email protected]>
Closes Qiskit#1299 This PR adds a script that validates that every page shows up both in the Tools folders and in the Workflow index pages. --------- Co-authored-by: Eric Arellano <[email protected]>
Noticed a few edits to make in a [recent closed PR](Qiskit#1517). - Changed "we" to "you" - avoided "will" when appropriate - replaced "may" with either "can" or "might" depending on context - general typo/punctuation/capitalization cleanup
This code example fails in our tests if the most recent job is cancelled. This PR filters by job status to avoid that.
) Just added some images and did some reformatting --------- Co-authored-by: abbycross <[email protected]>
This PR bumps the `qiskit_ibm_runtime` version to the most recent, and updates our code examples to work with that version. --------- Co-authored-by: Eric Arellano <[email protected]>
|
One or more of the following people are relevant to this code: |
|
@1ucian0 we've recently edited the history on # Make sure you're on your branch
git switch small/1
# Overwrite your branch with our history
git reset --hard origin/main
# Re-apply your commits on top of the new history
git cherry-pick -X theirs 4a795c6
# Check everything looks correct
git diff origin/main
# If all good, force-push to your branch
git push --forceLet me know if you have any questions. Sorry for the inconvenience. You can also reset your main branch to avoid this problem again: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In https://docs.quantum.ibm.com/run/primitives#estimator :
This PR removes the parenthesis in the
V1titles to unify them with theV2titles.(also adds tt to
PubResult)