Skip to content

Commit

Permalink
add metrics descriptions template for sphinx docs
Browse files Browse the repository at this point in the history
Signed-off-by: Peter Park <[email protected]>
  • Loading branch information
peterjunpark committed Jan 13, 2025
1 parent a77f48d commit 7e7d99d
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 0 deletions.
30 changes: 30 additions & 0 deletions docs/_templates/performance-metrics-table.jinja
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
.. -*- mode: rst -*-
{% for data_source in data["Panel Config"]["data source"] %}

## Anchor for internal linking.
## For example, :ref:`command-processor-fetcher-metrics`.
.. _{{data_source.metric_table.title|lower|replace(" ", "-") }}-metrics:

{{ data_source.metric_table.title }}
-------------------------------------------------------------------------------

.. list-table::
:header-rows: 1

* - Metric
- Description
- Unit

{% for name, desc in data_source.metric_table.metric.items() %}
* - {{ name }}
- {{ desc.tips }}
- {{ desc.unit }}

{% endfor %}
{% endfor %}

.. note::

END

17 changes: 17 additions & 0 deletions docs/conceptual/command-processor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,23 @@ processor’s metrics therefore are focused on reporting, for example:
Command processor fetcher (CPF)
===============================

.. tab-set::

.. tab-item:: MI300X

.. datatemplate:yaml:: ../../src/rocprof_compute_soc/analysis_configs/gfx90a/0500_command-processor.yaml
:template: ../_templates/performance-metrics-table.jinja

.. tab-item:: MI300X

.. datatemplate:yaml:: ../../src/rocprof_compute_soc/analysis_configs/gfx90a/0500_command-processor.yaml
:template: ../_templates/performance-metrics-table.jinja

.. tab-item:: MI300X

.. datatemplate:yaml:: ../../src/rocprof_compute_soc/analysis_configs/gfx90a/0500_command-processor.yaml
:template: ../_templates/performance-metrics-table.jinja

.. list-table::
:header-rows: 1

Expand Down
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
html_title = f"{project} {version_number} documentation"
exclude_patterns = ["archive", "*/includes"]

templates_path = ["_templates"]
html_static_path = ["sphinx/static/css"]
html_css_files = ["o_custom.css"]

Expand Down

0 comments on commit 7e7d99d

Please sign in to comment.