Correct QSE module name in diagram

unitaryfund / mitiq

Mitiq is an open source toolkit for implementing error mitigation techniques on most current intermediate-scale quantum computers.

https://mitiq.readthedocs.io

GNU General Public License v3.0

363 stars 163 forks source link

Correct QSE module name in diagram #2361

Closed jordandsullivan closed 6 months ago

jordandsullivan commented 6 months ago

Description

The old diagram for QSE docs said mitiq.subspace_expansion, but the correct module name is mitiq.qse. Updated diagram to say mitiq.qse, added versions to the images, updated references to the old image to point to v2.

License

[x] I license this contribution under the terms of the GNU GPL, version 3 and grant Unitary Fund the right to provide additional permissions as described in section 7 of the GNU GPL, version 3.

Before opening the PR, please ensure you have completed the following where appropriate.

[ ] I added unit tests for new code.
[ ] I used type hints in function signatures.
[ ] I used Google-style docstrings for functions.
[ ] I updated the documentation where relevant.
[ ] Added myself / the copyright holder to the AUTHORS file

codecov[bot] commented 6 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 98.22%. Comparing base (2ff8134) to head (e07f36e).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #2361 +/- ## ======================================= Coverage 98.22% 98.22% ======================================= Files 87 87 Lines 4059 4059 ======================================= Hits 3987 3987 Misses 72 72 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

natestemen commented 6 months ago

Any reason for keeping around the old image and adding a new one?

jordandsullivan commented 6 months ago

Any reason for keeping around the old image and adding a new one?

@cosenal requested it here: https://github.com/unitaryfund/mitiq/issues/2272#issuecomment-2044336266. Maybe he wants to share more of the motivation?

cosenal commented 6 months ago

@jordandsullivan by original file, I meant the same that @natestemen meant in https://github.com/unitaryfund/mitiq/issues/2272#issue-2231881474, that is, the vectorial graphic file that was used to generate the png. I didn't mean v1 of the same png.

jordandsullivan commented 6 months ago

Ah, my misunderstanding. I'll delete the old one :)