Skip to content

Separate addons into sections #4965

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kaelynj merged 10 commits into from
Apr 17, 2026
Merged

Separate addons into sections #4965

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
ab646da
Separate addons into sections
kaelynj Apr 9, 2026
1c36be8
Merge branch 'main' of github.com:Qiskit/documentation into kjf/categ…
kaelynj Apr 10, 2026
31239c0
Apply suggestions from code review
kaelynj Apr 13, 2026
5b8ce2c
Implement review suggestions
kaelynj Apr 15, 2026
45a3527
Update docs/guides/addons.mdx
kaelynj Apr 16, 2026
704c175
Apply suggestions from code review
kaelynj Apr 16, 2026
71a44a9
Rework card descriptions
kaelynj Apr 16, 2026
4409426
Apply suggestions from code review
kaelynj Apr 16, 2026
c438cc5
Update card description
kaelynj Apr 16, 2026
2eb93fe
Apply suggestions from code review
kaelynj Apr 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 41 additions & 13 deletions docs/guides/addons.mdx
View file
Open in desktop
Copy link
Copy Markdown
Collaborator

@abbycross abbycross Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The first h2 starts with "Addons for" and the rest of the h2s don't follow that pattern. Style guide has us avoid gerunds in headers, so I would recommend a structure like this:

  • Addons to map domain problems
  • Addons to optimize circuits for hardware execution
  • Addons to manage noise for expectation value estimation
  • Addons to manage noise for sampling results
  • Supplemental addons

Alternative: just remove the "Addons to" altogether, if it feels too repetitive... and go with:

  • Map domain problems
  • Optimize circuits for hardware execution
  • Manage noise for expectation value estimation
    etc.

Copy link
Copy Markdown
Collaborator

@jenglick jenglick Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the alternative option (removing addons from those headers)

Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ description: Understand the Qiskit addon tools, which help you build utility-gra

Qiskit addons are a collection of research capabilities for enabling algorithm discovery at the utility scale. These modular software components can plug into a [workflow](/docs/guides/intro-to-patterns) to scale or design new quantum algorithms. Many of these addons are powered by the `qiskit-addon-utils` package. See the [Qiskit addon utilities documentation](https://qiskit.github.io/qiskit-addon-utils/) for more information.
Copy link
Copy Markdown
Collaborator

@jenglick jenglick Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's remove the last two sentences on the utils package since we now have a dedicated section for it.

Comment thread
kaelynj marked this conversation as resolved.
Outdated


## Addons for mapping domain problems
These addons are particularly useful for preparing efficient quantum circuits based on the application you are building for.
Copy link
Copy Markdown
Collaborator

@abbycross abbycross Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
These addons are particularly useful for preparing efficient quantum circuits based on the application you are building for.
These addons are particularly useful for preparing efficient quantum circuits based on the application you are building.

"based on the application" - Maybe this can be clearer - are the circuits based on the application, or are the addons based on the application?

Comment thread
kaelynj marked this conversation as resolved.
Outdated
<CardGroup>
<Card
title="AQC-Tensor"
Expand All @@ -34,7 +37,12 @@ Qiskit addons are a collection of research capabilities for enabling algorithm d
linkText="Browse documentation"
/>

</CardGroup>


## Optimizing circuits for hardware execution
The following addons are useful for reducing circuit depth, both generally (for the circuit cutting addon) and when your workload estimates the expectation value of an observable using operator backpropagation.
Copy link
Copy Markdown
Collaborator

@abbycross abbycross Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The phrase "addons are useful for" is repeated in each section. It's more concise to use language like
"Use the following addons to reduce circuit depth, both generally..." (and I think it will feel less obviously repetitive, even if you use it in every section).

Or - mix it up with language like "These addons excel at...." "The purpose of these addons is..." "These addons specialize in..." etc.

Copy link
Copy Markdown
Collaborator

@jenglick jenglick Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good suggestion (I would perhaps replace addons with capabilities). I like both "Use these capabilities to ..." and "These capabilities specialize in..."

Comment thread
kaelynj marked this conversation as resolved.
Outdated
<CardGroup>
<Card
title="Operator backpropagation"
description="Operator backpropagation (OBP) reduces circuit depth by trimming operations from the end at the cost of more operator measurements."
Expand All @@ -50,32 +58,40 @@ Qiskit addons are a collection of research capabilities for enabling algorithm d
analyticsName="Documentation page: Circuit cutting"
linkText="Browse documentation"
/>
</CardGroup>

## Noise management for expectation value estimation
These addons are useful for managing noise when building quantum workloads which estimate expectation values of one or more observables.
Copy link
Copy Markdown
Collaborator

@abbycross abbycross Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
These addons are useful for managing noise when building quantum workloads which estimate expectation values of one or more observables.
These addons are useful for managing noise when building quantum workloads that estimate expectation values of one or more observables.

Copy link
Copy Markdown
Collaborator

@jenglick jenglick Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we could be more concise and just say "expectation values of observables"


<Card
title="Matrix-free Measurement Mitigation"
description="Matrix-free Measurement Mitigation (M3) is a package for scalable quantum measurement error mitigation that can be computed in parallel."
href="https://qiskit.github.io/qiskit-addon-mthree/"
analyticsName="Documentation page: M3"
<CardGroup>
<Card
title="Propagated noise absorption"
description="Propagated noise absorption (PNA) uses Pauli propagation to absorb information from a noise model into a target observable. Measuring this modified observable has the effect of mitigating the noise as represented by the model."
href="https://qiskit.github.io/qiskit-addon-pna/"
analyticsName="Documentation page: PNA"
linkText="Browse documentation"
/>

<Card
title="Shaded lightcones"
description="The shaded lightcones (SLC) addon uses Pauli propagation to reduce the number of error terms in a noise model that need to be mitigated. This has the effect of reducing the sampling overhead for probabilistic error cancellation (PEC) workflows."
href="https://qiskit.github.io/qiskit-addon-slc/"
analyticsName="Documentation page: SLC"
linkText="Browse documentation"
/>
<Card
title="Propagated noise absorption"
description="Propagated noise absorption (PNA) uses Pauli propagation to absorb information from a noise model into a target observable. Measuring this modified observable has the effect of mitigating the noise as represented by the model."
href="https://qiskit.github.io/qiskit-addon-pna/"
analyticsName="Documentation page: PNA"
linkText="Browse documentation"
/>

</CardGroup>

## Noise management for sampling results
These addons are useful for managing noise when building sample-based quantum workloads.
Comment thread
kaelynj marked this conversation as resolved.
Outdated
Copy link
Copy Markdown
Collaborator

@jenglick jenglick Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I want to add a card here for the postselection capabilities in addon-utils. Even though we call out the addon-utils package later on, I think it's worth highlighting the postselection tools for mitigation

Copy link
Copy Markdown
Collaborator

@jenglick jenglick Apr 10, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's remove the dice-eigensolver card and organize the tiles in this section in this order:
first row: sqd, sqd-hpc
second row: postselection, mthree


<CardGroup>
<Card
title="Matrix-free Measurement Mitigation"
description="Matrix-free Measurement Mitigation (M3) is a package for scalable quantum measurement error mitigation that can be computed in parallel."
href="https://qiskit.github.io/qiskit-addon-mthree/"
analyticsName="Documentation page: M3"
linkText="Browse documentation"
/>
<Card
title="Sample-based quantum diagonalization"
description="Sample-based quantum diagonalization (SQD) classically post-processes noisy quantum samples to yield more accurate eigenvalue estimations of quantum system Hamiltonians."
Expand All @@ -101,4 +117,16 @@ Qiskit addons are a collection of research capabilities for enabling algorithm d
/>
</CardGroup>

## Supplemental addons
Comment thread
kaelynj marked this conversation as resolved.
Outdated
Lastly, this addon contains many useful helper functions to speed up your development process when using the other addons.
Comment thread
kaelynj marked this conversation as resolved.
Outdated
<CardGroup>
<Card
title="Addon utilities"
description="This addon contains functionality which is meant to supplement workflows involving one or more Qiskit addons. For example, this package contains functions for creating Hamiltonians, generating Trotter time evolution circuits, and slicing and combining quantum circuits in time-wise partitions."
Comment thread
kaelynj marked this conversation as resolved.
Outdated
href="https://qiskit.github.io/qiskit-addon-utils/"
analyticsName="Documentation page: addon utilities"
linkText="Browse documentation"
/>
</CardGroup>


Loading