Changeset 7556:9396fd31c7d4 in orange


Ignore:
Timestamp:
02/04/11 22:38:55 (3 years ago)
Author:
lanz <lan.zagar@…>
Branch:
default
Convert:
5f9ce2228c87e93635c63d5f84182aafad9c3b4c
Message:

Documentation updated to avoid rst warnings.

Location:
orange
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • orange/Orange/associate/__init__.py

    r7553 r7556  
    192192 
    193193    .. attribute:: left, right 
    194     The left and the right side of the rule. Both are given as Example. In rules created by AssociationRulesSparseInducer from examples that contain all values as meta-values, left and right are examples in the same form. Otherwise, values in left that do not appear in the rule are "don't care", and value in right are "don't know". Both can, however, be tested by isSpecial (see documentation on  `Value <http://orange.biolab.si/doc/reference/Value.htm>`_). 
     194     
     195        The left and the right side of the rule. Both are given as Example. In rules created by AssociationRulesSparseInducer from examples that contain all values as meta-values, left and right are examples in the same form. Otherwise, values in left that do not appear in the rule are "don't care", and value in right are "don't know". Both can, however, be tested by isSpecial (see documentation on  `Value <http://orange.biolab.si/doc/reference/Value.htm>`_). 
    195196     
    196197    .. attribute:: nLeft, nRight 
    197198     
    198     The number of features (ie defined values) on the left and on the right side of the rule. 
     199        The number of features (ie defined values) on the left and on the right side of the rule. 
    199200     
    200201    .. attribute:: nAppliesLeft, nAppliesRight, nAppliesBoth 
    201202     
    202     The number of (learning) examples that conform to the left, the right and to both sides of the rule. 
     203        The number of (learning) examples that conform to the left, the right and to both sides of the rule. 
    203204     
    204205    .. attribute:: nExamples 
    205206     
    206     The total number of learning examples. 
     207        The total number of learning examples. 
    207208     
    208209    .. attribute:: support 
    209210     
    210     nAppliesBoth/nExamples. 
     211        nAppliesBoth/nExamples. 
    211212 
    212213    .. attribute:: confidence 
    213214     
    214     nAppliesBoth/nAppliesLeft. 
     215        nAppliesBoth/nAppliesLeft. 
    215216     
    216217    .. attribute:: coverage 
    217218     
    218     nAppliesLeft/nExamples. 
     219        nAppliesLeft/nExamples. 
    219220 
    220221    .. attribute:: strength 
    221222     
    222     nAppliesRight/nAppliesLeft. 
     223        nAppliesRight/nAppliesLeft. 
    223224     
    224225    .. attribute:: lift 
    225226     
    226     nExamples * nAppliesBoth / (nAppliesLeft * nAppliesRight). 
     227        nExamples * nAppliesBoth / (nAppliesLeft * nAppliesRight). 
    227228     
    228229    .. attribute:: leverage 
    229230     
    230     (nAppliesBoth * nExamples - nAppliesLeft * nAppliesRight). 
     231        (nAppliesBoth * nExamples - nAppliesLeft * nAppliesRight). 
    231232     
    232233    .. attribute:: examples, matchLeft, matchBoth 
    233234     
    234     If storeExamples was True during induction, examples contains a copy of the example table used to induce the rules. Attributes matchLeft and matchBoth are lists of integers, representing the indices of examples which match the left-hand side of the rule and both sides, respectively. 
     235        If storeExamples was True during induction, examples contains a copy of the example table used to induce the rules. Attributes matchLeft and matchBoth are lists of integers, representing the indices of examples which match the left-hand side of the rule and both sides, respectively. 
    235236 
    236237    .. method:: AssociationRule(left, right, nAppliesLeft, nAppliesRight, nAppliesBoth, nExamples) 
    237238     
    238     Constructs an association rule and computes all measures listed above. 
     239        Constructs an association rule and computes all measures listed above. 
    239240     
    240241    .. method:: AssociationRule(left, right, support, confidence) 
    241242     
    242     Construct association rule and sets its support and confidence. If you intend to pass on such a rule you should set other attributes manually - AssociationRules's constructor cannot compute anything from arguments support and confidence. 
     243        Construct association rule and sets its support and confidence. If you intend to pass on such a rule you should set other attributes manually - AssociationRules's constructor cannot compute anything from arguments support and confidence. 
    243244     
    244245    .. method:: AssociationRule(rule) 
    245246     
    246     Given an association rule as the argument, constructor copies of the rule. 
     247        Given an association rule as the argument, constructor copies of the rule. 
    247248     
    248249    .. method:: appliesLeft(example) 
     
    252253    .. method:: appliesBoth(example) 
    253254     
    254     Tells whether the example fits into the left, right or both sides of the rule, respectively. If the rule is represented by sparse examples, the given example must be sparse as well. 
     255        Tells whether the example fits into the left, right or both sides of the rule, respectively. If the rule is represented by sparse examples, the given example must be sparse as well. 
    255256     
    256257Association rule inducers do not store evidence about which example supports which rule (although this information is available during induction its discarded afterwards). Let us write a function that finds the examples that confirm the rule (fit both sides of it) and those that contradict it (fit the left-hand side but not the right). The example uses the `lenses.tab`_: :: 
  • orange/doc/Orange/rst/Orange.associate.rst

    r7250 r7556  
    1 ============== 
     1================ 
    22Orange.associate 
    3 ============== 
     3================ 
    44 
    55.. automodule:: Orange.associate 
Note: See TracChangeset for help on using the changeset viewer.