Skip to content

Commit

Permalink
Add CLI demo videos to overview.rst
Browse files Browse the repository at this point in the history
Signed-off-by: Christopher M. Cantalupo <christopher.m.cantalupo@intel.com>
  • Loading branch information
cmcantalupo committed May 16, 2024
1 parent 2b3e506 commit 253ec94
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion docs/source/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ pages: :doc:`admin` and :doc:`geopmaccess.1`.
----

|:card_file_box:| Understand the Platform Topology
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. _topo-diagram:
.. figure:: https://geopm.github.io/images/platform-topo-diagram.svg
Expand Down Expand Up @@ -340,6 +340,12 @@ consumed by all packages, cores, and CPUs in the system, one would issue a

For more information about aggregation types, see: :doc:`geopm::Agg.3`.

Video Demo: Using ``geopmread``
"""""""""""""""""""""""""""""""
.. raw:: html

<video src="images/geopmread.webm" type="video/webm" controls="controls" muted="muted" class="d-block rounded-bottom-2 border-top width-fit" style="max-height:640px; min-height: 200px"></video>

Reading Multiple Signals
""""""""""""""""""""""""
To fetch platform telemetry and output it to the console or a file:
Expand Down Expand Up @@ -588,6 +594,12 @@ interface.

Again, for more information on ``geopmsession`` see :doc:`geopmsession.1`.

Video Demo: Using ``geopmsession``
""""""""""""""""""""""""""""""""""
.. raw:: html

<video src="images/geopmsession.webm" type="video/webm" controls="controls" muted="muted" class="d-block rounded-bottom-2 border-top width-fit" style="max-height:640px; min-height: 200px"></video>

----

|:gear:| Enact Hardware-based Settings
Expand Down Expand Up @@ -749,6 +761,12 @@ all the packages in the system. This means that requesting a 200 W power limit
at the ``board`` domain will result in each ``package`` receiving a limit of
100 W.
Video Demo: Using ``geopmwrite``
""""""""""""""""""""""""""""""""
.. raw:: html
<video src="images/geopmwrite.webm" type="video/webm" controls="controls" muted="muted" class="d-block rounded-bottom-2 border-top width-fit" style="max-height:640px; min-height: 200px"></video>
----
|:straight_ruler:| Use the Runtime to Measure Application Performance
Expand Down

0 comments on commit 253ec94

Please sign in to comment.