alamb commented on code in PR #26766: URL: https://github.com/apache/datafusion/pull/26766#discussion_r4381111003
########## docs/source/contributor-guide/testing.md: ########## @@ -411,6 +411,31 @@ A full list of benchmarks can be found [here](https://github.com/apache/datafusi _[cargo-criterion](https://github.com/bheisler/cargo-criterion) may also be used for more advanced reporting._ +### Microbenchmark health checks (local-only) + +To execute each Criterion case once without collecting performance measurements: + +```shell +cargo xtask ci step test microbenchmarks +``` + +This command selects workspace bench targets, excluding `datafusion-examples`, +`datafusion-benchmarks` (the SQL benchmark harness), and `datafusion-cli`. It enables Review Comment: The first pargraph could also be cut down: maybe say just "runs all benchmarks once to find runtime panics" ########## docs/source/contributor-guide/testing.md: ########## @@ -411,6 +411,31 @@ A full list of benchmarks can be found [here](https://github.com/apache/datafusi _[cargo-criterion](https://github.com/bheisler/cargo-criterion) may also be used for more advanced reporting._ +### Microbenchmark health checks (local-only) + +To execute each Criterion case once without collecting performance measurements: + +```shell +cargo xtask ci step test microbenchmarks +``` + +This command selects workspace bench targets, excluding `datafusion-examples`, Review Comment: I think we could significantly reduce the amount of text here. For example the second paragraph, while factually true, seems to be far too much detail -- i think the main point is this takes 10 minutes to run, so we don't run it in CI -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
