From 1ad2a49f1652e763c9becd90def06a134e8a9f15 Mon Sep 17 00:00:00 2001 From: Alex Tyler Chapman Date: Wed, 6 Nov 2024 15:26:30 -0800 Subject: [PATCH 1/3] Docs update: Outline how to use SPOT with Serac caliper data --- src/docs/sphinx/dev_guide/profiling.rst | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/src/docs/sphinx/dev_guide/profiling.rst b/src/docs/sphinx/dev_guide/profiling.rst index 274693971..6839c593d 100644 --- a/src/docs/sphinx/dev_guide/profiling.rst +++ b/src/docs/sphinx/dev_guide/profiling.rst @@ -109,7 +109,11 @@ of this file, use `cali-query `_), and open the directory containing one or more ``.cali`` files. For more information, watch this recorded `tutorial `_. +================== Benchmarking Serac +================== + +Running Benchmarks ------------------ To run all of Serac's benchmarks in one command, first make sure Serac is configured @@ -136,7 +140,18 @@ files: - `SPOT CZ `_ - `SPOT RZ `_ -The shared Caliper files for Serac are located here: https://lc.llnl.gov/spot2/?sf=/usr/WS2/smithdev/califiles +Serac benchmarks are run weekly to track changes over time. The following are steps to view this data in a meaningful +way: + +- Go to https://lc.llnl.gov/spot2/?sf=/usr/WS2/smithdev/califiles +- Click the check mark button on the top right to view additional data categories +- Ensure ``mpi.world.size``, ``executable``, ``cluster``, and ``compilers`` are ticked on +- Find the pie and bar charts associated with those categories +- Select one option from each category to filter the graph +- Scroll down to the table and and select the "compare" tab to view the graph + +When changing the filter options in the pie charts, ensure you deselect the previous options, so you don't view two of +one single category. .. note:: There is a bug in SPOT where if you remove Caliper files from a directory, they still show up on SPOT - if you've From 9db52b1c5ba6b7b0cadcd7be878779abb79f2a0a Mon Sep 17 00:00:00 2001 From: Alex Tyler Chapman Date: Wed, 6 Nov 2024 15:34:17 -0800 Subject: [PATCH 2/3] wording and formatting --- src/docs/sphinx/dev_guide/profiling.rst | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/src/docs/sphinx/dev_guide/profiling.rst b/src/docs/sphinx/dev_guide/profiling.rst index 6839c593d..529da8016 100644 --- a/src/docs/sphinx/dev_guide/profiling.rst +++ b/src/docs/sphinx/dev_guide/profiling.rst @@ -109,11 +109,7 @@ of this file, use `cali-query `_), and open the directory containing one or more ``.cali`` files. For more information, watch this recorded `tutorial `_. -================== Benchmarking Serac -================== - -Running Benchmarks ------------------ To run all of Serac's benchmarks in one command, first make sure Serac is configured @@ -150,8 +146,9 @@ way: - Select one option from each category to filter the graph - Scroll down to the table and and select the "compare" tab to view the graph -When changing the filter options in the pie charts, ensure you deselect the previous options, so you don't view two of -one single category. +Filtering benchmarks in this way will allow you to see changes of one benchmark over time, rather than a mix of many +different ones. When changing the filter options in the pie and bar charts, ensure you deselect the previous options, so +you don't view two of one single category. .. note:: There is a bug in SPOT where if you remove Caliper files from a directory, they still show up on SPOT - if you've From 39702ef9cade11e26b08bc341aa9a10c57ec9e6f Mon Sep 17 00:00:00 2001 From: Alex Tyler Chapman Date: Wed, 6 Nov 2024 17:02:07 -0800 Subject: [PATCH 3/3] wording --- src/docs/sphinx/dev_guide/profiling.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/docs/sphinx/dev_guide/profiling.rst b/src/docs/sphinx/dev_guide/profiling.rst index 529da8016..ae5240d92 100644 --- a/src/docs/sphinx/dev_guide/profiling.rst +++ b/src/docs/sphinx/dev_guide/profiling.rst @@ -136,12 +136,12 @@ files: - `SPOT CZ `_ - `SPOT RZ `_ -Serac benchmarks are run weekly to track changes over time. The following are steps to view this data in a meaningful +Serac benchmarks are run weekly to track changes over time. The following are steps to visualize this data in a meaningful way: - Go to https://lc.llnl.gov/spot2/?sf=/usr/WS2/smithdev/califiles - Click the check mark button on the top right to view additional data categories -- Ensure ``mpi.world.size``, ``executable``, ``cluster``, and ``compilers`` are ticked on +- Ensure ``mpi.world.size``, ``executable``, ``cluster``, and ``compilers`` are enabled - Find the pie and bar charts associated with those categories - Select one option from each category to filter the graph - Scroll down to the table and and select the "compare" tab to view the graph