From 936138ec106c44bb64289e158f7be7133f026d04 Mon Sep 17 00:00:00 2001 From: Frank Harkins Date: Mon, 24 Jun 2024 18:07:27 +0100 Subject: [PATCH] Add "Latest updates" page (#1411) Adds a latest updates page with some initial content. Closes #1301. I've prioritised news that requires user action (i.e. deprecations), but open to other ideas too. Points from a recent meeting: - We will want product owners to write a release summary for each release - and specify that the url out to the release notes should specify the version (this is mentioned in the Docs overview and publishing processes page) - Highlight product blogs, product announcements, and latest versions of each API ref release - Duplicate "what's new in the docs" from the announcements --------- Co-authored-by: Arnau Casau <47946624+arnaucasau@users.noreply.github.com> Co-authored-by: ABBY CROSS Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> --- docs/start/_toc.json | 4 + docs/start/latest-updates.mdx | 142 +++++++++++++++++++++++++ qiskit_bot.yaml | 2 + scripts/commands/checkInternalLinks.ts | 2 + scripts/patterns-reorg/entries.py | 1 + 5 files changed, 151 insertions(+) create mode 100644 docs/start/latest-updates.mdx diff --git a/docs/start/_toc.json b/docs/start/_toc.json index a313b0c377..155a5a297e 100644 --- a/docs/start/_toc.json +++ b/docs/start/_toc.json @@ -23,6 +23,10 @@ "title": "Hello world", "url": "/start/hello-world" }, + { + "title": "Latest updates", + "url": "/start/latest-updates" + }, { "title": "Advanced setup", "children": [ diff --git a/docs/start/latest-updates.mdx b/docs/start/latest-updates.mdx new file mode 100644 index 0000000000..11c2ac2dfb --- /dev/null +++ b/docs/start/latest-updates.mdx @@ -0,0 +1,142 @@ +--- +title: Latest updates +description: The latest updates from Qiskit and IBM Quantum, including the latest package release summaries, news, and events. +--- + +# Latest updates + +*Last updated 24 June 2024* +{/* remember to update the date in the previous line each time this page is updated!!! */} + +Keep up with the latest and greatest from Qiskit and IBM Quantum! Gathered here are the the most recent Qiskit package release summaries, documentation updates, blogs, community events, and more. + +## Latest release summaries + +{/* release summaries written by product owners */} + +### Qiskit SDK v1.1.0 + +*To see the release notes for all versions, visit the [Qiskit SDK release notes](/api/qiskit/release-notes).* + +Qiskit SDK v1.1.0 has arrived, marking the first minor version release of the Qiskit SDK’s first major version. On the IBM Quantum™ blog, we review some of the key highlights — including top new features and improvements, as well as some important deprecations. Read the blog [here](https://www.ibm.com/quantum/blog/qiskit-1-1-release-summary). + +The updates and improvements include the following: + +- Updated `QuantumCircuit` objects that now support typed classical variables +- Improvements to the preset transpiler pass managers +- Speedups in transpilation runtime, thanks to our continued work re-writing transpiler passes in Rust +- A number of new transpiler passes, including `ElidePermutation` and `StarPreRouting` + +Remember, because this a minor release, it will not introduce breaking changes for users moving from Qiskit SDK v1.0. Any deprecations announced with this release refer only to things that will now start throwing deprecation warnings. None of these will be removed until the release of Qiskit v2.0, pursuant to Qiskit’s official [deprecation policy](https://github.com/Qiskit/qiskit/blob/main/DEPRECATION.md#). + +For more details on any of the topics covered in the blog, be sure to check [the v1.1 release notes](/api/qiskit/release-notes/1.1). + +{/* use url format /api/qiskit/release-notes/X.X to link to the specific X.X version of the release notes */} + +### Qiskit Runtime IBM Client 0.24.0 + +*To see the release notes for all versions, visit the [Qiskit Runtime IBM Client release notes](/api/qiskit-ibm-runtime/release-notes).* + +**Highlights from the 0.24.0 (2024-06-10) version release** + +#### Deprecation notes + +- The `backend` and `session` parameters in `SamplerV2` and `EstimatorV2` are deprecated. You can use the new `mode` parameter instead. +- [`qiskit_ibm_runtime.QiskitRuntimeService.get_backend()`](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService#get_backend) is deprecated. You can use [`qiskit_ibm_runtime.QiskitRuntimeService.backend()`](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService#backend) instead. +- The V1 fake backends, `FakeBackend`, and FakeProvider are deprecated in favor of the V2 fake backends and [`FakeProviderForBackendV2`](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2). + +#### New features + +- The [`ZneOptions.amplifier`](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ZneOptions#amplifier) option was added, which can be one of: `gate_folding` (default), `gate_folding_front`, and `gate_folding_back`. See the [API reference](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ZneOptions#zneoptions) for more details. +- You can now use the experimental option in [`qiskit_ibm_runtime.options.EstimatorOptions`](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions) to enable the Probabilistic Error Amplification (PEA) error mitigation method. + +#### Upgrade notes + +- Qiskit SDK v1.1 is now supported and required. + +#### Bug fixes + +- Fixed an issue where retrieved jobs would only return `RuntimeJob` instances, even if the job was run with a V2 primitive. Now, V2 primitive jobs will be returned correctly as `RuntimeJobV2` instances. +- Fixed the combination of `insert_multiple_cycles` and `coupling_map` options in [`PadDynamicalDecoupling`](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling). This combination allows to select staggered dynamical decoupling with multiple sequence cycles in each delay that crosses the threshold set by `sequence_min_length_ratios`. +- Fixed measurement twirling docstring that incorrectly indicated it’s enabled by default for Sampler. +- Fixed issues related to target generation and calibration data. + +See the full [0.24.0 release notes](/api/qiskit-ibm-runtime/release-notes#0240-2024-06-10). +{/* use url format /api/qiskit-ibm-runtime/release-notes#0XYZ to link to the specific 0.XY.Z version of the release notes */} + +### Qiskit Transpiler Service Client v0.3.0 + +We’re pleased to share that the beta release of the Qiskit Transpiler Service is now available to all IBM Quantum™ Premium Plan users. + +The Qiskit Transpiler Service leverages the resources of IBM Cloud® to provide users with the latest transpilation capabilities from the Qiskit SDK. It offers a Python library that helps users seamlessly integrate the service into their current Qiskit patterns and workflows. Perhaps most importantly, the service invites users to experiment with new and improved AI-powered transpiler passes — cutting-edge tools that might be faster and produce better results than traditional transpilation methods. + +On the IBM Quantum blog, we take a deep dive into the new beta release with a special focus on the new AI-powered passes. The blog includes detailed explanations showing how to use the Qiskit Transpiler Service for both full circuit transpilation and standalone AI-powered passes, with code examples for each. [Take a look.](https://www.ibm.com/quantum/blog/ai-transpiler-passes) + +{/* no other release notes available yet */} + +## Qiskit IBM Runtime service updates + +This summary of the latest changes to the Qiskit Runtime service applies to anyone using Qiskit Runtime, regardless of how you communicate with the service (using qiskit-ibm-runtime or otherwise), or which version of the client SDK you use. + +### 28 March 2024 + +Qiskit Runtime primitives now support OpenQASM 3 as the input format for circuits and standard JSON output format. See [Qiskit IBM Runtime REST API](/api/runtime) for examples. + +### 3 June 2024 + +Probabilistic error amplification (PEA) error mitigation method is now available as an experimental option for Estimator V2. See the [`EstimatorOptions` API reference](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions) for more details. + +### 18 June 2024 + +The `optimization_level` option is deprecated for Estimator V2 and will be removed no sooner than 30 September 2024. + + +## Qiskit blog: How execution modes enable efficient, utility-scale workloads + +{/* Bring over the Quantum news (blog) announcement post */} + +*Browse all blogs at the [Quantum Research blog page](https://www.ibm.com/quantum/blog).* + +In a recent post on the IBM Quantum™ blog, we introduce three new and improved execution modes that make running utility-scale workloads more reliable, more predictable, and more efficient than ever before. + +Execution modes are the rules and procedures that govern how a user’s quantum circuits run on classical and quantum resources. When IBM put the first quantum computer in the cloud in 2016, users could only execute circuits as individual jobs. Since then, we’ve been working to see how execution modes can optimize the user experience even further. + +After previewing them at the IBM Quantum Summit, we're thrilled to share more details on three execution modes that give users more flexibility in choosing how their circuits should be grouped together or divided up for optimal execution. These include **job mode** for running standalone jobs, **batch mode** for running non-iterative multi-job workloads, and **session mode** for running iterative workloads as a single experiment. + +For more details on the new and improved execution modes, including example code that demonstrates batch mode and session mode, see [the full blog post](https://www.ibm.com/quantum/blog/execution-modes). + +## What's new in the documentation + +{/* Copy over the latest "What's new in the docs" announcement */} + + +IBM Quantum documentation recently added a number of user-facing improvements, including content updates and new features. Many of these changes are a result of specific user requests! Check out the highlights below. + +### Updated content + +- A new guide to [Execution mode changes](/api/migration-guides/sessions), as well as updated information across the platform on the new and improved [execution modes](/run/execution-modes) +- [Hello world](/start/hello-world) and [Install](/start/install) pages have been updated with brand new content from the [Coding with Qiskit](https://www.youtube.com/playlist?list=PLOFEBzvs-VvrgHZt3exM_NNiNKtZlHvZi) YouTube series +- All content and examples have been updated to use V2 primitives and Qiskit SDK v1.0 +- Information on [Hardware considerations](/verify#hardware-considerations) for simulating in local testing mode have been added +- The [Fixed and dynamic repetition rate execution](/run/circuit-execution) page has been updated with a new example for [specifying `rep_delay` for a primitive job](/run/circuit-execution#specify-rep_delay-for-a-primitive-job) + +### User experience improvements + +- Two new ways to submit feedback! Click the "Report a bug or request content on [GitHub](https://github.com/Qiskit/documentation/issues/new/choose)" link on every page - or use the new anonymous [feedback form](https://ibmxm.iad1.qualtrics.com/jfe/form/SV_7Uq9FCMjZPyTsFM?Q_PopulateResponse={%22QID20%22:%223%22}) to share your ideas, experiences, and suggestions + +Improvements to API reference documentation readability: +- Module pages make better use of headers to express the information hierarchy +- The Qiskit SDK table of contents was reorganized into logical groups +- API docs now more clearly display modifiers like `class`, `static`, and `abstract` in front of code objects + +*A huge thank you goes out to everyone in the open-source community who contributed and gave feedback!* Please [open an issue](https://github.com/Qiskit/documentation/issues/new/choose) if you find a bug, have a suggestion, or want to share your experience. + +## Qiskit global community events + +Join, participate, contribute! See what events are coming up on the [Qiskit community events calendar](https://www.ibm.com/quantum/community#events). + +## See all product updates + + +Visit the [Product announcements](https://docs.quantum.ibm.com/announcements/product-updates) to browse all product updates and news. + diff --git a/qiskit_bot.yaml b/qiskit_bot.yaml index 9a2e9b73d0..5baaef150f 100644 --- a/qiskit_bot.yaml +++ b/qiskit_bot.yaml @@ -31,6 +31,8 @@ notifications: - "`@mtreinish`" - "`@jakelishman`" - "@beckykd" + "docs/start/latest-updates": + - "@abbycross" # build "docs/build/index": - "@javabster" diff --git a/scripts/commands/checkInternalLinks.ts b/scripts/commands/checkInternalLinks.ts index 9fae7ff01d..72ef7ea1bd 100644 --- a/scripts/commands/checkInternalLinks.ts +++ b/scripts/commands/checkInternalLinks.ts @@ -25,6 +25,7 @@ import { FileBatch } from "../lib/links/FileBatch"; const SYNTHETIC_FILES: string[] = [ "docs/errors.mdx", "docs/api/runtime/index.mdx", + "docs/announcements/product-updates/2024-04-15-backend-run-deprecation.mdx", "docs/api/qiskit-transpiler-service-rest/index.mdx", ]; @@ -186,6 +187,7 @@ async function determineCurrentDocsFileBatch( // Release notes referenced in files. "docs/api/qiskit/release-notes/index.mdx", "docs/api/qiskit/release-notes/0.45.mdx", + "docs/api/qiskit/release-notes/1.1.mdx", ]; if (!args.currentApis) { diff --git a/scripts/patterns-reorg/entries.py b/scripts/patterns-reorg/entries.py index f555832ce1..a227b49722 100644 --- a/scripts/patterns-reorg/entries.py +++ b/scripts/patterns-reorg/entries.py @@ -84,6 +84,7 @@ GET_STARTED_CHILDREN = [ ), ), Entry("Hello world", slug="/hello-world", from_file="start/hello-world.ipynb"), + Entry("Latest updates", slug="/latest-updates", from_file="start/latest-updates.mdx"), Entry( "Advanced setup", children=(