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

Add theory, intro and use case pages of LRE user guide #2522

Merged
merged 12 commits into from
Oct 11, 2024
Merged

Conversation

purva-thakre
Copy link
Contributor

Description

Fixes #2486


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 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.72%. Comparing base (b7fe9d7) to head (56deede).
Report is 6 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2522   +/-   ##
=======================================
  Coverage   98.72%   98.72%           
=======================================
  Files          90       90           
  Lines        4156     4158    +2     
=======================================
+ Hits         4103     4105    +2     
  Misses         53       53           

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

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.

Going to suggest @vprusso take the first pass at a review of the material. My comments are small and shouldn't overlap (I hope!).

docs/source/guide/lre-5-theory.md Outdated Show resolved Hide resolved
docs/source/guide/lre.md Outdated Show resolved Hide resolved
docs/source/guide/lre-5-theory.md Outdated Show resolved Hide resolved
docs/source/guide/lre-5-theory.md Outdated Show resolved Hide resolved
docs/source/guide/lre-5-theory.md Outdated Show resolved Hide resolved
docs/source/guide/lre-5-theory.md Outdated Show resolved Hide resolved
docs/source/guide/lre-5-theory.md Outdated Show resolved Hide resolved
docs/source/guide/lre-5-theory.md Outdated Show resolved Hide resolved
docs/source/guide/lre-5-theory.md Outdated Show resolved Hide resolved
docs/source/guide/lre-5-theory.md Show resolved Hide resolved
docs/source/guide/lre-5-theory.md Outdated Show resolved Hide resolved
docs/source/guide/lre-5-theory.md Outdated 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.

Great start Purva! I can tell you have a great understanding of this technique, but the this page still needs some work to get all the nuances from your head into the doc so others can understand as well.

docs/source/guide/lre.md Show resolved Hide resolved
docs/source/guide/lre.md Outdated Show resolved Hide resolved
docs/source/guide/lre-5-theory.md Outdated Show resolved Hide resolved
docs/source/guide/lre-5-theory.md Outdated Show resolved Hide resolved
docs/source/guide/lre-5-theory.md Outdated Show resolved Hide resolved
docs/source/guide/lre-5-theory.md Outdated Show resolved Hide resolved
docs/source/guide/lre-5-theory.md Outdated Show resolved Hide resolved
docs/source/guide/lre-5-theory.md Outdated Show resolved Hide resolved
docs/source/guide/lre-5-theory.md Outdated Show resolved Hide resolved
docs/source/guide/lre-5-theory.md Outdated 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.

I'm still finding this page quite confusing. I like the general structure, but I think many of the explanations are flipped with conclusions coming before explanations, or variables being introduced before they're put into context.

docs/source/guide/lre-5-theory.md Outdated Show resolved Hide resolved
docs/source/guide/lre-5-theory.md Outdated Show resolved Hide resolved
docs/source/guide/lre-5-theory.md Outdated Show resolved Hide resolved
docs/source/guide/lre-5-theory.md Outdated Show resolved Hide resolved
docs/source/guide/lre-5-theory.md Outdated Show resolved Hide resolved
docs/source/guide/lre-5-theory.md Outdated Show resolved Hide resolved
docs/source/guide/lre-5-theory.md Outdated Show resolved Hide resolved
docs/source/guide/lre-5-theory.md Outdated Show resolved Hide resolved
docs/source/guide/lre-5-theory.md Outdated Show resolved Hide resolved
O_{\rm LRE} = \sum_{i=1}^M \langle O (\boldsymbol{\lambda}_i)\rangle \frac{\det \left(\mathbf{M}_i (\boldsymbol{0}) \right)}{\det \left(\mathbf{A}\right)}.
$$

To get the matrix $\mathbf{M}_i(\mathbf{0})$, replace the $i$-th row of the sample matrix $\mathbf{A}$ by $\mathbf{e}_1=(1, 0, \ldots, 0)^T$ where except $M_1(0, d) = 1$ all the other monomial terms are zero.
Copy link
Member

Choose a reason for hiding this comment

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

  1. Where does this come from?
  2. Conclusion is needed. Recap what we went through, and maybe add a link to the API-doc LRE section?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Where does this come from?

Discussed before the equation.

Copy link
Member

Choose a reason for hiding this comment

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

I'm not seeing anything in the linked document about the Lagrange interpolation formula about a matrix or replacing a row with a standard basis vector. If I'm missing something please point out where I'm missing it, but otherwise I think needs a bit more introduction.

@purva-thakre purva-thakre changed the title Add the theory page of LRE user guide Add the theory, intro and use case pages of LRE user guide Oct 11, 2024
@purva-thakre purva-thakre changed the title Add the theory, intro and use case pages of LRE user guide Add theory, intro and use case pages of LRE user guide Oct 11, 2024
purva-thakre and others added 9 commits October 10, 2024 20:25
* add intro and use case pages

Co-Authored-By: Purva Thakre <[email protected]>

* clean up intro/use case

* clarify depth comment

* wordsmithing

---------

Co-authored-by: Purva Thakre <[email protected]>
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.

Thanks for all your back and forth on this Purva! I think we can make some more tweaks to the theory page to make is extra super clear, but lets ship with this and then keep improving.

@natestemen natestemen merged commit 7e4fb92 into main Oct 11, 2024
14 of 15 checks passed
@natestemen natestemen deleted the lre_theory branch October 11, 2024 03:35
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.

What is the theory behind LRE
3 participants