OWNomogram: Add documentation

biolab · Jan 27, 2017 · 133dbbc · 133dbbc
1 parent 042a661
commit 133dbbc
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 0 deletions.
diff --git a/doc/visual-programming/source/index.rst b/doc/visual-programming/source/index.rst
@@ -70,6 +70,7 @@ Visualize
    widgets/visualize/silhouetteplot
    widgets/visualize/treeviewer
    widgets/visualize/geomap
+   widgets/visualize/nomogram
 
 
 Classify

diff --git a/doc/visual-programming/source/widgets/visualize/icons/nomogram.png b/doc/visual-programming/source/widgets/visualize/icons/nomogram.png
diff --git a/doc/visual-programming/source/widgets/visualize/nomogram.rst b/doc/visual-programming/source/widgets/visualize/nomogram.rst
@@ -0,0 +1,27 @@
+Nomogram
+========
+
+.. figure:: icons/nomogram.png
+
+Nomograms for visualization of Naive Bayes and Logistic Regression classifiers.
+
+Signals
+-------
+
+**Inputs**:
+
+-  **Classifier**
+
+   A trained classifier (Naive Bayes or Logistic regression).
+
+-  **Data**
+
+   Data instance.
+
+Description
+-----------
+
+**Nomogram** widget models the probability of the selected class. It also reveals the structure
+of the model and the relative influences of the feature values to the class probabilities.
+The probability fot the chosen class is computed by 1. vs. all principle, which should be taken
+in consideration when dealing with multiclass data (alternating probabilities do not sum to 1).