From db7dfb6eec257d23678e36d13b26bf7d01a1bdeb Mon Sep 17 00:00:00 2001 From: satyaog Date: Wed, 11 Dec 2024 13:44:47 -0500 Subject: [PATCH 1/6] Add slurm_system to docs --- docs/usage.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/usage.rst b/docs/usage.rst index 004281b6..85567a57 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -113,6 +113,14 @@ Create a configuration file which contains the following structure: user: username +Create a system configuration file +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +| To create a configuration file in a slurm system, the command ``milabench + slurm_system`` will look for available nodes and generate the configuration file +| ``milabench slurm_system > config/system.yaml`` + + Run milabench on a multi-nodes system ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ From a50dc285ce152afff24417cbb0356e3401a3a889 Mon Sep 17 00:00:00 2001 From: satyaog Date: Wed, 11 Dec 2024 14:08:40 -0500 Subject: [PATCH 2/6] Fix typo --- docs/usage.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/usage.rst b/docs/usage.rst index 85567a57..14428872 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -113,8 +113,8 @@ Create a configuration file which contains the following structure: user: username -Create a system configuration file -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Create a slurm configuration file +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | To create a configuration file in a slurm system, the command ``milabench slurm_system`` will look for available nodes and generate the configuration file From eed133597a7de5d27d58b541d9d17c1c0f2e6dcb Mon Sep 17 00:00:00 2001 From: satyaog Date: Wed, 11 Dec 2024 14:34:38 -0500 Subject: [PATCH 3/6] Fix system config docs --- docs/usage.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/usage.rst b/docs/usage.rst index 14428872..0445724d 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -116,8 +116,8 @@ Create a configuration file which contains the following structure: Create a slurm configuration file ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -| To create a configuration file in a slurm system, the command ``milabench - slurm_system`` will look for available nodes and generate the configuration file +| To execute ``milabench`` in a slurm batch job, the generation of the system + configuration file can be automated with the ``milabench slurm_system`` command: | ``milabench slurm_system > config/system.yaml`` From 005131ee01536e4a64762cf1d3507608b05e856c Mon Sep 17 00:00:00 2001 From: satyaog Date: Wed, 11 Dec 2024 14:36:40 -0500 Subject: [PATCH 4/6] Fix system config docs --- docs/usage.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/usage.rst b/docs/usage.rst index 0445724d..acf72269 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -116,8 +116,9 @@ Create a configuration file which contains the following structure: Create a slurm configuration file ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -| To execute ``milabench`` in a slurm batch job, the generation of the system - configuration file can be automated with the ``milabench slurm_system`` command: +| If ``milabench`` is executed in a slurm system, the generation of the + configuration file can be automated with the ``milabench slurm_system`` + command: | ``milabench slurm_system > config/system.yaml`` From ae5ce0a3396781828874b44773682cdf0aa3ce92 Mon Sep 17 00:00:00 2001 From: satyaog Date: Wed, 11 Dec 2024 14:40:26 -0500 Subject: [PATCH 5/6] Fix system config docs --- docs/usage.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/usage.rst b/docs/usage.rst index acf72269..a00a1599 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -1,6 +1,6 @@ Install and use ---------------- +=============== .. note:: @@ -23,7 +23,7 @@ This will install two commands, ``milabench`` and ``voir``. Before running the benchmarks -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +----------------------------- 1. Set the ``$MILABENCH_BASE`` environment variable to the base directory in which all the code, virtual environments and data should be put. @@ -37,7 +37,7 @@ If the machine has both NVIDIA/CUDA and AMD/ROCm GPUs, you may have to set the ` Run milabench -~~~~~~~~~~~~~ +------------- The following command will run the whole benchmark and will put the results in a new directory in ``$MILABENCH_BASE/runs`` (the path will be printed to stdout). @@ -60,7 +60,7 @@ Here are a few useful options for ``milabench run``: Reports -~~~~~~~ +------- The following command will print out a report of the tests that ran, the metrics and if there were any failures. It will also produce an HTML report that contains more detailed information about errors if there are any. @@ -72,11 +72,11 @@ The report will also print out a score based on a weighting of the metrics, as d Use milabench in a multi-nodes system -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------------------- Create a system configuration file -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Create a configuration file which contains the following structure: @@ -123,7 +123,7 @@ Create a slurm configuration file Run milabench on a multi-nodes system -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | Set the ``$MILABENCH_SYSTEM`` environment variable or use the ``--system`` argument to identify the the system configuration file: From 5172816286bff49dbeab665a8e414de478bbf04d Mon Sep 17 00:00:00 2001 From: satyaog Date: Wed, 11 Dec 2024 14:41:16 -0500 Subject: [PATCH 6/6] Fix system config docs --- docs/usage.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/usage.rst b/docs/usage.rst index a00a1599..4e1f16b2 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -113,8 +113,8 @@ Create a configuration file which contains the following structure: user: username -Create a slurm configuration file -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Create a slurm system configuration file +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | If ``milabench`` is executed in a slurm system, the generation of the configuration file can be automated with the ``milabench slurm_system``