Update workflow images in documentation #2034

purva-thakre · 2023-09-29T14:57:04Z

Fixes #2025

To Do:

In Classical Shadows workflow, center the text for mitiq.classicalshadows.
In png of Classical Shadows workflow, the lowest layer is visible. Remove it.
In Classical Shadows workflow, remove error-mitigated from error mitigated expectation value.
In png of Robust Shadows workflow, the lowest layer is visible. Remove it.
Re-orient the two blocks

codecov · 2023-09-29T15:29:38Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (7d05a9f) 98.21% compared to head (d40e1e6) 98.19%.
Report is 3 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2034      +/-   ##
==========================================
- Coverage   98.21%   98.19%   -0.02%     
==========================================
  Files          87       88       +1     
  Lines        4135     4166      +31     
==========================================
+ Hits         4061     4091      +30     
- Misses         74       75       +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

purva-thakre · 2023-09-29T17:08:22Z

If anyone uses a browser other than Chrome or Firefox, it's possible the SVG images don't appear as intended.

docs/CONTRIBUTING_DOCS.md

purva-thakre · 2023-09-29T22:28:30Z

This is ready for a review.

Misty-W

Nice work @purva-thakre, this is a great addition and future timesaver!

Minor comment on the general workflow diagram, it looks a little inconsistent between "Step 1" and "2. Inference". It might help to put "Step 1" in brackets or parentheses, or some other way of indicating that it is a placeholder, unlike "2. Inference" which is consistent across techniques. Maybe even just making the font and size/shape of the boxes the same would be enough to make the diagram look unified.

purva-thakre · 2023-10-27T18:46:11Z

Maybe even just making the font and size/shape of the boxes the same would be enough to make the diagram look unified.

@Misty-W I have tried to make the font type consistent. I will ping you when this is ready for a review later. I still need to make the size and shape of the boxes consistent because the text style is still a bit 'off'.

docs/CONTRIBUTING_DOCS.md

docs/source/img/classicalshadow_workflow.png

Misty-W · 2023-10-31T21:34:23Z

hi @purva-thakre, I wanted to give a heads up that the Mitiq milestone is closing this Thurs (before I go on vacation 😄).

I think the only things remaining to address before merging are Nate's comment about the shadows workflow and my suggestion of how to make the svg download link work. No worries if you can't get to it by then, we'll go ahead with the release and close this up early in the next milestone.

purva-thakre · 2023-10-31T21:49:33Z

@Misty-W Let's move this to the next milestone.

I have been working on other issues and I do want to spend some additional days on this. In addition to Nate's comment, I also want to work on understanding how text scales in Inkscape. The text is still a bit 'off'.

Thank you for your comment on how to make the download link work! Enjoy your vacation!

Misty-W · 2023-10-31T21:51:28Z

@Misty-W Let's move this to the next milestone.

I have been working on other issues and I do want to spend some additional days on this. In addition to Nate's comment, I also want to work on understanding how text scales in Inkscape. The text is still a bit 'off'.

Sounds good thanks @purva-thakre!

Co-authored-by: Misty Wahl <[email protected]>

natestemen

New images are looking really nice! I love the aesthetic.

natestemen · 2023-12-15T18:24:59Z

docs/source/img/classicalshadow_workflow.svg

I don't think we "insert [a] noise channel" in the first dark green box, do we?

I think it should read mitiq.shadows in the center box instead of mitiq.classicalshadows.

I don't think we "insert [a] noise channel" in the first dark green box, do we?

Yes, we do. According to the docs. See step 1 in this section of the docs.

I think it should read mitiq.shadows in the center box instead of mitiq.classicalshadows

Thanks for catching that! I did not double-check the API-doc. Only followed what the previous images stated.

Yes, we do. According to the docs. See step 1 in this section of the docs.

That is the "user defined input" section, however. I think that part of the code to ensure we are using a realistic executor. That is not something that happens in the mitiq.shadows module, which this diagram is explaining.

Would you prefer to have Insert noisy channel moved to the hardware region?

Otherwise, I don't know how to explain the difference between the workflows for ideal classical shadows and robust shadows. The way I understand it, we use the latter in the former after the device noise is characterized.

OR Step 2 could be changed to Noisy Z-basis measurement where the noise is user-defined or the one characterized from the robust shadows workflow.

I see this diagram as explaining what happens under the hood, and I cannot find anywhere in the mitiq.shadows module where we add a noise channel. I can see we apply random Paulis in shadow_quantum_processing, but don't see any insertion/application of a noise channel, which is why I think that part may be unnecessary. If you agree this is the purpose of the image, can you show me where I'm missing this part?

I personally can't understand the details of robust shadow in Mitiq. I looked at what the main reference of this technique does. https://arxiv.org/abs/2011.09636

Step 7 is where the device noise is characterized.

Steps 8, 9 and 10 are where the classical shadows workflow comes into play.

How about I remove the insert noisy channel part and make changes to Step 2? It would then be labeled as Noisy Z-basis measurement.

Just in case anyone is following along, Purva and I chatted and agreed her suggestion sounds good. We will go forward with that.

docs/source/img/rshadows_workflow_minli.png

purva-thakre · 2023-12-18T23:07:44Z

I am going ahead and merging this.

There is a drop in coverage but the uncovered lines are not related to this PR.

purva-thakre commented Sep 29, 2023

View reviewed changes

docs/CONTRIBUTING_DOCS.md Outdated Show resolved Hide resolved

purva-thakre force-pushed the shadows_workflow branch 2 times, most recently from c7743e2 to 27334b0 Compare September 29, 2023 19:19

purva-thakre requested a review from nathanshammah September 29, 2023 22:00

Misty-W self-requested a review October 27, 2023 04:47

Misty-W approved these changes Oct 27, 2023

View reviewed changes

purva-thakre force-pushed the shadows_workflow branch 2 times, most recently from a468803 to 912329e Compare October 27, 2023 18:41

purva-thakre commented Oct 27, 2023

View reviewed changes

docs/CONTRIBUTING_DOCS.md Outdated Show resolved Hide resolved

natestemen reviewed Oct 31, 2023

View reviewed changes

docs/source/img/classicalshadow_workflow.png Outdated Show resolved Hide resolved

purva-thakre and others added 12 commits December 15, 2023 09:48

add template

a3e71f1

change classical shadows workflow

ed21ea7

replace rshadows workflow

7263f17

remove underscore from classical shadows

947b488

img substitution

dbdaf10

change typos + remove duplicate

dbd9e90

change img path to fix docs failure

c057002

nicer images

db9780d

misty's feedback

aba3f8b

Update docs/CONTRIBUTING_DOCS.md

ceffa9f

Co-authored-by: Misty Wahl <[email protected]>

update general template

3a9b1f0

add new cs workflow

870420e

purva-thakre force-pushed the shadows_workflow branch from b84c740 to 870420e Compare December 15, 2023 15:48

natestemen self-requested a review December 15, 2023 17:07

add rs workflow

5ba6799

natestemen reviewed Dec 15, 2023

View reviewed changes

purva-thakre added 2 commits December 18, 2023 08:15

checklist changes + nate's feedback

5454f99

remove insert noise channel

d40e1e6

purva-thakre merged commit 05be477 into master Dec 18, 2023
15 of 16 checks passed

purva-thakre deleted the shadows_workflow branch December 18, 2023 23:07

This was referenced Dec 19, 2023

Codecov build failure #2131

Closed

Make changes to the shadows workflows #2141

Closed

purva-thakre restored the shadows_workflow branch December 21, 2023 01:45

purva-thakre deleted the shadows_workflow branch December 21, 2023 01:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update workflow images in documentation #2034

Update workflow images in documentation #2034

purva-thakre commented Sep 29, 2023 •

edited

Loading

codecov bot commented Sep 29, 2023 •

edited

Loading

purva-thakre commented Sep 29, 2023

purva-thakre commented Sep 29, 2023 •

edited

Loading

Misty-W left a comment

purva-thakre commented Oct 27, 2023

Misty-W commented Oct 31, 2023

purva-thakre commented Oct 31, 2023 •

edited

Loading

Misty-W commented Oct 31, 2023

natestemen left a comment

natestemen Dec 15, 2023

purva-thakre Dec 18, 2023 •

edited

Loading

natestemen Dec 18, 2023

purva-thakre Dec 18, 2023 •

edited

Loading

natestemen Dec 18, 2023

purva-thakre Dec 18, 2023

natestemen Dec 18, 2023

purva-thakre commented Dec 18, 2023

Update workflow images in documentation #2034

Update workflow images in documentation #2034

Conversation

purva-thakre commented Sep 29, 2023 • edited Loading

codecov bot commented Sep 29, 2023 • edited Loading

Codecov Report

purva-thakre commented Sep 29, 2023

purva-thakre commented Sep 29, 2023 • edited Loading

Misty-W left a comment

Choose a reason for hiding this comment

purva-thakre commented Oct 27, 2023

Misty-W commented Oct 31, 2023

purva-thakre commented Oct 31, 2023 • edited Loading

Misty-W commented Oct 31, 2023

natestemen left a comment

Choose a reason for hiding this comment

natestemen Dec 15, 2023

Choose a reason for hiding this comment

purva-thakre Dec 18, 2023 • edited Loading

Choose a reason for hiding this comment

natestemen Dec 18, 2023

Choose a reason for hiding this comment

purva-thakre Dec 18, 2023 • edited Loading

Choose a reason for hiding this comment

natestemen Dec 18, 2023

Choose a reason for hiding this comment

purva-thakre Dec 18, 2023

Choose a reason for hiding this comment

natestemen Dec 18, 2023

Choose a reason for hiding this comment

purva-thakre commented Dec 18, 2023

purva-thakre commented Sep 29, 2023 •

edited

Loading

codecov bot commented Sep 29, 2023 •

edited

Loading

purva-thakre commented Sep 29, 2023 •

edited

Loading

purva-thakre commented Oct 31, 2023 •

edited

Loading

purva-thakre Dec 18, 2023 •

edited

Loading

purva-thakre Dec 18, 2023 •

edited

Loading