DOC: Improve benchmarking readme#8358
Merged
dschult merged 2 commits intonetworkx:mainfrom Dec 2, 2025
Merged
Conversation
amcandio
approved these changes
Dec 2, 2025
| Currently we have two broad categories for benchmarks: | ||
| NetworkX uses [`asv`](https://asv.readthedocs.io/en/latest/) to monitor for | ||
| performance regressions and evaluate proposals for improved performance. | ||
| Available benchmarks are available in the `benchmarks/benchmarks` subdirectory |
Contributor
There was a problem hiding this comment.
This "available" twice is odd. Maybe just:
Suggested change
| Available benchmarks are available in the `benchmarks/benchmarks` subdirectory | |
| The available benchmarks are located in `benchmarks/benchmarks` subdirectory |
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
3 participants
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.
Adds a bit more info re: benchmarking, particularly regarding setup/configuration. Crosslinks to the asv docs for the nitty-gritty details but highlights some of the IME more important config options.