Skip to content
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.

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

Complete LRE user guide #2542

Merged
merged 24 commits into from
Nov 7, 2024
Merged

Complete LRE user guide #2542

merged 24 commits into from
Nov 7, 2024

Conversation

purva-thakre
Copy link
Collaborator

@purva-thakre purva-thakre commented Oct 17, 2024

Description

fixes #2371

Merge after #2541


License

  • 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.

Copy link

codecov bot commented Oct 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.72%. Comparing base (ecfa7dc) to head (0e157bb).
Report is 12 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2542   +/-   ##
=======================================
  Coverage   98.72%   98.72%           
=======================================
  Files          92       92           
  Lines        4161     4167    +6     
=======================================
+ Hits         4108     4114    +6     
  Misses         53       53           

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

@purva-thakre
Copy link
Collaborator Author

For some reason, the RTD build is taking longer than 45-50 mins.

@purva-thakre purva-thakre marked this pull request as ready for review October 22, 2024 22:32
@purva-thakre purva-thakre marked this pull request as draft October 22, 2024 22:32
@purva-thakre
Copy link
Collaborator Author

@natestemen This PR is still in draft status due to part 4 of the user guide. I pinged you so that you could review what's already in this PR.

Copy link
Contributor

@vprusso vprusso left a comment

Choose a reason for hiding this comment

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

Mostly minor comments, but overall looks really great!

docs/source/guide/lre-3-options.md Outdated Show resolved Hide resolved
docs/source/guide/lre-3-options.md Outdated Show resolved Hide resolved
docs/source/guide/lre-3-options.md Outdated Show resolved Hide resolved
docs/source/guide/lre-3-options.md Outdated Show resolved Hide resolved
docs/source/guide/lre-3-options.md Outdated Show resolved Hide resolved
docs/source/guide/lre-3-options.md Outdated Show resolved Hide resolved
docs/source/guide/lre-3-options.md Outdated Show resolved Hide resolved
docs/source/guide/lre-3-options.md Outdated Show resolved Hide resolved
docs/source/guide/lre.md Outdated Show resolved Hide resolved
mitiq/lre/tests/test_layerwise_folding.py Outdated Show resolved Hide resolved
@purva-thakre purva-thakre marked this pull request as ready for review October 25, 2024 13:14
Copy link
Member

@natestemen natestemen left a comment

Choose a reason for hiding this comment

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

Looking good! This is going to be great addition when it's fully incorporated.

README.md Show resolved Hide resolved
docs/source/img/lre_workflow_steps.png Outdated Show resolved Hide resolved
docs/source/guide/lre-3-options.md Outdated Show resolved Hide resolved
docs/source/guide/lre-3-options.md Outdated Show resolved Hide resolved
docs/source/guide/lre-3-options.md Outdated Show resolved Hide resolved
docs/source/guide/lre-3-options.md Outdated Show resolved Hide resolved
docs/source/guide/lre-3-options.md Outdated Show resolved Hide resolved
docs/source/guide/lre-3-options.md Outdated Show resolved Hide resolved
docs/source/guide/lre-4-low-level.md Outdated Show resolved Hide resolved
def _get_scale_factor_vectors(
def get_scale_factor_vectors(
Copy link
Member

Choose a reason for hiding this comment

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

Reminder to myself that I will need to convert this function to allow for arbitrary QPROGRAM.

docs/source/guide/lre-3-options.md Outdated Show resolved Hide resolved
docs/source/guide/lre-3-options.md Outdated Show resolved Hide resolved
docs/source/guide/lre-3-options.md Outdated Show resolved Hide resolved
docs/source/guide/lre-3-options.md Outdated Show resolved Hide resolved
docs/source/guide/lre-3-options.md Outdated Show resolved Hide resolved
docs/source/guide/lre-3-options.md Show resolved Hide resolved
docs/source/guide/lre-3-options.md Outdated Show resolved Hide resolved
docs/source/guide/lre-3-options.md Outdated Show resolved Hide resolved
docs/source/img/lre_workflow_steps.png Outdated Show resolved Hide resolved
docs/source/guide/lre-4-low-level.md Show resolved Hide resolved
Copy link
Member

@natestemen natestemen left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks Purva!

Will merge in the morning and do the release once this is in :)

@natestemen natestemen merged commit 53807c0 into main Nov 7, 2024
18 checks passed
@natestemen natestemen deleted the lre_complete_guide branch November 7, 2024 15:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

User's Guide for LRE
3 participants