source: orange/docs/widgets/rst/classify/cn2rulesviewer.rst @ 11050:e3c4699ca155

Revision 11050:e3c4699ca155, 1.6 KB checked in by Miha Stajdohar <miha.stajdohar@…>, 16 months ago (diff)

Widget docs From HTML to Sphinx.

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 by the user.
23
24
25
26Description
27-----------
28
29
30This widget visualizes rules learned by rule learning widgets (e.g. CN2). The viewer can, along pre-conditions and prediction of rule, show several rule properties like quality, number of covered learning examples, length, and the class distribution among the covered examples. These criteria can also be used for sorting the list of rules.
31
32
33The widget also allows selecting one or more rules, in which case it outputs the examples covered by this (these) rules. The signal is sent immediately if :obj:`Commit on change` is checked; otherwise the user needs to push :obj:`Commit`. If :obj:`Selected attributes only` is checked, the output examples are described only by the attributes appearing in the selected rules.
34
35In the snapshot below, the widget outputs the five examples covered by the two selected rules, and although the example table originally contains four attributes (petal and sepal width and length - this is the Iris data set), the example on the output will only be described by the petal width and length as these are the only two attributes appearing in the selected rules and :obj:`Selected attributes only` is checked.
36
37
38.. image:: images/RuleViewer.png
39   :alt: Rule Viewer
40
41
42Examples
43--------
44
45For an example of widget's use in canvas see `documentation about CN2 widget <cn2.htm>`_.
Note: See TracBrowser for help on using the repository browser.