-
Notifications
You must be signed in to change notification settings - Fork 19
Open
Labels
Top priorityThe Issue that has top priorityThe Issue that has top prioritydocsdocumentation/ user guide relateddocumentation/ user guide relatedhelp wantedExtra attention is neededExtra attention is needed
Milestone
Description
The user guide on github has a version 1.0 already. However, it seems to be outdated and needs to be revisited.
The following changes were made to the API were made:
- Contract, Contracts are merged into Contract
- .relabel, .relabels are merged into .relabel
- .relabel_, .relabels_ are merged into .relabel_
- Svd_truncate has an additional optional argument min_blockdim to define a minimum dimension for each block
Also, we should include all parts from the paper where they are not mentioned in detail in the user guide (they can to many parts just be copied).
I would also merge chapters '9. linalg' and '11. linalg extension', such that it is easier to find SVD, QR, eigval.
Finally, the links to the API documentation seem to be broken.
Metadata
Metadata
Assignees
Labels
Top priorityThe Issue that has top priorityThe Issue that has top prioritydocsdocumentation/ user guide relateddocumentation/ user guide relatedhelp wantedExtra attention is neededExtra attention is needed