Documenting how the `Estimator` calculates stds

SamFerracin commented 5 days ago

Summary

This PR slightly modifies the formula used by the Estimator to calculate stds, and adds details on how the stds are computed.

Details and comments

Addresses issue 1751.

qiskit-bot commented 5 days ago

Thank you for opening a new pull request.

Before your PR can be merged it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient.

While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone.

One or more of the following people are relevant to this code:

@Qiskit/terra-core
@ajavadia
@levbishop
@t-imamichi

qiskit-bot commented 5 days ago

Thank you for opening a new pull request.

Before your PR can be merged it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient.

While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone.

One or more of the following people are relevant to this code:

@Qiskit/terra-core
@ajavadia
@levbishop
@t-imamichi

coveralls commented 5 days ago

Pull Request Test Coverage Report for Build 9681788876

Details

2 of 2 (100.0%) changed or added relevant lines in 1 file are covered.
15 unchanged lines in 2 files lost coverage.
Overall coverage increased (+0.01%) to 89.761%

Files with Coverage Reduction	New Missed Lines	%
crates/qasm2/src/lex.rs	3	93.13%
crates/qasm2/src/parse.rs	12	97.15%
<!--	Total:	15	-->

Totals
Change from base Build 9680727079:	0.01%
Covered Lines:	63786
Relevant Lines:	71062

💛 - Coveralls

coveralls commented 3 days ago

Pull Request Test Coverage Report for Build 9715313071

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

3 of 3 (100.0%) changed or added relevant lines in 1 file are covered.
384 unchanged lines in 12 files lost coverage.
Overall coverage decreased (-0.006%) to 89.744%

Files with Coverage Reduction	New Missed Lines	%
qiskit/circuit/library/standard_gates/r.py	1	97.73%
crates/qasm2/src/expr.rs	1	94.02%
crates/accelerate/src/isometry.rs	1	99.65%
crates/accelerate/src/sampled_exp_val.rs	1	88.71%
crates/accelerate/src/convert_2q_block_matrix.rs	3	93.02%
crates/qasm2/src/lex.rs	7	91.35%
crates/accelerate/src/pauli_exp_val.rs	8	89.68%
crates/accelerate/src/sparse_pauli_op.rs	15	93.27%
qiskit/circuit/quantumcircuit.py	17	95.69%
crates/accelerate/src/euler_one_qubit_decomposer.rs	20	89.68%
<!--	Total:	384	-->

Totals
Change from base Build 9680727079:	-0.006%
Covered Lines:	63801
Relevant Lines:	71092

Qiskit / qiskit