You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/tutorial.rst
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -262,15 +262,16 @@ Here is an example for our STREAM benchmark:
262
262
263
263
@rfm.simple_test
264
264
classstream_test(rfm.RunOnlyRegressionTest):
265
-
#...
265
+
...
266
266
reference = {
267
267
'generic:default': {
268
268
'copy_bw': (23_890, -0.10, 0.30, 'MB/s'),
269
269
'triad_bw': (17_064, -0.05, 0.50, 'MB/s'),
270
270
}
271
271
}
272
272
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`.
274
275
It is not necessary that all performance variables and all systems have a reference.
275
276
If a reference value is not found, then the obtained performance will be logged, but no performance validation will be performed.
276
277
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:
340
341
341
342
self.valid_prog_environs = ['+stream']
342
343
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.
344
346
If we try to run the test now, nothing will be run:
0 commit comments