[rocpd] Adding summary module to generate summaries from rocpd database + query submodule + rocpd command-line tools (#488)

* adding summary.py to generate tmp <category_region>_summary views

* migrating CSV summary to SDK method of writing CSVs

  - Add domain_view to summary.py
  - omit the C++ code of writing CSV because it gets revered later anyway

* Add summary subparser and write_sql_view_to_csv function

* adding all <>_summary views generation to summary.py

* add summary_per_rank feature

* add --summary-per-rank

* reconstruct generate_summary_view and create_domain_view

-introduce by_rank

* remove sqr and variance in summary views

* use RocpdImportData instead of connection

* two fixes on summary.py

--modify the generate_summary_view function to return a tuple with view name and sql code

add if_not_exits parameter to generete_summary_view

* Refactor summary.py to allow output path and filename args, and apply time_window
- clean up summary table column headers
- only generate by-rank views if that param is specified

* Add ProcessID to Hostname output and csv, so users can identify the system in the by-rank summaries

* Summary.py, just add hostname to by-rank summaries, instead of creating mapping table

* Summary - migrate csv writer to pandas, for more future flexibility

* Adding a few simple tests for summary.py

* Linting fixes

* add region_categories to summary options

  -  Automatically retrieve region categories from the database if argument is None

* add backticks for view_names

* fix tests after rebase

* Made code review changes
- fixed whitespace in CMakelists.txt
- adding query.py module & subparser in __main__.py
- refactor summary function to return query
- used query.py to output csv
- used query.py to also output summary to console
- provided new command line options to select summary output to csv or console

* Made fix to jinja template in query.py, as suggested by copilot

* Consolidated output calls to query in export_view function based on feedback
- refactored: helpers, query functions, create view functions
- extended formats to include what query supports (md, html, pdf, json)
- added json format to query, and changed orient=records
- adding jinja2 and reportlab to requirements.txt

* Add version_info for rocpd and roctx

* Add rocpd commandline tool

* Add executable permissions to source/bin/rocpd.py

* Removed rocpd2query, and cleaned up --help examples

---------

Co-authored-by: acanadas <acanadas@amd.com>
Co-authored-by: Jin Tao <jintao12@amd.com>
Co-authored-by: a-canadasruiz <Araceli.CanadasRuiz@amd.com>
Co-authored-by: Jonathan R. Madsen <Jonathan.Madsen@amd.com>
Цей коміт міститься в:
Hui, Young
2025-07-24 17:12:06 -04:00
зафіксовано GitHub
джерело 735b5c3d4a
коміт 3954cedd25
13 змінених файлів з 1480 додано та 277 видалено
+52
Переглянути файл
@@ -222,6 +222,58 @@ set_tests_properties(
FIXTURES_REQUIRED
rocprofv3-test-rocpd)
#########################################################################################
#
# Summary generate
#
#########################################################################################
add_test(
NAME rocprofv3-test-rocpd-summary-generation
COMMAND
${Python3_EXECUTABLE} -m rocpd summary --domain-summary --summary-by-rank -f csv
-d ${CMAKE_CURRENT_BINARY_DIR}/rocpd-output-data/summary -i
${CMAKE_CURRENT_BINARY_DIR}/rocpd-input-data/out_results.db)
set_tests_properties(
rocprofv3-test-rocpd-summary-generation
PROPERTIES TIMEOUT
45
LABELS
"integration-tests;rocpd"
ENVIRONMENT
"${rocprofv3-rocpd-env}"
DEPENDS
"rocprofv3-test-rocpd-execute"
FAIL_REGULAR_EXPRESSION
"${ROCPROFILER_DEFAULT_FAIL_REGEX}"
FIXTURES_SETUP
rocprofv3-test-rocpd-generation
FIXTURES_REQUIRED
rocprofv3-test-rocpd)
add_test(
NAME rocprofv3-test-rocpd-summary-generation-multiproc
COMMAND
${Python3_EXECUTABLE} -m rocpd summary --domain-summary --summary-by-rank -f csv
-d ${CMAKE_CURRENT_BINARY_DIR}/rocpd-output-test/summary -o out_mp -i
${CMAKE_CURRENT_BINARY_DIR}/rocpd-input-data-multiproc/out_mp_0_results.db
${CMAKE_CURRENT_BINARY_DIR}/rocpd-input-data-multiproc/out_mp_1_results.db)
set_tests_properties(
rocprofv3-test-rocpd-summary-generation-multiproc
PROPERTIES TIMEOUT
120
LABELS
"integration-tests;rocpd"
ENVIRONMENT
"${rocprofv3-rocpd-env}"
FAIL_REGULAR_EXPRESSION
"${ROCPROFILER_DEFAULT_FAIL_REGEX}"
DISABLED
"${MULTIPROC_IS_DISABLED}"
FIXTURES_REQUIRED
rocprofv3-test-rocpd-multiproc)
#########################################################################################
#
# Validation