summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBirte Kristina Friesel <birte.friesel@uos.de>2024-01-10 13:47:54 +0100
committerBirte Kristina Friesel <birte.friesel@uos.de>2024-01-10 13:47:54 +0100
commit34e1e445a1c5be892b436632245659f93a36f271 (patch)
treeaa8cbe8fe4b23363c94e3ef65eb33e55abbf1551 /doc
parente77adfcc3cc0a173108aa182ed7f71a5be7e5408 (diff)
dot export: add xgboost support and documentation
Diffstat (limited to 'doc')
-rw-r--r--doc/model-visual.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/model-visual.md b/doc/model-visual.md
index 4f629d1..7830421 100644
--- a/doc/model-visual.md
+++ b/doc/model-visual.md
@@ -5,3 +5,14 @@
In low- to medium-complexity applications, the simplest way of examining the
performance models generated by dfatool is textual output: `--show-model=param`.
This is implemented for most modeling methods.
+
+## Graphical Output via dot(1)
+
+`--export-dot PREFIX` exports the generated performance models for each pair of
+name (state/transition/…) and performance attribute to
+`PREFIX(name)-(attribute).dot`. The dot(1) program is capable of transforming
+those into images. For instance, if feh(1) is available, a visual model is
+accessible via `dot -Tpng filename.dot | feh -`.
+
+In case of regression forests (XGBoost), dfatool exports the individual trees to
+`PREFIX(name)-(attribute).(index).dot`.