docs: document multigraph backend#441
Open
looooown2006 wants to merge 1 commit into
Open
Conversation
Collaborator
|
Hi @looooown2006 thanks for the addition. |
This file contains hidden or 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
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
Document the
Multigraphbackend in the graph guide.This adds a new section covering:
Multigraphdiffers from the defaultGraphSsimple-graph backend;zx.Graph("multigraph")orMultigraph();set_auto_simplify(False)andget_auto_simplify()affect parallel-edge preservation;edge_set();The page introduction is also adjusted so simple-graph storage is described as the default backend behavior, not a property of every PyZX graph backend.
Tests
git diff --checkuv run --isolated --with . python -uv run --isolated --with '.[docs]' python -m sphinx -b html doc doc\_build\htmluv run --isolated --with '.[test]' --with pytest python -m pytest tests\test_jsonparser.py::TestGraphIO::test_load_multigraph_preserve_parallel_edges tests\test_tensor.py::TestTensor::test_multigraph_auto_simplify_parallel_edges tests\test_bialgebra_rule.py -qResults:
doc\simplify.rstnot being included in any toctreeCloses #440.