Improved documentation - suggestions welcome
The tensor network documentation, in particular, has fallen a bit behind the functionality. This issue is to keep track of what extra documents will hopefully be written and any suggestions for content.
Docs
- [x] A better introduction to the tensor network functionality
- [x] Describe the different levels of interface:
- 'beginner', highest level interfaces (
DMRG,Circuitetc) which manipulate tensor networks for you - specialized
TensorNetworkclasses likeMPS,PEPSwhich encapsulate behaviour. -
TensorNetworkfor generic graphs -
Tensorfor manipulating labelled arrays -
autorayfor the actual backend agnostic array handling
- 'beginner', highest level interfaces (
- [x] How to build TNs and address/select tensors from them including best practices
- [x] Describe the different levels of interface:
- [x] intro to TN drawing functionality
- [ ] intro to
TNOptimizer, including maybeTensorNetwork.fit - [ ] intro to contraction (exact)
- [ ] explain sensitive tradeoff between pathfinding time and contraction time
- [ ] explain usage of
optimize={preset|path|optimizer}
Examples
- [ ] ?
@jcmgray That is super cool to extent documentation: I think we can tell people QUIMb can handle infinite/periodic TN such as iMPS and scale invariant MERA. I will complete the flowing list
- transitional invariant TN like MPS with periodic boundary conditions
- infinite TN: especially iMPS, scale-invariant MERA
- learning CoTenGra in a more practical way? I am curious about that
- 2D Tensor networks like MERA/TTN is missing here
A detailed guide to drawing has been added here - https://quimb.readthedocs.io/en/latest/tensor-drawing.html.
The basic introduction to tensor network functionality has been re-written - https://quimb.readthedocs.io/en/latest/tensor-basics.html.