Skip to content

Commit

Permalink
Docs: a few small updates to fix documentation (#541)
Browse files Browse the repository at this point in the history
* a few docs updates

* a few more updates
  • Loading branch information
dyokelson authored Jan 9, 2025
1 parent b5384ff commit 73ad9d7
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions docs/add-an-experiment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ string variants defined in your experiment.py passed in as key-value pairs:
``benchpark experiment init --dest {path/to/dest} {benchmark_name} +/~{boolean variant} {string variant}={value} ``
For example, to run the AMG2023 strong scaling experiment for problem 1, using CUDA the command would be:
``benchpark experiment init --dest amg2023_experiment amg2023 +cuda workload=problem1 +strong``
``benchpark experiment init --dest amg2023_experiment amg2023 +cuda workload=problem1 +strong ~single_node``

Initializing an experiment generates the following yaml files:

Expand All @@ -75,7 +75,7 @@ To manually validate your new experiments work, you should initialize an existin
For example if you just created a benchmark *baz* with OpenMP and strong scaling variants it may look like this:::

benchpark system init --dest=genericx86-system genericx86
benchpark experiment init --dest=baz-benchmark baz +openmp +strong
benchpark experiment init --dest=baz-benchmark baz +openmp +strong ~single_node
benchpark setup ./baz-benchmark ./x86 workspace/


Expand Down
8 changes: 4 additions & 4 deletions docs/llnl-tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ The variant ``cluster`` determines which of the three systems to initialize.
First, initialize the desired cluster variant of the LLNL cts ruby (or dane, magma) system using the existing
system specification in Benchpark::

benchpark system init --dest=ruby-system cts cluster=ruby
benchpark system init --dest=ruby-system llnl-cluster cluster=ruby

To run the openmp, strong scaling version of the AMG20223 benchmark, initialize it for experiments::
To run the openmp, single node scaling version of the AMG20223 benchmark, initialize it for experiments::

benchpark experiment init --dest=amg2023-benchmark amg2023 +openmp
benchpark experiment init --dest=amg2023-benchmark amg2023 +openmp

Then setup the workspace directory for the system and experiment together::

Expand Down Expand Up @@ -65,7 +65,7 @@ version of the Saxpy benchmark on Tioga.
The parameters for initializing the system are slightly different due to the
different variants defined for the system. For example, the variant ``~gtl`` turns off gtl-enabled MPI, ``+gtl`` turns it on::

benchpark system init --dest=tioga-system tioga ~gtl
benchpark system init --dest=tioga-system llnl-elcapitan cluster=tioga ~gtl
benchpark experiment init --dest=saxpy-benchmark saxpy +rocm
benchpark setup ./saxpy-benchmark ./tioga-system workspace/
. workspace/setup.sh
Expand Down
2 changes: 1 addition & 1 deletion docs/modifiers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ benchmarks in Benchpark. More documentation on Caliper can be found `here
To turn on profiling with Caliper, add ``caliper=<caliper_variant>`` to the experiment init
setup step::

benchpark experiment init --dest=</path/to/experiment_root> caliper=<caliper_modifier> </output/path/to/workspace>
benchpark experiment init --dest=</path/to/experiment_root> <benchmark> caliper=<caliper_variant>

Valid values for ``<caliper_variant>`` are found in the **Caliper Variant**
column of the table below. Benchpark will link the experiment to Caliper,
Expand Down

0 comments on commit 73ad9d7

Please sign in to comment.