Compare graphs for generator functions when running tests with backend #7066
Conversation
This file contains 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
This is an alternative to networkx#7063. The backend testing infrastructure can call backend graph generator functions such as `circular_ladder_graph`, and it converts the backend Graph to a networkx Graph. This is a great way to test backend generators! However, sometimes iteration order is different when using the converted backend graph. So, our solution here is to *also* call the original networkx function when the return type is a Graph, compare results, then use the result from networkx to allow tests to pass. We use a series of assertions to help backend implementers identify differences.
|
Shoot, this fails due to mutating input arguments (such as consuming iterators). |
eriknw
commented
Oct 27, 2023
|
Alright, this is passing CI now! You can see how much more complicated this is to do compared to #7063. The benefit should also be clear: this caught several bugs! I had to update the dispatch decorator many places. Hopefully this isn't too much of a maintenance burden--if a function starts to fail, perhaps just add it to the ignore set. Heh, the benefit of #7063 is also clear: it's simple! |
MridulS
reviewed
Nov 7, 2023
eriknw
commented
Nov 7, 2023
If backends want to leverage `nodes_or_number`, they'll need to use it themselves.
|
Is this ready to merge/review? Are there other things to add? |
eriknw
added a commit
to eriknw/cugraph
that referenced
this pull request
Nov 30, 2023
These changes will be necessary when networkx/networkx#7066 is merged.
MridulS
approved these changes
Dec 7, 2023
rapids-bot bot
pushed a commit
to rapidsai/cugraph
that referenced
this pull request
Dec 12, 2023
These changes will be necessary when networkx/networkx#7066 is merged. Authors: - Erik Welch (https://github.com/eriknw) Approvers: - Rick Ratzel (https://github.com/rlratzel) URL: #4028
cvanelteren
pushed a commit
to cvanelteren/networkx
that referenced
this pull request
Apr 22, 2024
networkx#7066) * Compare graphs for generator functions when running tests with backend This is an alternative to networkx#7063. The backend testing infrastructure can call backend graph generator functions such as `circular_ladder_graph`, and it converts the backend Graph to a networkx Graph. This is a great way to test backend generators! However, sometimes iteration order is different when using the converted backend graph. So, our solution here is to *also* call the original networkx function when the return type is a Graph, compare results, then use the result from networkx to allow tests to pass. We use a series of assertions to help backend implementers identify differences. * Handle the edge cases and fix mistakes that were found * Add comment * Don't skip for `star_graph` * Move `@nodes_or_number` after `@nx._dispatch` If backends want to leverage `nodes_or_number`, they'll need to use it themselves. * Don't preserve attributes in `difference`
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.
This is an alternative to #7063 and is much more general.
The backend testing infrastructure can call backend graph generator functions such as
circular_ladder_graph, and it converts the backend Graph to a networkx Graph. This is a great way to test backend generators! However, sometimes iteration order is different when using the converted backend graph. So, our solution here is to also call the original networkx function when the return type is a Graph, compare results, then use the result from networkx to allow tests to pass. We use a series of assertions to help backend implementers identify differences.