Skip to content

[doc] Add a warning in documentation about the usage of perf_patterns #2587

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 6, 2022
Merged

[doc] Add a warning in documentation about the usage of perf_patterns #2587

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
13abab8
Add a warning in documentation about `perf_patterns`
vkarak Sep 3, 2022
95d8a22
Merge branch 'master' into doc/warn-against-perf-patterns
Sep 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions reframe/core/pipeline.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -702,16 +702,21 @@ def pipeline_hooks(cls):

#: Patterns for verifying the performance of this test.
#:
#: Refer to the :doc:`ReFrame Tutorials </tutorials>` for concrete usage
#: examples.
#:
#: If set to :class:`None`, no performance checking will be performed.
#:
#: :type: A dictionary with keys of type :class:`str` and deferrable
#: expressions (i.e., the result of a :doc:`sanity function
#: </deferrable_functions_reference>`) as values.
#: :class:`None` is also allowed.
#: :default: :class:`None`
#:
#: .. warning::
#:
#: You are advised to follow the new syntax for defining performance
#: variables in your tests using either the :func:`@performance_function
#: <reframe.core.builtins.performance_function>` builtin or the
#: :attr:`perf_variables`, as :attr:`perf_patterns` will likely be
#: deprecated in the future.
perf_patterns = variable(typ.Dict[str, _DeferredExpression], type(None))

#: The performance variables associated with the test.
Expand All @@ -725,7 +730,7 @@ def pipeline_hooks(cls):
#: By default, ReFrame will populate this field during the test's
#: instantiation with all the member functions decorated with the
#: :func:`@performance_function
#: <reframe.core.pipeline.RegressionMixin.performance_function>` decorator.
#: <reframe.core.builtins.performance_function>` decorator.
#: If no performance functions are present in the class, no performance
#: checking or reporting will be carried out.
#:
Expand All @@ -743,7 +748,7 @@ def pipeline_hooks(cls):
#: :ref:`deferrable-performance-functions`).
#: :default: Collection of performance variables associated to each of
#: the member functions decorated with the :func:`@performance_function
#: <reframe.core.pipeline.RegressionMixin.performance_function>`
#: <reframe.core.builtins.performance_function>`
#: decorator.
#:
#: .. versionadded:: 3.8.0
Expand Down