Skip to content

Commit b323ef5

Browse files
committed
Better docs and example name changed
1 parent a3ac1ea commit b323ef5

3 files changed

Lines changed: 26 additions & 10 deletions

File tree

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,9 +94,19 @@ plot_tensornetwork_network_2d([node1, node2, node3])
9494
plot_tensornetwork_network_3d([node1, node2, node3])
9595
```
9696

97+
## Internal architecture
98+
99+
The public API is split by backend, but the render pipeline is now shared:
100+
101+
- `tensor_network_viz._core` contains the normalized graph model, layout, curve geometry, drawing, and shared renderer.
102+
- `tensor_network_viz.tensorkrowch` contains the TensorKrowch adapter that converts TensorKrowch inputs into the shared graph model.
103+
- `tensor_network_viz.tensornetwork` contains the TensorNetwork adapter that converts TensorNetwork node collections into the shared graph model.
104+
105+
This means TensorKrowch and TensorNetwork are not converted into each other. Each backend normalizes its own input to the common `_GraphData` structure and the shared core handles the rest.
106+
97107
## Project layout
98108

99-
- `examples/` - Demo scripts. Run `python examples/tensor_network_demo.py mps 2d` for TensorKrowch or `python examples/tensornetwork_demo.py mps 2d` for TensorNetwork.
109+
- `examples/` - Demo scripts. Run `python examples/tensorkrowch_demo.py mps 2d` for TensorKrowch or `python examples/tensornetwork_demo.py mps 2d` for TensorNetwork.
100110
- `scripts/` - Utility scripts (for example `clean.py` to remove caches and build artifacts).
101111

102112
## Development

examples/README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
Run from the project root (with venv activated or `python` from `.venv`).
44

5-
## tensor_network_demo.py
5+
## tensorkrowch_demo.py
66

77
```bash
8-
python examples/tensor_network_demo.py mps 2d
9-
python examples/tensor_network_demo.py weird 3d
10-
python examples/tensor_network_demo.py disconnected 2d
11-
python examples/tensor_network_demo.py mps 2d --from-list
8+
python examples/tensorkrowch_demo.py mps 2d
9+
python examples/tensorkrowch_demo.py weird 3d
10+
python examples/tensorkrowch_demo.py disconnected 2d
11+
python examples/tensorkrowch_demo.py mps 2d --from-list
1212
```
1313

1414
- **Networks:** `disconnected`, `mps`, `mpo`, `peps`, `weird`
@@ -30,6 +30,12 @@ python examples/tensornetwork_demo.py mps 2d --save mps.png --no-show
3030
- **`--save PATH`:** Save the rendered figure
3131
- **`--no-show`:** Do not open the interactive Matplotlib window
3232

33+
## Architecture note
34+
35+
- `tensor_network_viz._core`: Common graph, layout, drawing, and rendering pipeline
36+
- `tensor_network_viz.tensorkrowch`: TensorKrowch-specific input adapter plus public helpers
37+
- `tensor_network_viz.tensornetwork`: TensorNetwork-specific input adapter plus public helpers
38+
3339
## tn_tsp.py
3440

3541
TSP tensor network visualization (step 0, before contraction).
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@
2727
- disconnected
2828
2929
Examples:
30-
python examples/tensor_network_demo.py mps 2d
31-
python examples/tensor_network_demo.py weird 3d
32-
python examples/tensor_network_demo.py mps 2d --from-list
33-
python examples/tensor_network_demo.py disconnected 2d
30+
python examples/tensorkrowch_demo.py mps 2d
31+
python examples/tensorkrowch_demo.py weird 3d
32+
python examples/tensorkrowch_demo.py mps 2d --from-list
33+
python examples/tensorkrowch_demo.py disconnected 2d
3434
"""
3535

3636

0 commit comments

Comments
 (0)