Skip to content

Commit

Permalink
Hotfix/docs system (#325)
Browse files Browse the repository at this point in the history
* Add slurm_system to docs

* Fix typo

* Fix system config docs

* Fix system config docs

* Fix system config docs

* Fix system config docs
  • Loading branch information
satyaog authored Dec 11, 2024
1 parent 9d296b2 commit 4dc0ba9
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions docs/usage.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

Install and use
---------------
===============

.. note::

Expand All @@ -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.

Expand All @@ -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).

Expand All @@ -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.

Expand All @@ -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:

Expand Down Expand Up @@ -113,8 +113,17 @@ Create a configuration file which contains the following structure:
user: username
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``
command:
| ``milabench slurm_system > config/system.yaml``

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:
Expand Down

0 comments on commit 4dc0ba9

Please sign in to comment.