Changeset 8128:eea8d943506b in orange


Ignore:
Timestamp:
07/29/11 15:09:26 (3 years ago)
Author:
ales_erjavec <ales.erjavec@…>
Branch:
default
Convert:
430a317a04c71935b807f6a464588187101d83fb
Message:

Added basic documentation for Orange.regression.earth module.

Location:
orange
Files:
1 added
2 edited

Legend:

Unmodified
Added
Removed
  • orange/Orange/regression/earth.py

    r8127 r8128  
    44==================================================== 
    55 
     6.. index:: regression, linear model 
     7 
    68`Multivariate adaptive regression splines (MARS)`_ is a non-parametric 
    79regression method that extends a linear model with non-linear 
     
    1416.. _`Earth R package`: http://cran.r-project.org/web/packages/earth/index.html 
    1517 
     18Example :: 
     19 
     20    >>> from Orange.regression import earth 
     21    >>> data = Orange.data.Table("housing") 
     22    >>> c = earth.EarthLearner(data, degree=2, terms=5) 
     23    >>> c.print_model() 
     24    MEDV = 
     25       23.710 
     26       +9.379 * max(0, RM - 6.431) 
     27       +1.714 * max(0, 6.431 - RM) 
     28       -0.656 * max(0, LSTAT - 6.120) 
     29       +2.748 * max(0, 6.120 - LSTAT) 
     30        
     31    >>>  
     32 
     33 
    1634.. autoclass:: EarthLearner 
     35    :members: 
    1736 
    1837.. autoclass:: EarthClassifier 
    19  
    20 .. autoclass:: EarthLearnerML 
    21  
    22 .. autoclass:: EarthClassifierML 
     38    :members: 
     39 
     40Utility functions 
     41----------------- 
     42 
     43.. autofunction:: gcv 
     44 
     45.. autofunction:: plot_evimp 
    2346 
    2447""" 
     
    4568                 pruned_terms=None, scale_resp=False, store_examples=True, 
    4669                 multi_label=False, **kwds): 
    47         """  
     70        """ Initialize the learner instance. 
     71         
     72        :param degree: Maximum degree (num. of hinge functions per term) 
     73            of the terms in the model. 
     74        :type degree: int 
     75        :param terms: Maximum number of terms in the forward pass. 
     76        :type terms: int 
     77        :param penalty: Penalty for hinges in the GCV computation (used  
     78            in the pruning pass). By default it is 3.0 if the degree > 1, 
     79            2.0 otherwise.  
     80        :type penalty: float 
     81        :param thresh: Threshold for RSS decrease in the forward pass 
     82            (default 0.001). 
     83        :type thresh: float 
     84        :param min_span: TODO. 
     85        :param new_var_penalty: Penalty for introducing a new variable 
     86            in the model during the forward pass (default 0). 
     87        :type new_var_penalty: float 
     88        :param fast_k: Fast k. 
     89        :param fast_beta: Fast beta. 
     90        :param pruned_terms: Maximum number if terms in the model after 
     91            pruning (default None - no limit). 
     92        :type pruned_terms: int 
     93        :param scale_resp: Scale responses prior to forward pass. 
     94        :type scale_resp: bool 
     95        :param store_examples: Store training examples in the model (default True). 
     96        :type store_examples: bool 
     97        :param multi_label: If True build a multi label model (default False). 
     98        :type multi_label: bool   
     99          
    48100        .. todo:: min_span, prunning_method 
     101         
    49102        """ 
    50103        self.degree = degree 
     
    178231        :param example: example instance 
    179232        :type example: :class:`Orange.data.Example` 
     233         
    180234        """ 
    181235        data = Orange.data.Table(self.domain, [example]) 
     
    282336    """ Return the generalized cross validation. 
    283337     
    284     .. math: gcv = rss / (n * (1 - n_effective_params / n) ^ 2) 
     338    .. math:: gcv = rss / (n * (1 - NumEffectiveParams / n) ^ 2) 
    285339     
    286340    :param rss: Residual sum of squares. 
  • orange/doc/Orange/rst/Orange.regression.rst

    r7922 r8128  
    88   Orange.regression.mean 
    99   Orange.regression.tree 
     10   Orange.regression.earth 
    1011 
Note: See TracChangeset for help on using the changeset viewer.