Part of #154
This PR, following the idea of this
[comment](https://github.com/Qiskit/documentation/issues/154#issuecomment-2104751884),
moves all the images in the folders `start`, `build`, `transpile`,
`verify`, and `run` to a new folder called `guides`, updating all the
docs to point to that new folder.
To change the links, I used the following script that updates all but 3
links that are missed by the regex. I changed them manually.
<details>
<summary>Script</summary>
```python
from __future__ import annotations
import re
import glob
from pathlib import Path
from main import OLD_FOLDERS
def update_link(markdown: str, image_folder: str, link: str) -> str:
new_link = link.replace(f"/images/{image_folder}/", "/images/guides/")
return markdown.replace(link, new_link)
def main() -> None:
inline_link_re = re.compile(r"\!\[([^\]]+)\]\(([^)]+)\)")
for folder in [*OLD_FOLDERS, "api/migration-guides"]:
image_folder = folder if folder != "api/migration-guides" else "run"
for file_path in glob.glob(f"docs/{folder}/*"):
file = Path(file_path)
markdown = file.read_text()
new_markdown = re.sub(
inline_link_re,
lambda m: update_link(m[0], image_folder, m[2]),
markdown,
)
if markdown != new_markdown:
file.write_text(new_markdown)
if __name__ == "__main__":
main()
```
</details>
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
```
Fixes#1355 .
No material on PEA yet because it's not exposed as an
[option](https://docs.quantum.ibm.com/api/qiskit-ibm-runtime/options).
---------
Co-authored-by: Abdullah Ash- Saki <44783187+ashsaki@users.noreply.github.com>
Co-authored-by: Pedro Rivero <pedro.rivero.ramirez@gmail.com>
Co-authored-by: Jessie Yu <jessieyu@us.ibm.com>
Co-authored-by: abbycross <across@us.ibm.com>
Co-authored-by: Arnau Casau <arnaucasau@gmail.com>
Docs for https://pypi.org/project/qiskit-transpiler-service/.
These docs are not ready to go live to production yet. But we can safely
merge them in this repository to unblock infrastructure work in closed
source. We won't have closed source sync over these files until we get
the final okay from the transpiler service team.
Closes#595Closes#1041Closes#582Closes#780Closes#582Closes#1156Closes#577Closes#576
- [x] Add text about job splitting, such as "If you split your workload
into multiple jobs and run them in Batch mode, you can get results from
individual jobs. You can, for example, decide to cancel the rest of the
jobs if the earlier job results don't meet your expectations. If one of
the jobs fail, you can also re-submit just that one instead of
re-running the entire workload."
There are several new and existing topics that are impacted:
- This documentation section has several topics about execution modes:
https://qiskit-docs-preview-pr-783.1799mxdls7qz.us-south.codeengine.appdomain.cloud/run/execution-modes
- This migration guide is new:
https://qiskit-docs-preview-pr-783.1799mxdls7qz.us-south.codeengine.appdomain.cloud/api/migration-guides/sessions
---------
Co-authored-by: Ashley Silva <asarver1@gmail.com>
Co-authored-by: Jessie Yu <jessieyu@us.ibm.com>
Co-authored-by: abbycross <across@us.ibm.com>
Closes#699
Currently waiting for the job to finish in order to plot the last set of
data. However, all the other content should be there and updated to
support 1.0.
---------
Co-authored-by: Frank Harkins <frankharkins@hotmail.co.uk>
Co-authored-by: Rebecca Dimock <beckyd@us.ibm.com>
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com>
Co-authored-by: abbycross <across@us.ibm.com>
Closes#1072
Some helpful background: from Jessie: The goal of this document is for
people to test their quantum program (that calls primitives) locally,
before sending them to Qiskit Runtime to run on a real QPU.
Most of this page uses the statevector simulator, and there is an
equivalent for V2, better named as
[StatevectorEstimator](https://github.com/Qiskit/qiskit/blob/main/qiskit/primitives/statevector_estimator.py#L31)
and
[StatevectorSampler](https://github.com/Qiskit/qiskit/blob/main/qiskit/primitives/statevector_sampler.py#L52).
---------
Co-authored-by: Ian Hincks <ian.hincks@gmail.com>
Co-authored-by: abbycross <across@us.ibm.com>
Co-authored-by: Elena Peña Tapia <epenatap@gmail.com>
Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>
Part of #1178
This PR generates the API docs for runtime v0.23.0 (current version),
v0.24.0 (dev version), and converts v0.22.0 to historical.
Commands used in the generation:
```bash
npm run make-historical -- -p qiskit-ibm-runtime
npm run gen-api -- -p qiskit-ibm-runtime -v 0.23.0
npm run gen-api -- -p qiskit-ibm-runtime -v 0.24.0-dev --dev
```
Adds an example before and after transpilation circuit to the
introduction of the transpile pages. Hopefully to clarify further what
the transpiler is used for.
Part of #885
- Convert from MDX to Jupyter notebook
- Rewrite introduction to be more concise
- Use preset pass manager instead of `transpile`
- Use Eagle device and ECR gates instead of retired Falcon device and CX
gates
---------
Co-authored-by: abbycross <across@us.ibm.com>
Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com>
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
Co-authored-by: Frank Harkins <frankharkins@hotmail.co.uk>
Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com>
Co-authored-by: nick bronn <ntbronn@us.ibm.com>
This PR regenerates qiskit-ibm-runtime 0.22.0, 0.21.1, and makes 0.20.0
historical
---------
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
- [x] Remove various transpilation options for v2 primitives
- [x] Update code examples
- [x] Describe new features
- [x] Add migration guide to TOC and index
- [x] Check for outdated information
- [x] Check Cloud for outdated information
---------
Co-authored-by: abbycross <across@us.ibm.com>
Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>
Co-authored-by: Jessie Yu <jessieyu@us.ibm.com>
```
npm run make-historical -- -p qiskit-ibm-provider
npm run make-historical -- -p qiskit-ibm-runtime
npm run gen-api -- -p qiskit-ibm-provider -v 0.10.0
npm run gen-api -- -p qiskit-ibm-runtime -v 0.20.0
npm run gen-api -- -p qiskit-ibm-runtime -v 0.20.1-dev --dev
```
For now, I used the same Box folder for 0.20 and 0.20.1-dev because
there is only a single commit difference that changes the version.
Part of https://github.com/Qiskit/documentation/issues/814. We shouldn't
be deleting attribute pages if they don't correspond to an owning class.
This PR also runs `npm run regen-apis`; as shown, this PR's logic change
only impacts Qiskit v1 docs.
Part of #316
This PR generates the `dev` versions of qiskit 1.0.0 and
qiskit-ibm-runtime 0.19.2
Commands used:
```bash
npm run gen-api -- -p qiskit -v 1.0.0-dev --dev
npm run gen-api -- -p qiskit-ibm-runtime -v 0.19.2-dev --dev
```
To be able to generate the versions, you need to apply the changes from
#786
1. Uploaded artifacts to Box and added to `api-html-artifacts.json`
2. `npm run make-historical -- -p qiskit-ibm-provider`
3. `npm run gen-api -- -p qiskit-ibm-provider -v 0.8.0 --historical`
4. `npm run gen-api -- -p qiskit-ibm-provider -v 0.9.0`
This our first time having historical API docs for Provider, so it
required changing our link checker to load Qiskit docs.
Eric Arellano