Qiskit / qiskit-ibm-runtime / 27264001633
89%

DEFAULT BRANCH: main
Ran
Jobs 11
Files 313
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 86.944% (+0.008%) from 86.936%
27264001633

push

github

web-flow 
Reintroduce support for multiple result decoders (#2899)

<!--
⚠️ The pull request title should be short detailed and understandable
for all.
⚠️ Also, please add a release note file using reno if the change needs
to be
  documented in the release notes.
⚠️ If your pull request fixes an open issue, please link to the issue.

✅ I have added the tests to cover my changes.
✅ I have updated the documentation accordingly.
✅ I have read the CONTRIBUTING document.
-->

### Summary

Revise the methods that accept `result_decoder` to ensure they also
support sequences of decoders (ie. `type[ResultDecoder] |
Sequence[type[ResultDecoder]] | None = None`) consistently, and update
the logic so the decoders are called in chain in that case.

In practice, it re-introduces the ability of using multiple decoders,
with provides for some degree of easy customizability by end users. It
was introduced around #1450 for dealing with the websocket mechanism,
and some remains remained at the interface level although in practice
[it was restricted to one
decoder](https://github.com/Qiskit/qiskit-ibm-runtime/blob/0.47.0/qiskit_ibm_runtime/base_runtime_job.py#L110-L113)
out of two.

Additionally, it avoids passing the decoder explicitly from the
Primitive classes, as `DEFAULT_DECODERS` is used under the hood for
selecting a default (making declaring and passing them from Primitives
unneeded, and saving some import pressure).

### Details and comments

Related #2852 - not marking as fixed as this does not revise existing
decoders.

### AI/LLM disclosure

- [x] I didn't use LLM tooling, or only used it privately.

7931 of 9122 relevant lines covered (86.94%)

9.5 hits per line

Coverage Regressions

Lines Coverage ∆ File
41
68.67
 0.6% qiskit_ibm_runtime/base_runtime_job.py
29
71.57
 1.16% qiskit_ibm_runtime/runtime_job_v2.py
20
70.24
 0.0% qiskit_ibm_runtime/qiskit_runtime_service.py
19
72.79
 0.0% qiskit_ibm_runtime/session.py
6
93.94
 -0.06% qiskit_ibm_runtime/base_primitive.py
6
88.46
 -0.43% qiskit_ibm_runtime/noise_learner_v3/noise_learner_v3.py
5
88.89
 -0.47% qiskit_ibm_runtime/executor/executor.py
2
80.0
 0.0% qiskit_ibm_runtime/decoders/result_decoder.py
2
97.56
 -0.03% qiskit_ibm_runtime/noise_learner/noise_learner.py
Jobs
ID Job ID Ran Files Coverage
1 unit-tests_python3.11-macos-latest - 27264001633.1 313
86.94
 GitHub Action Run
2 unit-tests_python3.13-macos-latest - 27264001633.2 313
86.94
 GitHub Action Run
3 unit-tests_python3.10-ubuntu-latest - 27264001633.3 313
86.94
 GitHub Action Run
4 unit-tests_python3.12-windows-latest - 27264001633.4 313
85.28
 GitHub Action Run
5 unit-tests_python3.12-ubuntu-latest - 27264001633.5 313
86.94
 GitHub Action Run
6 unit-tests_python3.13-ubuntu-latest - 27264001633.6 313
86.94
 GitHub Action Run
7 unit-tests_python3.11-windows-latest - 27264001633.7 313
85.28
 GitHub Action Run
8 unit-tests_python3.11-ubuntu-latest - 27264001633.8 313
86.94
 GitHub Action Run
9 unit-tests_python3.12-macos-latest - 27264001633.9 313
86.94
 GitHub Action Run
10 unit-tests_python3.13-windows-latest - 27264001633.10 313
85.28
 GitHub Action Run
11 unit-tests_python3.10-windows-latest - 27264001633.11 313
85.28
 GitHub Action Run
Source Files on build 27264001633