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
This commit is contained in:
vedithal-amd
2025-07-25 14:01:34 -04:00
committed by GitHub
parent 99a6e67bcc
commit bb44e90b2d
232 changed files with 44409 additions and 22480 deletions
+1
View File
@@ -1,2 +1,3 @@
rocm-docs-core==1.21.1
sphinxcontrib.datatemplates==0.11.0
sphinx-jinja==2.0.2
+7 -1
View File
@@ -53,7 +53,8 @@ docutils==0.21.2
# myst-parser
# pydata-sphinx-theme
# sphinx
exceptiongroup==1.2.2
# sphinx-jinja
exceptiongroup==1.3.0
# via ipython
executing==2.2.0
# via stack-data
@@ -87,6 +88,7 @@ jinja2==3.1.5
# via
# myst-parser
# sphinx
# sphinx-jinja
jsonschema==4.23.0
# via nbformat
jsonschema-specifications==2024.10.1
@@ -215,6 +217,7 @@ sphinx==8.1.3
# sphinx-copybutton
# sphinx-design
# sphinx-external-toc
# sphinx-jinja
# sphinx-notfound-page
# sphinxcontrib-datatemplates
# sphinxcontrib-runcmd
@@ -226,6 +229,8 @@ sphinx-design==0.6.1
# via rocm-docs-core
sphinx-external-toc==1.0.1
# via rocm-docs-core
sphinx-jinja==2.0.2
# via -r requirements.in
sphinx-notfound-page==1.0.4
# via rocm-docs-core
sphinxcontrib-applehelp==2.0.0
@@ -268,6 +273,7 @@ traitlets==5.14.3
# nbformat
typing-extensions==4.12.2
# via
# exceptiongroup
# ipython
# myst-nb
# pydata-sphinx-theme