[Bindings] add bindings to query mem usage & use it in dtt bench

[tdavidcl]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @tdavidcl, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the benchmarking capabilities by integrating memory usage profiling into the existing Dual Tree Traversal (DTT) performance tests. It provides a clearer picture of resource consumption alongside execution times, allowing for better optimization and understanding of the system's performance characteristics.

Highlights

• Memory Usage Bindings: Introduced new C++ functions to query and reset memory performance information, specifically tracking maximum allocated bytes on host, device, and shared memory. These functions are now exposed to Python via pybind11.
• Dual Tree Traversal (DTT) Benchmark Enhancement: The DTT performance benchmark script (run_dtt_performance.py) has been updated to incorporate the new memory usage tracking. It now measures and reports the maximum memory delta during each benchmark run.
• Benchmark Reporting: The benchmark results now include memory usage data, which is displayed in the checkerboard plots, providing a more comprehensive view of performance beyond just execution time.
• Dynamic Benchmark Skipping: The benchmark execution logic was modified to skip subsequent runs for a given theta_crit if a memory threshold (threshold_run) is exceeded, preventing excessive memory consumption during sweeps.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces memory usage tracking to the dual-tree traversal (DTT) benchmark. It adds C++ functions to query and reset memory usage statistics, exposes these to Python through pybind11, and integrates them into the benchmark script. The script now also skips benchmarks that exceed a defined memory threshold. The changes are well-structured and functional. I have provided a couple of suggestions to improve code clarity and maintainability in the Python bindings and the benchmark script.

[github-actions]

Workflow report

workflow report corresponding to commit a3482fe
Commiter email is timothee.davidcleris@proton.me
GitHub page artifact URL GitHub page artifact link (can expire)

Pre-commit check report

Pre-commit check: ✅

trim trailing whitespace.................................................Passed
fix end of files.........................................................Passed
check for merge conflicts................................................Passed
check that executables have shebangs.....................................Passed
check that scripts with shebangs are executable..........................Passed
check for added large files..............................................Passed
check for case conflicts.................................................Passed
check for broken symlinks................................................Passed
check yaml...............................................................Passed
detect private key.......................................................Passed
No-tabs checker..........................................................Passed
Tabs remover.............................................................Passed
Validate GitHub Workflows................................................Passed
clang-format.............................................................Passed
black....................................................................Passed
ruff check...............................................................Passed
Check doxygen headers....................................................Passed
Check license headers....................................................Passed
Check #pragma once.......................................................Passed
Check SYCL #include......................................................Passed
No ssh in git submodules remote..........................................Passed

Test pipeline can run.

Clang-tidy diff report

No relevant changes found.
Well done!

You should now go back to your normal life and enjoy a hopefully sunny day while waiting for the review.

Doxygen diff with main

Removed warnings : 3
New warnings : 3
Warnings count : 7689 → 7689 (0.0%)

Detailed changes :

- src/shambackends/src/details/internal_alloc.cpp:125: warning: Member log_mem_perf_info(const std::shared_ptr< DeviceScheduler > &dev_sched) (function) of namespace sham::details is not documented.
+ src/shambackends/src/details/internal_alloc.cpp:131: warning: Member log_mem_perf_info(const std::shared_ptr< DeviceScheduler > &dev_sched) (function) of namespace sham::details is not documented.
- src/shampylib/src/pyShambackends.cpp:25: warning: Member register_DeviceBuffer(py::module &m, const char *class_name) (function) of file pyShambackends.cpp is not documented.
+ src/shampylib/src/pyShambackends.cpp:26: warning: Member register_DeviceBuffer(py::module &m, const char *class_name) (function) of file pyShambackends.cpp is not documented.
- src/shampylib/src/pyShambackends.cpp:68: warning: Member Register_pymod(shambackendslibinit) (function) of file pyShambackends.cpp is not documented.
+ src/shampylib/src/pyShambackends.cpp:69: warning: Member Register_pymod(shambackendslibinit) (function) of file pyShambackends.cpp is not documented.