summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/analysis-visual.md3
-rw-r--r--doc/model-visual.md5
-rw-r--r--doc/modeling-method.md2
3 files changed, 10 insertions, 0 deletions
diff --git a/doc/analysis-visual.md b/doc/analysis-visual.md
index dad5bb6..b069bd0 100644
--- a/doc/analysis-visual.md
+++ b/doc/analysis-visual.md
@@ -22,4 +22,7 @@ parameter name. It shows each distinct configuration (parameter/NFP value) in
a different colour. Combining it with `--filter-param` and `--ignore-param`
may help de-clutter the plot.
+dfatool will additionally plot the predicted performance for each distinct
+configuration as a solid line.
+
![](/media/n_dpus-dpu_alloc-1.png)
diff --git a/doc/model-visual.md b/doc/model-visual.md
index 7830421..564cf3e 100644
--- a/doc/model-visual.md
+++ b/doc/model-visual.md
@@ -16,3 +16,8 @@ accessible via `dot -Tpng filename.dot | feh -`.
In case of regression forests (XGBoost), dfatool exports the individual trees to
`PREFIX(name)-(attribute).(index).dot`.
+
+## Plotting Model Predictions for Individual Configurations
+
+`--plot-param name:attribute:label` displays both raw readings (as points, see
+[[analysis-visual.md]]) and the corresponding performance model (as lines).
diff --git a/doc/modeling-method.md b/doc/modeling-method.md
index d29ab3a..f369cc0 100644
--- a/doc/modeling-method.md
+++ b/doc/modeling-method.md
@@ -39,6 +39,8 @@ All of these are valid regression model trees.
* `--force-tree` builds a tree structure even if dfatool's heuristic indicates that no non-integer parameter affects the modeled performance attribute.
* `DFATOOL_DTREE_IGNORE_IRRELEVANT_PARAMS=0` disables the relevant parameter detection heuristic when building the tree structure. By default, irrelevant parameters cannot end up as decision nodes.
* `DFATOOL_FIT_LINEAR_ONLY=1` makes RMT behave more like LMT by only considering linear functions in leaf nodes.
+* `DFATOOL_FIT_FOL=1`
+* `DFATOOL_PARAM_CATEGORIAL_TO_SCALAR=1`
* `DFATOOL_SKIP_CODEPENDENT_CHECK=1`
* `DFATOOL_REGRESSION_SAFE_FUNCTIONS=1`