manasa-manoj-nbr opened a new pull request, #18365:
URL: https://github.com/apache/datafusion/pull/18365
## Which issue does this PR close?
- Closes #17811
## Rationale for this change
The DataFusion project has an extensive benchmarking infrastructure with
many different benchmark types (TPCH, ClickBench, IMDB, H2O.ai,
micro-benchmarks, etc.) scattered across README files and code comments.
Contributors need a centralized, easily discoverable resource to understand
what benchmarks are available, how to use them for validating performance
changes, and where to add new benchmark code. This addresses the maintainer's
request in issue #17811 to create a dedicated documentation page describing all
the benchmark code we have.
## What changes are included in this PR?
- Created docs/source/contributor-guide/benchmarking.md: A comprehensive
documentation page covering all DataFusion benchmarks, organized by categories
(Performance Benchmarks, Specialized Benchmarks, Micro-benchmarks)
- Updated docs/source/index.rst: Added the new benchmarking page to the
Contributor Guide navigation structure
- Updated docs/source/contributor-guide/testing.md: Added cross-reference to
the new dedicated benchmarking page in the existing benchmarks section
The new documentation consolidates information about:
- All major benchmark suites (TPCH, ClickBench, IMDB, H2O.ai, Sort, External
Aggregation, etc.)
- Usage instructions for bench.sh script and dfbench binary
- Configuration options and environment variables
- Guidelines for adding new benchmarks
- Troubleshooting common issues
## Are these changes tested?
- Documentation builds successfully without warnings or errors
- Navigation structure tested - new page appears correctly in Contributor
Guide menu
- Internal links verified - all cross-references and links work properly
- Content accuracy verified - all benchmark information sourced from
official /benchmarks/README.md and existing documentation
## Are there any user-facing changes?
No Breaking Changes:
- No changes to APIs, CLIs, or runtime behavior
- No changes to existing benchmark functionality
- Purely additive documentation enhancement
--
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]
