Ignore:
Timestamp:
02/27/13 15:02:50 (14 months ago)
Author:
Ales Erjavec <ales.erjavec@…>
Branch:
default
Message:

Cleanup of 'Widget catalog' documentation.

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

File:
1 edited

Legend:

Unmodified
Added
Removed
  • docs/widgets/rst/associate/associationrulesexplorer.rst

    r11050 r11359  
    2525This widget is a tree-like association rules viewer. 
    2626 
    27 The widget can be used to find all the rules that include a particular condition on the left-hand side. The below snapshot is made on the Titanic data set, using the filter as shown on the page on the `Association Rules Filter <AssociationRulesViewer.htm>`_. 
     27The widget can be used to find all the rules that include a particular 
     28condition on the left-hand side. The below snapshot is made on the Titanic 
     29data set, using the filter as shown on the page on the 
     30:ref:`Association Rules Filter`. 
    2831 
    2932.. image:: images/AssociationRulesTreeViewer-closed.png 
    3033   :alt: Association Rules Tree Viewer Widget 
    3134 
    32 Say that we are interested in rules regarding the survival of adults. By opening the branch "age=adult", we discover four rules that contain this condition as the sole condition on the left-hand side, while the right-hand sides contain different combinations of sex, status and survival. 
     35Say that we are interested in rules regarding the survival of adults. By 
     36opening the branch "age=adult", we discover four rules that contain this 
     37condition as the sole condition on the left-hand side, while the right-hand 
     38sides contain different combinations of sex, status and survival. 
    3339 
    3440.. image:: images/AssociationRulesTreeViewer-semi-open.png 
    3541   :alt: Association Rules Tree Viewer Widget 
    3642 
    37 Besides that, there are rules with (at least) two conditions on the left-hand side, "age=adult" and "sex=male"; to explore these rules, we would need to open the corresponding branch. 
     43Besides that, there are rules with (at least) two conditions on the 
     44left-hand side, "age=adult" and "sex=male"; to explore these rules, 
     45we would need to open the corresponding branch. 
    3846 
    39 Each leaf of the tree corresponds to one particular ordering of the left-hand side conditions in a particular rule. Turned around, this means that each rule appears in many places in the tree. As the completely open tree below shows, the rule :code:`age=adult & sex=male -> status=crew` appears in two places (the seventh and the eleventh row). 
     47Each leaf of the tree corresponds to one particular ordering of the 
     48left-hand side conditions in a particular rule. Turned around, this 
     49means that each rule appears in many places in the tree. As the completely 
     50open tree below shows, the rule :code:`age=adult & sex=male -> status=crew` 
     51appears in two places (the seventh and the eleventh row). 
    4052 
    41 On the left-hand side of the widget, we can choose the measures we want to observe. Let L, R and B be the number of examples that fit the left, the right and both sides of the rule, respectively, and N the total number of examples in the data set. The measures are then defined as follows 
     53On the left-hand side of the widget, we can choose the measures we want 
     54to observe. Let L, R and B be the number of examples that fit the left, 
     55the right and both sides of the rule, respectively, and N the total number 
     56of examples in the data set. The measures are then defined as follows 
    4257 
    4358   - confidence = B / L 
     
    5065 
    5166 
    52 :obj:`Tree depth` sets the depth to which the tree is expanded. If, it is set to, for instance, three, then the leaves corresponding to rules with five conditions will, besides the right-hand side, also contain the two conditions which are not shown in the branches. 
     67:obj:`Tree depth` sets the depth to which the tree is expanded. If, it is set 
     68to, for instance, three, then the leaves corresponding to rules with five 
     69conditions will, besides the right-hand side, also contain the two conditions 
     70which are not shown in the branches. 
    5371 
    54 With :obj:`Display whole rules` we can decide whether we want the entire rule (including the information that is already contained in the branches, that is, in the path from the root to the rule) reprinted again in the leaf. 
     72With :obj:`Display whole rules` we can decide whether we want the entire rule 
     73(including the information that is already contained in the branches, that 
     74is, in the path from the root to the rule) reprinted again in the leaf. 
    5575 
    5676Examples 
    5777-------- 
    5878 
    59 This widget is typically used with the `Association Rules <AssociationRules.htm>`_ and possibly `Association Rules Filter <AssociationRulesViewer.htm>`_. A typical schema is shown below. 
     79This widget is typically used with the :ref:`Association Rules` and possibly 
     80:ref:`Association Rules Filter`. A typical schema is shown below. 
    6081 
    6182.. image:: images/AssociationRules-Schema.png 
Note: See TracChangeset for help on using the changeset viewer.