Last updates before v0.12 tag #230
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAttention: Patch coverage is
|
VictorVanthilt
approved these changes
Jan 21, 2025
There was a problem hiding this comment.
Big fan of the IDMRG1 rename.
The rest of the changes look good.
Having documentation on environments is something that is very necessary in my opinion as this is something I've heard users complain about not being clear at all. It is however, not essential for the release of 0.12 so all is good to go.
leburgel
approved these changes
Jan 21, 2025
There was a problem hiding this comment.
Looks great! I just added a few minor things:
- The
makedocscall threw an error, seemed like a typo in the doctest kwarg and was fixed by changingdoctests -> doctest - There was a missing finite lattice in the Hamiltonian construction in the
ChepigaAnsatzexample, causing it to fail. I added it so it runs and the (local) build is fixed, but it seems it doesn't actually give the expected result? - There was a missing docstring for
fidelity_susceptibility, so I added this to the best of my abilities - The
exact_diagonalizationdocstring was not very useful, so I tried to expand it a bit - Fixed some typos and made some minor cosmetic tweaks
- Added the return arguments to the function signature in the docstrings of the main algorithms. This is something that I keep forgetting, so I thought might as well add it now
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I tried to give the docs a final push to try and get this released tomorrow.
It can locally be run using QuantumKitHub/MPSKitModels.jl#42, which cannot be released before tagging this so we will have to do some post-release fixing of the docs.
While it's obvious that the docs are far from finished, I don't think it is worth it to wait for them to release this. For me, this is thus good to go.