Skip to content

Commit

Permalink
remove oui from all docs (#449)
Browse files Browse the repository at this point in the history
remove oui
  • Loading branch information
dyokelson authored Nov 26, 2024
1 parent f359d5c commit a98d9a6
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/add-a-dryrun.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ For example, if you are contributing a system called foo you would test it with
- name: Dry run dynamic saxpy on dynamic foo
run: |
benchpark system init --dest=foo-system foo
benchpark experiment init --dest=saxpy-openmp saxpy openmp=oui
benchpark experiment init --dest=saxpy-openmp saxpy +openmp
benchpark setup ./saxpy ./foo-system workspace/
. workspace/setup.sh
ramble \
Expand Down
2 changes: 1 addition & 1 deletion docs/add-a-system-config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ Validating the System
To manually validate your new system, you should initialize it and run an existing experiment such as saxpy. For example::

benchpark system init --dest=modifiedx86-system modifiedx86
benchpark experiment init --dest=saxpy saxpy openmp=oui
benchpark experiment init --dest=saxpy saxpy +openmp
benchpark setup ./saxpy ./modifiedx86-system workspace/

Then you can run the commands provided by the output, the experiments should be built and run successfully without any errors.
Expand Down
9 changes: 5 additions & 4 deletions docs/add-an-experiment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,12 @@ or ``openmp`` for an experiment using OpenMP (on a CPU).::

Multiple types of experiments can be created using variants as well (e.g., strong scaling, weak scaling). See AMG2023 or Kripke for examples.

Once an experiment class has been written, an experiment is initialized with the following command, with any variants that have been defined in your experiment.py passed in as key-value pairs:
``benchpark experiment init --dest {path/to/dest} {benchmark_name} {variant}={oui/non/value}``
Once an experiment class has been written, an experiment is initialized with the following command, with any boolean variants with +/~ or
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=oui workload=problem1 strong=oui``
``benchpark experiment init --dest amg2023_experiment amg2023 +cuda workload=problem1 +strong``

Initializing an experiment generates the following yaml files:

Expand All @@ -74,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=oui strong=oui
benchpark experiment init --dest=baz-benchmark baz +openmp +strong
benchpark setup ./baz-benchmark ./x86 workspace/


Expand Down
2 changes: 1 addition & 1 deletion docs/benchpark-setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Any system or experiment variants are specified at the end of the command as sho
The order of the two init commands does not matter, but they both need to be run before the setup command.::

benchpark system init --dest=</output/path/to/system_def_dir> <SystemName> compiler=<Compiler>
benchpark experiment init --dest=</output/path/to/experiment_def_dir> <Benchmark> <Variant>=<oui/non/value>
benchpark experiment init --dest=</output/path/to/experiment_def_dir> <Benchmark> +/~<Boolean Variant> <String Variant>=<value>


Once you have a benchmark experiment to run, along with the programming model to use, and a system to run them on.
Expand Down
4 changes: 2 additions & 2 deletions docs/llnl-tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ system specification in Benchpark::

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

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

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

Expand Down Expand Up @@ -66,7 +66,7 @@ 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 experiment init --dest=saxpy-benchmark saxpy rocm=oui
benchpark experiment init --dest=saxpy-benchmark saxpy +rocm
benchpark setup ./saxpy-benchmark ./tioga-system workspace/
. workspace/setup.sh
cd ./workspace/saxpy-benchmark/Tioga-975af3c/workspace/
Expand Down

0 comments on commit a98d9a6

Please sign in to comment.