Changeset 7316:c10e21b12d03 in orange


Ignore:
Timestamp:
02/03/11 12:38:10 (3 years ago)
Author:
miha <miha.stajdohar@…>
Branch:
default
Convert:
fcfb0671c51ebe18816fbf0d278ba99c39ebd7a4
Message:

doc bug fix

File:
1 edited

Legend:

Unmodified
Added
Removed
  • orange/Orange/classification/svm/__init__.py

    r7314 r7316  
    3434.. automethod:: Orange.classification.svm.getLinearSVMWeights 
    3535 
    36 .. automethod:: Orange.classification.svm.exampleTableToSVMFormat 
     36.. automethod:: Orange.classification.svm.tableToSVMFormat 
    3737 
    3838SVM derived feature weights 
     
    172172    :param kernelFunc: function that will be called if `kernel_type` is 
    173173        `Custom`. It must accept two :obj:`Orange.data.Instance` arguments and 
    174         return a float (the distance between the examples). 
     174        return a float (the distance between the instances). 
    175175    :type kernelFunc: callable function 
    176176    :param C: C parameter for C_SVC, Epsilon_SVR, Nu_SVR 
     
    286286    def tuneParameters(self, examples, parameters=None, folds=5, verbose=0,  
    287287                       progressCallback=None): 
    288         """Tune the parameters of the SVMLearner on given examples using  
     288        """Tune the parameters of the SVMLearner on given instances using  
    289289        cross validation. 
    290290         
    291         :param examples: :obj:`Orange.data.Table` on which to tune the parameters  
     291        :param examples: data table on which to tune the parameters 
     292        :type examples: Orange.data.Table  
    292293        :param parameters: if not set defaults to ["nu", "C", "gamma"] 
     294        :type parameters: list of strings 
    293295        :param folds: number of folds used for cross validation 
     296        :type folds: int 
    294297        :param verbose: default False 
    295         :param progressCallback: a callback function to report progress 
     298        :type verbose: bool 
     299        :param progressCallback: report progress 
     300        :type progressCallback: callback function 
    296301             
    297302        Example:: 
     
    368373class SVMLearnerSparse(SVMLearner): 
    369374     
    370     """Same as SVMLearner except that it learns from the examples meta 
    371     attributes. 
     375    """Same as SVMLearner except that it learns from the  
     376        :obj:`Orange.data.Table` meta attributes. 
    372377     
    373378    .. note:: Note that meta attributes don't need to be registered with 
     
    383388class SVMLearnerEasy(SVMLearner): 
    384389     
    385     """Same as `SVMLearner` except that it will automatically scale the data 
    386     and perform parameter optimization using the `tuneParameters` method 
     390    """Same as :obj:`SVMLearner` except that it will automatically scale the data 
     391    and perform parameter optimization using the :obj:`tuneParameters` method 
    387392    similar to the easy.py script in LibSVM package. Use this if the 
    388393    SVMLearner performs badly.  
     
    635640         
    636641        :param data: Data 
    637         :type data: Orange.core.ExampleTable 
     642        :type data: Orange.data.Table 
    638643        :param numSelected: number of features to preserve 
    639644        :type numSelected: int 
     
    651656 
    652657def exampleTableToSVMFormat(examples, file): 
    653     """Save an example table in svm format as used by LibSVM""" 
     658    tableToSVMFormat(examples, file) 
     659 
     660def tableToSVMFormat(examples, file): 
     661    """Save :obj:`Orange.data.Table` to a format used by LibSVM.""" 
    654662    attrs = examples.domain.attributes + examples.domain.getmetas().values() 
    655663    attrs = [attr for attr in attrs if attr.varType  
Note: See TracChangeset for help on using the changeset viewer.