source: orange/docs/widgets/rst/classify/cn2rulesviewer.rst @ 11359:8d54e79aa135

Revision 11359:8d54e79aa135, 1.6 KB checked in by Ales Erjavec <ales.erjavec@…>, 14 months ago (diff)

Cleanup of 'Widget catalog' documentation.

Fixed rst text formating, replaced dead hardcoded reference links (now using
:ref:), etc.

Line 
1.. _CN2 Rules Viewer:
2
3Rule Viewer
4===========
5
6.. image:: ../icons/CN2RulesViewer.png
7
8Widget for visualization of rules.
9
10Signals
11-------
12
13Inputs:
14
15
16   - A set of rules (RuleClassifier)
17
18
19Outputs:
20
21   - Examples (ExampleTable)
22      Attribute-valued data set associated with a rule (or rules) selected
23      by the user.
24
25
26
27Description
28-----------
29
30
31This widget visualizes rules learned by rule learning widgets (e.g. CN2).
32The viewer can, along pre-conditions and prediction of rule, show several
33rule properties like quality, number of covered learning examples, length,
34and the class distribution among the covered examples. These criteria can
35also be used for sorting the list of rules.
36
37
38The widget also allows selecting one or more rules, in which case it outputs
39the examples covered by this (these) rules. The signal is sent immediately if
40:obj:`Commit on change` is checked; otherwise the user needs to push
41:obj:`Commit`. If :obj:`Selected attributes only` is checked, the output
42examples are described only by the attributes appearing in the selected rules.
43
44In the snapshot below, the widget outputs the five examples covered by the
45two selected rules, and although the example table originally contains four
46attributes (petal and sepal width and length - this is the Iris data set),
47the example on the output will only be described by the petal width and length
48as these are the only two attributes appearing in the selected rules and
49:obj:`Selected attributes only` is checked.
50
51
52.. image:: images/RuleViewer.png
53   :alt: Rule Viewer
54
55
56Examples
57--------
58
59For an example of widget's use in canvas see
60:ref:`documentation about CN2 widget <CN2 Rules>`.
Note: See TracBrowser for help on using the repository browser.