Unified configuration for metrics (#726)

* Show description of metrics during analysis
    * Use --include-cols Description show the Description column in analyze mode (this is hidden by default)
    * Remove tips field from analysis config

* Align metric names in analysis config and documentation

* Add unified config utils/unified_config.yaml

* Add python script utils/split_config.py to auto generate analysis configuration and documentation metrics description
   * Add test case to ensure unified config is older than auto-generated config
   * Auto generate analysis config and documentation metrics description

* Update CONTRIBUTING.md to add instructions to build documentation assets
    * Add docker image and compose file to build documentation

* Update CHANGELOG and Documentation

* Use jinja template instead of hardcoding metric tables in documentation

[ROCm/rocprofiler-compute commit: bb44e90b2d]
Этот коммит содержится в:
vedithal-amd
2025-07-25 14:01:34 -04:00
коммит произвёл GitHub
родитель dcdadfd37d
Коммит 354fe5f52c
232 изменённых файлов: 44409 добавлений и 22480 удалений
+13 -2
Просмотреть файл
@@ -202,7 +202,7 @@ Examples:
nargs="?",
const="",
# Argument to --list-metrics is optional
choices=[""] + list(supported_archs.keys()), # ["gfx906", "gfx908", "gfx90a"],
choices=[""] + list(supported_archs.keys()), # ["gfx908", "gfx90a"],
help=print_avail_arch(supported_archs.keys()),
)
profile_group.add_argument(
@@ -623,7 +623,18 @@ Examples:
dest="cols",
metavar="",
nargs="+",
help="\t\tSpecify column indices to display.",
help="\t\tSpecify column indices to display.\n\t\tDefaults to display all columns.",
)
analyze_advanced_group.add_argument(
"--include-cols",
dest="include_cols",
metavar="",
nargs="+",
help=(
"\t\tSpecify which hidden column names should be included in cli output.\n"
"\t\tFor example, to show 'Description' column which is hidden by default in cli output,\n"
"\t\tuse the option --include-cols Description."
),
)
analyze_advanced_group.add_argument(
"-g", dest="debug", action="store_true", help="\t\tDebug single metric."