Changes between Version 1 and Version 2 of Orange25/DevelopmentGuidelines


Ignore:
Timestamp:
11/24/11 11:22:41 (3 years ago)
Author:
marko
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Orange25/DevelopmentGuidelines

    v1 v2  
    1 == Models to string == 
     1== Output of models == 
    22 
    33Output of learning models. Learning models (classifiers, regressors) need to have __str__ defined. For example 
     
    88print c.format(max_depth=1) #with some special formatting 
    99}}} 
     10 
     11== Model plotting == 
     12 
     13Add plot methods to classifiers. The most typical one should be plot(), but if there are multiple different plots, prefix them with plot_, for example plot_dendrogram. 
     14 
     15TODO: what should be default output? 
     16 
     17== Data set naming == 
     18 
     19In documentation, do not use '''table'''. Name of the data set is preferred (but just '''data''' is also acceptable), so write: 
     20{{{ 
     21iris = Orange.data.Table("iris") 
     22}}}  
     23 
     24In code, use '''data'''. 
     25 
     26== Documentation imports == 
     27 
     28Import just '''Orange''' and use full paths. Avoid exceptions. Never import *.