Update MPS manual in docs
#262
Open
+313
−66
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
| An `MPS` representation is not unique: a single `MPS` can be represented in different canonical [`Form`](@ref). The choice of canonical form can affect the efficiency and stability of algorithms used to manipulate the `MPS`. You can check the canonical form of an `MPS` by calling the `form` function: | ||
|
|
||
| ```@example | ||
| mps = MPS([rand(2, 2), rand(2, 2, 2), rand(2, 2)]) |
There was a problem hiding this comment.
# default ordering is (physical, virtual left, virtual right)
| ### Canonical Forms | ||
|
|
||
| An `MPS` representation is not unique: a single `MPS` can be represented in different canonical [`Form`](@ref). The choice of canonical form can affect the efficiency and stability of algorithms used to manipulate the `MPS`. You can check the canonical form of an `MPS` by calling the `form` function: | ||
|
|
There was a problem hiding this comment.
Depending on the form, Tenet will dispatch under the hood the appropriate algorithm which makes full use of the canonical form, so be careful when making modifications that might alter the form without changing the trait.
docs/src/manual/ansatz/mps.md
Outdated
|
|
||
| fig # hide | ||
| ``` | ||
|
|
||
| ### Canonical Forms | ||
|
|
||
| An `MPS` representation is not unique: a single `MPS` can be represented in different canonical [`Form`](@ref). The choice of canonical form can affect the efficiency and stability of algorithms used to manipulate the `MPS`. You can check the canonical form of an `MPS` by calling the `form` function: |
There was a problem hiding this comment.
The current form of the MPS is stored as a trait (refs etc) and can be accessed via the form function
starsfordummies
approved these changes
Nov 26, 2024
… of Yao gates (#258) * try fix reordering of sites * try fix layout of multi-qubit gates in Yao to Tenet conversion * Remove permutedims & add collect for array building * minor fixes on Reactant pkg extension * implement `copy` for some structs * fix column- to row-major layout conversion on `Reactant.promote_to` call * remove dead code --------- Co-authored-by: Todorbsc <[email protected]>
* Add evolve! function for an MPS with an MPO * Add tests for MPS-MPO evolution * Remove unnecessary @show * Add comment * Fix kwarg handling on truncate! function * Fix normalize! for Canonical form and small fixes on evolve! with MPO * Extend evolve!(mps, mpo) tests * Format code * Remove unnecessary kwarg * Refactor code so it is easier to extend for other canonical forms * Fix comment * Enhance tests * Add reset_index kwarg * Update tests * Format code * Remove unnecessary Quantum functions, add docstring for truncate_sweep! * Format code * Remove stale function
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.
Summary
This PR updates the
MPSmanual, accounting with the changes fromMPSrefactor (PR #232) and thus adding explanation of the different canonical forms we support. I think it makes sense that the manual for the canonical forms is in thisMPSmanual.Additionally, I fixed a problem in the
Project.tomlof the docs.@starsfordummies Can you take a look at the explanation on each canonical form? Maybe we can explain it better.