Skip to content

Commit 71cc677

Browse files
fixes from review
1 parent 51c85d9 commit 71cc677

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/tutorial.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -262,15 +262,16 @@ Here is an example for our STREAM benchmark:
262262
263263
@rfm.simple_test
264264
class stream_test(rfm.RunOnlyRegressionTest):
265-
# ...
265+
...
266266
reference = {
267267
'generic:default': {
268268
'copy_bw': (23_890, -0.10, 0.30, 'MB/s'),
269269
'triad_bw': (17_064, -0.05, 0.50, 'MB/s'),
270270
}
271271
}
272272
273-
The :attr:`reference` test variable is a multi-level dictionary that defines the expected performance for each of the test's performance variables on all supported systems (here, ``generic``) and partitions (here, ``default``). We explain more about this pre-defined system later in :ref:`systems-and-environments`.
273+
The :attr:`reference` test variable is a multi-level dictionary that defines the expected performance for each of the test's performance variables on all supported systems (here, ``generic``) and partitions (here, ``default``).
274+
We explain more about this pre-defined system later in :ref:`systems-and-environments`.
274275
It is not necessary that all performance variables and all systems have a reference.
275276
If a reference value is not found, then the obtained performance will be logged, but no performance validation will be performed.
276277
The reference value is essentially a three or four element tuple of the form: ``(target_perf, lower_thres, upper_thres, unit)``. The ``unit`` is optional as it is already defined in the :func:`@performance_function <reframe.core.builtins.performance_function>` definitions.
@@ -340,7 +341,8 @@ We could do that simply by setting the :attr:`valid_prog_environs` as follows:
340341
341342
self.valid_prog_environs = ['+stream']
342343
343-
This tells ReFrame that this test is valid only for environments that define the ``stream`` feature; the ``+`` prefix requests a feature. The syntax defined in :attr:`valid_prog_environs` allows for other requirements.
344+
This tells ReFrame that this test is valid only for environments that define the ``stream`` feature; (the ``+`` prefix requests a feature, we will explain the syntax later in this section).
345+
The syntax defined in :attr:`valid_prog_environs` allows for other requirements.
344346
If we try to run the test now, nothing will be run:
345347

346348
.. code-block:: bash

0 commit comments

Comments
 (0)