diff options
| author |   Vratko Polak <vrpolak@cisco.com> | 2022-10-17 15:08:16 +0200 |
|---|---|---|
| committer |   Tibor Frank <tifrank@cisco.com> | 2022-10-18 08:13:26 +0000 |
| commit | 6809aeefd0f2b951cd4861f676ee2dff0df47ff2 (patch) | |
| tree | c0edacd0afcb31262f99701e67f0a600a4e07da1 /docs/report/introduction/methodology_trending | |
| parent | 4b246a2bf50fd42ec3343dc317e7828d8b0d82da (diff) | |
fix(report): unify .rst section marks
Unify characters marking section levels,
(at least for methodology Vratko contributed to):
Level 0: ==== Do not use, or use for index.rst only.
(Because git conflicts also create ====.)
Level 1: ^^^^
Level 2: ~~~~
Level 3: ````
Level 4: ____
Level 5: ---- Do not use.
(Because other documents use this as level 0,
and it also appears in tables.)
Change-Id: I10813f718b2ee34d1e34c58e62e88353000340e9
Signed-off-by: Vratko Polak <vrpolak@cisco.com>
Diffstat (limited to 'docs/report/introduction/methodology_trending')
3 files changed, 9 insertions, 9 deletions
diff --git a/docs/report/introduction/methodology_trending/index.rst b/docs/report/introduction/methodology_trending/index.rst index 9105ec46b4..957900226b 100644 --- a/docs/report/introduction/methodology_trending/index.rst +++ b/docs/report/introduction/methodology_trending/index.rst @@ -1,5 +1,5 @@ Trending Methodology -==================== +-------------------- .. toctree:: diff --git a/docs/report/introduction/methodology_trending/trend_analysis.rst b/docs/report/introduction/methodology_trending/trend_analysis.rst index 2bb54997b0..20ad46405a 100644 --- a/docs/report/introduction/methodology_trending/trend_analysis.rst +++ b/docs/report/introduction/methodology_trending/trend_analysis.rst @@ -22,7 +22,7 @@ Implementation details ~~~~~~~~~~~~~~~~~~~~~~ Partitioning into groups ------------------------- +```````````````````````` While sometimes the samples within a group are far from being distributed normally, currently we do not have a better tractable model. @@ -39,7 +39,7 @@ results). The group boundaries are selected based on `Minimum Description Length`_. Minimum Description Length --------------------------- +`````````````````````````` `Minimum Description Length`_ (MDL) is a particular formalization of `Occam's razor`_ principle. @@ -103,7 +103,7 @@ We are going to describe the behaviors, as they motivate our choice of trend compliance metrics. Sample time and analysis time ------------------------------ +````````````````````````````` But first we need to distinguish two roles time plays in analysis, so it is more clear which role we are referring to. @@ -132,7 +132,7 @@ so the values reported there are likely to be different from the later analysis time results shown in dashboard and graphs. Ordinary regression -------------------- +``````````````````` The real performance changes from previously stable value into a new stable value. @@ -143,7 +143,7 @@ is enough for anomaly detection to mark this regression. Ordinary progressions are detected in the same way. Small regression ----------------- +```````````````` The real performance changes from previously stable value into a new stable value, but the difference is small. @@ -162,7 +162,7 @@ is still not enough for the detection). Small progressions have the same behavior. Reverted regression -------------------- +``````````````````` This pattern can have two different causes. We would like to distinguish them, but that is usually @@ -196,7 +196,7 @@ to increase performance, the opposite (temporary progression) almost never happens. Summary -------- +``````` There is a trade-off between detecting small regressions and not reporting the same old regressions for a long time. diff --git a/docs/report/introduction/methodology_trending/trend_presentation.rst b/docs/report/introduction/methodology_trending/trend_presentation.rst index 67d0d3c45a..7272ac6e38 100644 --- a/docs/report/introduction/methodology_trending/trend_presentation.rst +++ b/docs/report/introduction/methodology_trending/trend_presentation.rst @@ -8,7 +8,7 @@ The Failed tests tables list the tests which failed during the last test run. Separate tables are generated for each testbed. Regressions and progressions -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ These tables list tests which encountered a regression or progression during the specified time period, which is currently set to the last 21 days. |