Refactor `Ansatz` to be a concrete type with lattice information #223

mofeing · 2024-10-26T22:14:00Z

As discussed offline, we decided to slice #204 into smaller PRs. This first PR makes Ansatz a concrete type with lattice information contained in a graph.

The important thing you should review is the API, not the details; we can change the graph type in the future but we want the API to be stable.

Changelog

Introduced Lattice graph type
- It's basically a Graphs.SimpleGraph with a bijective mapping between vertices and Sites
- It adds Graphs ~~and MetaGraphsNext~~ as dependenc~~ies~~y
Make Ansatz a concrete type in the type hierarchy
- Its abstract counterpart is AbstractAnsatz
Delete Chain, Product, Grid and Dense
- These will be re-added in subsequent PRs, adapted to the new Ansatz layer
Make Form the canonical form information trait
Refactor some evolve! methods based on simple-update to simple_update! and generalize it for any AbstractAnsatz
Added @testset_skip macro to implement @jofrevalles's idea of skipping whole testsets temporarily

Notes

~~Currently there is a bug in Julia makes Enzyme crash on an Ansatz due to its field lattice being abstract active_reg_inner crashes on Tuple{X} where {X} EnzymeAD/Enzyme.jl#1923~~ Should no longer be necessary because we replaced MetaGraph for Lattice
- ~~It's fixed in Julia 1.11.0 and should be fixed in Julia ~~1.10.6~~ 1.10.7~~
- ~~I temporarily fixed it by fixing Ansatz to just 1D connectivity (i.e. Site{1}) but I'm removing it now -> For the time being you will need Julia 1.11 if you want to diff an Ansatz~~
~~There are other bug fixes (like Base.in or GraphMakie.graphplot! on AbstractTensorNetwork) that I'm gonna remove now and move to other PRs~~ Already pushed to master
Might change Lattice to Topology in the future, because it's more accurate if we're not using the partial ordering property of lattices
In the future, we might change the subjacent graph type in Lattice for custom ones to accommodate clustered sites (i.e. a tensor containing 2+ sites) or hypergraphs

src/Tenet.jl

jofrevalles · 2024-10-29T09:17:24Z

@mofeing @starsfordummies I think that when we talked about splitting the large PR into small ones, we meant that this PR would only contain the new Ansatz struct, and I see here that you pushed the commits regarding the canonical form, which IMO they should be in another PR. In this way, we can refactor the tests that are failing (like Chain, Dense, ...) in another PR.

mofeing · 2024-10-29T09:19:11Z

@mofeing @starsfordummies I think that when we talked about splitting the large PR into small ones, we meant that this PR would only contain the new Ansatz struct, and I see here that you pushed the commits regarding the canonical form, which IMO they should be in another PR. In this way, we can refactor the tests that are failing (like Chain, Dense, ...) in another PR.

Sorry, but I don't agree. The Form trait is part of Ansatz, even if it doesn't have a field for that.

The other ansatzes will be reimplemented in subsequent PRs because tests had to be changed.

jofrevalles

I prefer to have @test_skip instead of commenting all the tests.

test/integration/YaoBlocks_test.jl

test/Product_test.jl

test/Ansatz_test.jl

src/Ansatz/Ansatz.jl

mofeing · 2024-10-29T11:46:08Z

I prefer to have @test_skip instead of commenting all the tests.

That's a valid request and a good idea. Will change it now and recover the deleted tests as @test_skip... The only thing is I'm not sure if it will still try to evaluate the code, which will obviously crash because we're breaking the API. So maybe @test_broken but doesn't matter which.

…top of recent changes

test/runtests.jl

src/Ansatz.jl

Co-authored-by: Jofre Vallès Muns <[email protected]>

…cal forms

Todorbsc

👍

jofrevalles · 2024-11-04T14:08:36Z

If we fix the documentation I guess we can merge

mofeing · 2024-11-04T14:23:35Z

If we fix the documentation I guess we can merge

Docs are basically broken. We need to redo them but after this PR.

starsfordummies

Sergio breaks tenet in all possible ways without even documenting what's broken. Typical commit, looks good to me 👍

* Refactor `Product` on top of new `Ansatz` type * Format code * Fix typo * Refactor `adapt_structure` method to support additional types * Refactor `Reactant.make_tracer`, `Reactant.create_result` methods on top of recent changes * Refactor `ChainRules` methods on top of new types * Aesthetic name fix * Stop using `IdDict` on Reactant extension * Refactor lattice generation in constructors of `Dense`, `Product`, `MPS`, `MPO`, `PEPS` * Reenable `Product` tests * fix constructors * remove `zeros`, `ones` (not well defined) * fix symbol import * export `Product` * fix constructors * refactor tests * fix typo * move file * Document `Product` constructor

mofeing added refactor Change internals triage Needs group consensus breaking-change labels Oct 26, 2024

mofeing requested review from a team, arturgs, jofrevalles and Todorbsc October 26, 2024 22:14

jofrevalles requested changes Oct 29, 2024

View reviewed changes

src/Tenet.jl Show resolved Hide resolved

mofeing force-pushed the concretize-ansatz branch 2 times, most recently from 7a870b7 to 0bef4a9 Compare October 29, 2024 09:36

jofrevalles requested changes Oct 29, 2024

View reviewed changes

test/integration/YaoBlocks_test.jl Outdated Show resolved Hide resolved

test/Product_test.jl Outdated Show resolved Hide resolved

test/Ansatz_test.jl Show resolved Hide resolved

src/Ansatz/Ansatz.jl Outdated Show resolved Hide resolved

mofeing added 16 commits November 2, 2024 20:47

Introduce Canonical Form trait

e1019ad

Refactor Ansatz into a concrete type

d2119c6

Fix typos in Ansatz

cadb6de

Use Graphs.neighbors

887df52

Implement copy, similar, zero for Ansatz

9a46eef

Relax sites condition on Ansatz construction for lanes

cac33e9

Remove some exports

f2d03eb

Move Chain code to AbstractAnsatz and MPS

fb71ac2

Force Graphs to be a strong dependency

a94d949

Implement Graphs.neighbors, isneighbor methods

6dffca6

Refactor adapt_structure method to support additional types

c4678ba

Refactor Reactant.make_tracer, Reactant.create_result methods on …

f0d5124

…top of recent changes

Refactor ChainRules methods on top of new types

cb0f5a9

Refactor ProjectTo for Ansatz

45752d4

Export canonize_site, canonize_site! methods

e2a61e6

Add Graphs, MetaGraphsNext as test dependencies

081ab06

mofeing added 14 commits November 3, 2024 00:39

import Graphs.contract to avoid namespace conflicts

d55f88b

delete "Ansatz" folder

3dacdee

document stuff

a778152

fix include

75199d9

fix tests

45ca798

fix simple_update! for 2-local operators

c1a9d48

reenable tests for simple_update!, evolve! on 2-local operators

e22ef05

fix tests

00b69dc

fix ChainRulesTestUtils.rand_tangent for Lattice

6b7ab2d

fix typo

c37de29

Implement ChainRulesTestUtils.test_approx for Lattice

da52ec3

clean comment

ab8c7f4

fix typo again

b7010ba

Stop installing ITensorNetworks on test

2c967a1

mofeing requested a review from jofrevalles November 3, 2024 01:34

jofrevalles requested changes Nov 4, 2024

View reviewed changes

test/runtests.jl Outdated Show resolved Hide resolved

src/Ansatz.jl Show resolved Hide resolved

mofeing and others added 2 commits November 4, 2024 10:30

Reinclude skipped test sets of Product and Chain

73f3ec0

Co-authored-by: Jofre Vallès Muns <[email protected]>

Refactor truncate! to account for different methods based on canoni…

f2fbc3f

…cal forms

This was linked to issues Nov 4, 2024

Define canonize-form "semantics" and add verifiers for Chain ansatz #166

Closed

Move Ansatz type-hierarchy to a trait system #184

Closed

Todorbsc approved these changes Nov 4, 2024

View reviewed changes

jofrevalles self-requested a review November 4, 2024 14:23

jofrevalles approved these changes Nov 4, 2024

View reviewed changes

starsfordummies approved these changes Nov 4, 2024

View reviewed changes

arturgs approved these changes Nov 4, 2024

View reviewed changes

mofeing merged commit a432fa3 into master Nov 4, 2024
4 of 5 checks passed

mofeing deleted the concretize-ansatz branch November 4, 2024 15:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor `Ansatz` to be a concrete type with lattice information #223

Refactor `Ansatz` to be a concrete type with lattice information #223

mofeing commented Oct 26, 2024 •

edited

Loading

jofrevalles commented Oct 29, 2024

mofeing commented Oct 29, 2024 •

edited

Loading

jofrevalles left a comment

mofeing commented Oct 29, 2024

Todorbsc left a comment

jofrevalles commented Nov 4, 2024

mofeing commented Nov 4, 2024

starsfordummies left a comment

Refactor Ansatz to be a concrete type with lattice information #223

Refactor Ansatz to be a concrete type with lattice information #223

Conversation

mofeing commented Oct 26, 2024 • edited Loading

Changelog

Notes

jofrevalles commented Oct 29, 2024

mofeing commented Oct 29, 2024 • edited Loading

jofrevalles left a comment

Choose a reason for hiding this comment

mofeing commented Oct 29, 2024

Todorbsc left a comment

Choose a reason for hiding this comment

jofrevalles commented Nov 4, 2024

mofeing commented Nov 4, 2024

starsfordummies left a comment

Choose a reason for hiding this comment

Refactor `Ansatz` to be a concrete type with lattice information #223

Refactor `Ansatz` to be a concrete type with lattice information #223

mofeing commented Oct 26, 2024 •

edited

Loading

mofeing commented Oct 29, 2024 •

edited

Loading