Closes#2112
A few questions for @Eric-Arellano about this:
- The notebook requires a separate text file to ingest orbital
information. I've put the contents in the page, but need to put the file
somewhere in the repo, I chose the `/guides/` directory to avoid
exposing the site's folder structure (and for easier reading by the
user). Is that alright to do?
- The notebook also requires `pyscf` to run. Should this dependency be
added to the `pyproject.toml` or `requirements.txt` in nb-tester?
Pedagogy question/notes for @javabster:
- I've cut out most of the circuit preparation and execution since the
SQD configuration recovery loop for this example can be run on synthetic
data. I think this helps focus in on the tooling of the package, but
wanted to make sure this was kosher since this example doesn't execute
anything on a QPU.
- I also think the full tutorial should be moved to the Learning
platform at some point (and this page should link out to it). It
contains good content and helpful information for users wanting to
prepare own chemistry workloads to post-process with SQD.
---------
Co-authored-by: abbycross <across@us.ibm.com>
Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com>
Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com>
Co-authored-by: Caleb Johnson <calebj1524@outlook.com>
Note that /qiskit.circuit.library.IQP was deleted and is now
/qiskit.circuit.library.iqp because the class was deprecated in favor of
a function. However, the class page should not be deleted until Qiskit
2.0 so I will open a PR to fix this. Because it's dev docs, it's fine to
not block on this.
Cutting had a big change to show missing methods and un-inline some
classes. The other addons had smaller changes to show type hints even if
the parameter doesn't have docstring.
All changes were generated with `npm run gen-api`.
An action recently synced the latest dev docs. This PR updates all dev
APIs that changed.
> [!NOTE]
> This pull request was created by a GitHub action.
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Closes#1527
~~Currently blocked by #1734 which will need to be merged before CI
passes.~~
Utilizing fractional gates is a flag that is set when requesting a
backend from a `QiskitRuntimeService()` instance and there didn't appear
to be a clear page for a flag to be explained. I ended up adding it as
an admonition to the "get started with primitives" page.
---------
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
This adds qiskit-addon-aqc-tensor to the docs page.
Notes:
- Currently, this addon's tutorial is phrased as step 2 of a Qiskit
pattern. However, after gaining experience with it, I believe it
actually fits in better as step 1. I plan to update the tutorial, but in
the meantime I've proposed it here under "Addons for mapping."
- I wrote a new description for it here, motivated by the desire to be
consistent with both (i) unitary AQC, which will likely be added soon,
and (ii) the phrasing as a "step 1" operation.
An issue with our API docs is confusing which version specific pages
correspond to because we have so many duplicates. That is especially an
issue with SEO, but also rich previews & tab titles. So, this PR adds
the version to both the `title` and `description`.
We use minor versions rather than patch versions because search engines
can be slow to update and we don't want their metadata to be
out-of-date. Likewise, we call it `(latest version)` and `(dev version)`
for this same reason.
Finally, this PR automates setting metadata for the index page whereas
before we hardcoded it.
An action recently synced the latest dev docs. This PR updates all dev
APIs that changed.
> [!NOTE]
> This pull request was created by a GitHub action.
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
An action recently synced the latest dev docs. This PR updates all dev
APIs that changed.
> [!NOTE]
> This pull request was created by a GitHub action.
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Follow-up to #2197. Draft until that PR is merged, then I'll rebase
this.
Also a partial fix for #1806 depending if we want to also lint code
examples in MDX.
Adds the ability for `nb-tester` to list package versions in executed
notebooks. Closes#922.
To add version information to a notebook, add a markdown cell with tag
`version-info`. The script will replace the markdown in that cell with
the version information. I've added this cell to one notebook and
executed it to demonstrate (preview:
https://qiskit.github.io/documentation/pr-2208/guides/plot-quantum-states).
If we go with this approach, I can add empty cells to all notebooks and
they'll be populated as they're run.
This is just plain markdown for now, but we could also consider putting
it the information in a component or adding it to the notebook metadata
so we can display it somewhere else (e.g. the right sidebar).
An action recently synced the latest dev docs. This PR updates all dev
APIs that changed.
> [!NOTE]
> This pull request was created by a GitHub action.
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
An action recently synced the latest dev docs. This PR updates all dev
APIs that changed.
> [!NOTE]
> This pull request was created by a GitHub action.
---------
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
Closes#2189 and is part of #2094
---------
Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>
Co-authored-by: Frank Harkins <frankharkins@hotmail.co.uk>
Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com>
All five addons now use the structure we expect of having a flat list of
module pages, along with an index page.
Thanks to this PR, we can now run `checkOrphanPages.ts` on the addon
projects.
Adds linting and formatting with [Ruff](https://docs.astral.sh/ruff).
This caught a couple of undefined variables, but it also enforces
consistent code styling across our code examples. You may find it easier
to review this PR commit-wise.
Closes https://github.com/Qiskit/documentation/issues/2174. We now
convert URLs like `qiskit_addon_obp.MyClass` to `my-class`.
This is safe to change because the Addons are not yet public. We may
eventually want to do this for Qiskit, Runtime, and Transpiler Service -
for now, they stay the same.
We're changing how the prompt works. We'll have to merge with the broken
preview as we need to merge the MDX changes and the component changes to
inner-source at the same time. I've copied the files over to
inner-source to test it out with the new component and make sure the
syntax is correct.
We're in the process of adding six Qiskit addon API docs. This PR sets
up the initial projects so that it's easier for us to iterate on them,
such as running `npm run gen-api -- -a <path-to-html>` to see locally
how changes to Sphinx config impact the MDX pipeline.
The docs are _not_ ready to go live and they will not yet be synced by
closed source or deployed.
The quality issues will fixed in the project repositories, such as
https://github.com/Qiskit/qiskit-addon-obp/pull/24.
## API naming scheme
We call the API by their full name, without their abbrevation. For
example, "Operator Backpropagation" rather than "OBP" or "Operator
Backpropagation (OBP)".
We do not explicitly mention "Qiskit addon" in the API name. It's
already evident these are addons by looking at the left ToC which shows
the full module path like `qiskit_addon_obp`.
## URL scheme
Each package's URL matches their PyPI name, like `qiskit-addon-obp`.
Note that we may want to normalize the URLs for individual pages to
follow SEO best practices, e.g.
`/api/qiskit-addon-obp/qiskit_addon_obp.utils.simplify` would be
`/api/qiskit-addon-obp/qiskit-addon-obp-utils-simplify`. We would make
this change in a follow up PR.
Updating the Algorithmiq TEM documentation in the Example section. The
parameter `max_execution_time` was removed.
---------
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
- Update schemas for both functions
- Split out Sampler/Estimator docs, rerun problems, update outputs
- Update some text and typos
---------
Co-authored-by: abbycross <across@us.ibm.com>
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
Note that several APIs were removed from Runtime. I'll set up redirects
in closed source.
This PR also updates the dev docs for Qiskit. For some reason, our cron
job isn't actually opening up PRs.
Improve documentation about execution modes; specifically clarifying the
max timeout information
---------
Co-authored-by: abbycross <across@us.ibm.com>
Kaelyn Ferris