Changeset 11050:e3c4699ca155 in orange


Ignore:
Timestamp:
01/04/13 12:23:40 (16 months ago)
Author:
Miha Stajdohar <miha.stajdohar@…>
Branch:
default
Children:
11055:afd9213ae1dc, 11057:3da1cf37de17
Message:

Widget docs From HTML to Sphinx.

Location:
docs
Files:
448 added
7 edited

Legend:

Unmodified
Added
Removed
  • docs/extend-widgets/rst/basics.rst

    r11049 r11050  
    9191now the following is important: 
    9292 
    93 * Widgets are defined in a Python files. 
    94 * For Orange and Orange canvas to find them, they reside in 
    95 subdirectories in OrangeWidgets directory of Orange installation. The 
    96 name of the subdirectory matters, as this is the name of the widget 
    97 category. Widgets in the same directory will be grouped in the same 
    98 pane of widget toolbox in Orange Canvas. 
    99 *A file describing a widget starts with a header. This, given in 
    100 sort of XMLish style, tells about the name, short description, 
    101 location of an icon and priority of the widget. 
    102 *The sole role of 
    103 priority is to specify the placement (order) of widgets in the Orange 
    104 Canvas toolbox. 
    105 *Somewhere in the code (where we will learn later) there are two 
    106 lines which tell which channels the widgets uses for 
    107 communication. These, together with the header information, completely 
    108 specify the widget as it is seen from the outside. 
     93   -  Widgets are defined in a Python files. 
     94   - For Orange and Orange canvas to find them, they reside in subdirectories in OrangeWidgets directory of Orange installation. The name of the subdirectory matters, as this is the name of the widget category. Widgets in the same directory will be grouped in the same pane of widget toolbox in Orange Canvas. 
     95   - A file describing a widget starts with a header. This, given in sort of XMLish style, tells about the name, short description, location of an icon and priority of the widget. 
     96   - The sole role of priority is to specify the placement (order) of widgets in the Orange Canvas toolbox. 
     97   - Somewhere in the code (where we will learn later) there are two lines which tell which channels the widgets uses for communication. These, together with the header information, completely specify the widget as it is seen from the outside. 
    10998 
    11099Oh, by the way. Orange caches widget descriptions to achieve a faster 
  • docs/extend-widgets/rst/channels.rst

    r11049 r11050  
    2626Say we want to build a widget that takes a data set and test 
    2727various predictive modelling techniques on it. A widget has to have an 
    28 input data channel, and this we know how to deal with from our :doc:`previous` 
     28input data channel, and this we know how to deal with from our :doc:`previous <settings>` 
    2929lesson. But, somehow differently, we 
    3030want to connect any number of widgets which define learners to our 
  • docs/widgets/rst/data/file.rst

    r11028 r11050  
    44==== 
    55 
    6 .. image:: images/File_icon.png 
     6.. image:: ../../../../Orange/OrangeWidgets/Data/icons/File_48.png 
    77   :alt: File widget icon 
    88    
     
    6060Any of your schemas should probably start with the :ref:`File` widget. In the schema below, 
    6161the widget is used to read the data that is then sent to both :ref:`Data Table` widget and  
    62 to widget that displays `Attribute Statistics`_. 
     62to widget that displays :ref:`Attribute Statistics`. 
    6363 
    6464.. image:: images/File_schema.png 
  • docs/widgets/rst/index.rst

    r11046 r11050  
    1717      - |DataTable_icon| :ref:`Data Table` 
    1818      - |SelectAttributes_icon| :ref:`Select Attributes` 
    19     * - |Rank_icon| `Rank`_ 
    20       - |PurgeDomain_icon| `Purge Domain`_ 
    21       - |MergeData_icon| `Merge Data`_ 
    22     * - |Concat_icon| `Concatenate`_ 
    23       - |DataSampler_icon| `Data Sampler`_ 
    24       - |SelectData_icon| `Select Data`_ 
    25     * - |Save_icon| `Save`_ 
    26       - |Discretize_icon| `Discretize`_ 
    27       - |Cont_icon| `Continuize`_ 
    28     * - |Impute_icon| `Impute`_ 
    29       - |Outliers_icon| `Outliers`_ 
     19    * - |Rank_icon| :ref:`Rank` 
     20      - |PurgeDomain_icon| :ref:`Purge Domain` 
     21      - |MergeData_icon| :ref:`Merge Data` 
     22    * - |Concat_icon| :ref:`Concatenate` 
     23      - |DataSampler_icon| :ref:`Data Sampler` 
     24      - |SelectData_icon| :ref:`Select Data` 
     25    * - |Save_icon| :ref:`Save` 
     26      - |Discretize_icon| :ref:`Discretize` 
     27      - |Cont_icon| :ref:`Continuize` 
     28    * - |Impute_icon| :ref:`Impute` 
     29      - |Outliers_icon| :ref:`Outliers` 
    3030      - 
    3131 
    32 .. _`Rank`: ../../_static/Data/Rank.htm 
    33  
    34 .. _`Purge Domain`: ../../_static/Data/PurgeDomain.htm 
    35  
    36 .. _`Merge Data`: ../../_static/Data/MergeData.htm 
    37  
    38 .. _`Concatenate`: ../../_static/Data/Concatenate.htm 
    39  
    40 .. _`Data Sampler`: ../../_static/Data/DataSampler.htm 
    41  
    42 .. _`Select Data`: ../../_static/Data/SelectData.htm 
    43  
    44 .. _`Save`: ../../_static/Data/Save.htm 
    45  
    46 .. _`Discretize`: ../../_static/Data/Discretize.htm 
    47  
    48 .. _`Continuize`: ../../_static/Data/Continuize.htm 
    49  
    50 .. _`Impute`: ../../_static/Data/Impute.htm 
    51  
    52 .. _`Outliers`: ../../_static/Data/Outliers.htm 
    53  
    54  
    55 .. |File_icon| image:: data/images/File_icon.png 
     32.. |File_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/File_48.png 
    5633    :align: middle 
    5734    :alt: File 
     
    5936    :height: 48 
    6037 
    61 .. |DataTable_icon| image:: data/images/DataTable_icon.png 
     38.. |DataTable_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/DataTable_48.png 
    6239    :align: middle 
    6340    :alt: Data Table 
     
    6542    :height: 48 
    6643     
    67 .. |SelectAttributes_icon| image:: data/images/SelectAttributes_icon.png 
     44.. |SelectAttributes_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/SelectAttributes_48.png 
    6845    :align: middle 
    6946    :alt: Select Attributes 
     
    145122    :widths: 1 1 1 
    146123     
    147     * - |Distributions_icon| `Distributions`_ 
    148       - |ScatterPlot_icon| `Scatter Plot`_ 
    149       - |AttributeStatistics_icon| `Attribute Statistics`_ 
    150     * - |LinearProjection_icon| `Linear Projection`_ 
    151       - |Radviz_icon| `Radviz`_ 
    152       - |Polyviz_icon| `Polyviz`_ 
    153     * - |ParallelCoords_icon| `Parallel Coordinates`_ 
    154       - |SurveyPlot_icon| `Survey Plot`_ 
    155       - |MosaicDisplay_icon| `Mosaic Display`_ 
    156     * - |SieveDiagram_icon| `Sieve Diagram`_ 
     124    * - |Distributions_icon| :ref:`Distributions` 
     125      - |ScatterPlot_icon| :ref:`Scatter Plot` 
     126      - |AttributeStatistics_icon| :ref:`Attribute Statistics` 
     127    * - |LinearProjection_icon| :ref:`Linear Projection` 
     128      - |Radviz_icon| :ref:`Radviz` 
     129      - |Polyviz_icon| :ref:`Polyviz` 
     130    * - |ParallelCoords_icon| :ref:`Parallel Coordinates` 
     131      - |SurveyPlot_icon| :ref:`Survey Plot` 
     132      - |MosaicDisplay_icon| :ref:`Mosaic Display` 
     133    * - |SieveDiagram_icon| :ref:`Sieve Diagram` 
    157134      - |SieveMultigram_icon| Sieve Multigram  
    158135      - 
    159      
    160 .. _`Distributions`: ../../_static/Visualize/Distributions.htm 
    161  
    162 .. _`Scatter Plot`: ../../_static/Visualize/Scatterplot.htm 
    163  
    164 .. _`Attribute Statistics`: ../../_static/Visualize/AttributeStatistics.htm 
    165  
    166 .. _`Linear Projection`: ../../_static/Visualize/LinearProjection.htm 
    167  
    168 .. _`Radviz`: ../../_static/Visualize/Radviz.htm 
    169  
    170 .. _`Polyviz`: ../../_static/Visualize/Polyviz.htm 
    171  
    172 .. _`Parallel Coordinates`: ../../_static/Visualize/ParallelCoordinates.htm 
    173  
    174 .. _`Survey Plot`: ../../_static/Visualize/SurveyPlot.htm 
    175  
    176 .. _`Mosaic Display`: ../../_static/Visualize/MosaicDisplay.htm 
    177  
    178 .. _`Sieve Diagram`: ../../_static/Visualize/SieveDiagram.htm 
    179  
    180136 
    181137.. |Distributions_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/Distribution_48.png 
     
    253209    :widths: 1 1 1 
    254210     
    255     * - |NaiveBayes_icon| `Naive Bayes`_ 
    256       - |SVM_icon| `SVM`_ 
    257       - |LogReg_icon| `Logistic Regression`_ 
    258     * - |Majority_icon| `Majority`_ 
    259       - |ClassificationTree_icon| `Classification Tree`_ 
    260       - |ClassificationTreeGraph_icon| `Classification Tree Graph`_  
    261     * - |ClsTreeViewer_icon| `Classification Tree Viewer`_ 
    262       - |CN2Rules_icon| `CN2 Rules`_ 
    263       - |CN2RulesViewer_icon| `CN2 Rules Viewer`_ 
    264     * - |kNN_icon| `k-Nearest Neighbours`_ 
    265       - |Nomogram_icon| `Nomogram`_ 
    266       - |RandomForest_icon| `Random Forest`_ 
    267     * - |C4.5_icon| `C4.5`_ 
    268       - |ITreeBuilder_icon| `Interactive Tree Builder`_ 
     211    * - |NaiveBayes_icon| :ref:`Naive Bayes` 
     212      - |SVM_icon| :ref:`SVM` 
     213      - |LogReg_icon| :ref:`Logistic Regression` 
     214    * - |Majority_icon| :ref:`Majority` 
     215      - |ClassificationTree_icon| :ref:`Classification Tree` 
     216      - |ClassificationTreeGraph_icon| :ref:`Classification Tree Graph` 
     217    * - |ClsTreeViewer_icon| :ref:`Classification Tree Viewer` 
     218      - |CN2Rules_icon| :ref:`CN2 Rules` 
     219      - |CN2RulesViewer_icon| :ref:`CN2 Rules Viewer` 
     220    * - |kNN_icon| :ref:`k-Nearest Neighbours` 
     221      - |Nomogram_icon| :ref:`Nomogram` 
     222      - |RandomForest_icon| :ref:`Random Forest` 
     223    * - |C4.5_icon| :ref:`C4.5` 
     224      - |ITreeBuilder_icon| :ref:`Interactive Tree Builder` 
    269225      - 
    270  
    271 .. _`Naive Bayes`: ../../_static/Classify/NaiveBayes.htm 
    272  
    273 .. _`SVM`: ../../_static/Classify/SVM.htm 
    274  
    275 .. _`Logistic Regression`: ../../_static/Classify/LogisticRegression.htm 
    276  
    277 .. _`Majority`: ../../_static/Classify/Majority.htm 
    278  
    279 .. _`Classification Tree`: ../../_static/Classify/ClassificationTree.htm 
    280  
    281 .. _`Classification Tree Graph`: ../../_static/Classify/ClassificationTreeGraph.htm 
    282  
    283 .. _`Classification Tree Viewer`: ../../_static/Classify/ClassificationTreeViewer.htm 
    284  
    285 .. _`CN2 Rules`: ../../_static/Classify/CN2.htm 
    286  
    287 .. _`CN2 Rules Viewer`: ../../_static/Classify/CN2.htm 
    288  
    289 .. _`k-Nearest Neighbours`: ../../_static/Classify/kNearestNeighbours.htm 
    290  
    291 .. _`Nomogram`: ../../_static/Classify/Nomogram.htm 
    292  
    293 .. _`Random Forest`: ../../_static/Classify/RandomForest.htm 
    294  
    295 .. _`C4.5`: ../../_static/Classify/C4.5.htm 
    296  
    297 .. _`Interactive Tree Builder`: ../../_static/Classify/InteractiveTreeBuilder.htm 
    298  
    299226 
    300227.. |NaiveBayes_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/NaiveBayes_48.png 
     
    393320      - |LinearRegression_icon| :ref:`Linear Regression` 
    394321      - |Earth_icon| :ref:`Earth` 
    395     * - |RegressionTree_icon| `Regression Tree`_ 
    396       - |RegressionTreeGraph_icon| `Regression Tree Graph`_ 
    397       - |Pade_icon| `Pade`_ 
    398  
    399 .. _`Regression Tree`: ../../_static/Regression/RegressionTree.htm 
    400  
    401 .. _`Regression Tree Graph`: ../../_static/Regression/RegressionTreeGraph.htm 
    402  
    403 .. _`Pade`: ../../_static/Regression/Pade.htm 
     322    * - |RegressionTree_icon| :ref:`Regression Tree` 
     323      - |RegressionTreeGraph_icon| :ref:`Regression Tree Graph` 
     324      - |Pade_icon| :ref:`Pade` 
    404325 
    405326.. |Mean_icon| image:: ../../../Orange/OrangeWidgets/icons/Unknown.png 
     
    447368    :class: widget-catalog-table 
    448369     
    449     * - |ConfusionMatrix_icon| `Confusion Matrix`_   
    450       - |ROCAnalysis_icon| `ROC Analysis`_ 
    451       - |LiftCurve_icon| `Lift Curve`_ 
    452     * - |CalibrationPlot_icon| `Calibration Plot`_ 
    453       - |TestLearners_icon| `Test Learners`_ 
    454       - |Predictions_icon| `Predictions`_ 
    455  
    456 .. _`Confusion Matrix`: ../../_static/Evaluate/ConfusionMatrix.htm 
    457  
    458 .. _`ROC Analysis`: ../../_static/Evaluate/ROCAnalysis.htm 
    459  
    460 .. _`Lift Curve`: ../../_static/Evaluate/LiftCurve.htm 
    461  
    462 .. _`Calibration Plot`: ../../_static/Evaluate/CalibrationPlot.htm 
    463  
    464 .. _`Test Learners`: ../../_static/Evaluate/TestLearners.htm 
    465  
    466 .. _`Predictions`: ../../_static/Evaluate/Predictions.htm 
     370    * - |ConfusionMatrix_icon| :ref:`Confusion Matrix` 
     371      - |ROCAnalysis_icon| :ref:`ROC Analysis` 
     372      - |LiftCurve_icon| :ref:`Lift Curve` 
     373    * - |CalibrationPlot_icon| :ref:`Calibration Plot` 
     374      - |TestLearners_icon| :ref:`Test Learners` 
     375      - |Predictions_icon| :ref:`Predictions` 
     376 
    467377 
    468378.. |ConfusionMatrix_icon| image:: ../../../Orange/OrangeWidgets/Evaluate/icons/ConfusionMatrix_48.png  
     
    510420    :class: widget-catalog-table 
    511421     
    512     * - |AssociationRules_icon| `Association Rules`_  
    513       - |AssociationRulesFilter_icon| `Association Rules Filter`_  
    514       - |AssociationRulesExplorer_icon| `Association Rules Explorer`_  
    515     * - |ItemSets_icon| `Item Sets`   
    516       - |ItemSetsExplorer_icon| `Item Sets Explorer`  
     422    * - |AssociationRules_icon| :ref:`Association Rules` 
     423      - |AssociationRulesFilter_icon| :ref:`Association Rules Filter` 
     424      - |AssociationRulesExplorer_icon| :ref:`Association Rules Explorer` 
     425    * - |ItemSets_icon| `Item Sets` 
     426      - |ItemSetsExplorer_icon| `Item Sets Explorer` 
    517427      - 
    518  
    519 .. _`Association Rules`: ../../_static/Associate/AssociationRules.htm 
    520  
    521 .. _`Association Rules Filter`: ../../_static/Associate/AssociationRulesFilter.htm 
    522  
    523 .. _`Association Rules Explorer`: ../../_static/Associate/AssociationRulesExplorer.htm 
    524  
    525 .. _`Item Sets`: ../../_static/Associate/ItemSets.htm 
    526  
    527 .. _`Item Sets Explorer`: ../../_static/Associate/ItemSetsExplorer.htm 
    528428 
    529429.. |AssociationRules_icon| image:: ../../../Orange/OrangeWidgets/Associate/icons/AssociationRules_48.png 
     
    565465    :class: widget-catalog-table 
    566466     
    567     * - |DistanceFile_icon| `Distance File`_ 
     467    * - |DistanceFile_icon| :ref:`Distance File` 
    568468      - |SaveDistanceFile_icon| `Save Distance File` 
    569469      - |MatrixTransformation_icon| `Matrix Transformation` 
    570470    * - |DistanceMatrixFilter_icon| `Distance Matrix Filter` 
    571       - |DistanceMap_icon| `Distance Map`_ 
    572       - |ExampleDistance_icon| `Example Distance`_ 
    573     * - |AttributeDistance_icon| `AttributeDistance`_ 
    574       - |HierarchicalClustering_icon| `Hierarchical Clustering`_ 
    575       - |InteractionGraph_icon| `Interaction Graph`_ 
    576     * - |kMeansClustering_icon| `k-Means Clustering`_ 
    577       - |MDS_icon| `MDS`_ 
     471      - |DistanceMap_icon| :ref:`Distance Map` 
     472      - |ExampleDistance_icon| :ref:`Example Distance` 
     473    * - |AttributeDistance_icon| :ref:`Attribute Distance` 
     474      - |HierarchicalClustering_icon| :ref:`Hierarchical Clustering` 
     475      - |InteractionGraph_icon| :ref:`Interaction Graph` 
     476    * - |kMeansClustering_icon| :ref:`k-Means Clustering` 
     477      - |MDS_icon| :ref:`MDS` 
    578478      - |PCA_icon| :ref:`PCA` 
    579     * - |NetworkFile_icon| `Network File` 
    580       - |NetExplorer_icon| `Net Explorer`_ 
    581       - |NetworkFromDistances_icon| `Network From Distances` 
    582479    * - |SOM_icon| `SOM` 
    583480      - |SOMVisualizer_icon| `SOM Visualizer` 
    584481      - 
    585  
    586  
    587 .. _`Distance File`: ../../_static/Unsupervised/DistanceFile.htm 
    588  
    589 .. _`Save Distance File`: ../../_static/Unsupervised/SaveDistanceFile.htm 
    590  
    591 .. _`Matrix Transformation`: ../../_static/Unsupervised/`MatrixTransformation.htm 
    592  
    593 .. _`Distance Matrix Filter`: ../../_static/Unsupervised/DistanceMatrixFilter.htm 
    594  
    595 .. _`Distance Map`: ../../_static/Unsupervised/DistanceMap.htm 
    596  
    597 .. _`Example Distance`: ../../_static/Unsupervised/ExampleDistance.htm 
    598  
    599 .. _`AttributeDistance`: ../../_static/Unsupervised/AttributeDistance.htm 
    600  
    601 .. _`Hierarchical Clustering`: ../../_static/Unsupervised/HierarchicalClustering.htm 
    602  
    603 .. _`Interaction Graph`: ../../_static/Unsupervised/InteractionGraph.htm 
    604  
    605 .. _`k-Means Clustering`: ../../_static/Unsupervised/k-MeansClustering.htm 
    606  
    607 .. _`MDS`: ../../_static/Unsupervised/MDS.htm 
    608  
    609 .. _`Network File`: ../../_static/Unsupervised/NetworkFile.htm 
    610  
    611 .. _`Net Explorer`: ../../_static/Unsupervised/NetExplorer.htm 
    612  
    613 .. _`Network From Distances`: ../../_static/Unsupervised/NetworkFromDistances.htm 
    614  
    615 .. _`SOM`: ../../_static/Unsupervised/SOM.htm 
    616  
    617 .. _`SOM Visualizer`: ../../_static/Unsupervised/SOMVisualizer.htm 
    618482 
    619483.. |DistanceFile_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/DistanceFile_48.png 
     
    726590    
    727591   data/file.rst 
    728    data/data-table.rst 
    729    data/select-attributes.rst 
    730     
     592   data/datatable.rst 
     593   data/selectattributes.rst 
     594   data/rank.rst 
     595   data/purgedomain.rst 
     596   data/mergedata.rst 
     597   data/concatenate.rst 
     598   data/datasampler.rst 
     599   data/selectdata.rst 
     600   data/save.rst 
     601   data/discretize.rst 
     602   data/continuize.rst 
     603   data/impute.rst 
     604   data/outliers.rst 
     605 
     606   visualize/distributions.rst 
     607   visualize/scatterplot.rst 
     608   visualize/attributestatistics.rst 
     609   visualize/linearprojection.rst 
     610   visualize/radviz.rst 
     611   visualize/polyviz.rst 
     612   visualize/parallelcoordinates.rst 
     613   visualize/surveyplot.rst 
     614   visualize/mosaicdisplay.rst 
     615   visualize/sievediagram.rst 
     616 
     617   classify/naivebayes.rst 
     618   classify/svm.rst 
     619   classify/logisticregression.rst 
     620   classify/majority.rst 
     621   classify/classificationtree.rst 
     622   classify/classificationtreegraph.rst 
     623   classify/classificationtreeviewer.rst 
     624   classify/cn2.rst 
     625   classify/cn2rulesviewer.rst 
     626   classify/knearestneighbours.rst 
     627   classify/nomogram.rst 
     628   classify/randomforest.rst 
     629   classify/c45.rst 
     630   classify/interactivetreebuilder.rst 
     631 
    731632   regression/mean.rst 
    732633   regression/linear.rst 
    733634   regression/earth.rst 
    734     
    735    unsupervized/PCA.rst 
     635   regression/regressiontree.rst 
     636   regression/regressiontreegraph.rst 
     637   regression/pade.rst 
     638 
     639   evaluate/confusionmatrix.rst 
     640   evaluate/rocanalysis.rst 
     641   evaluate/liftcurve.rst 
     642   evaluate/calibrationplot.rst 
     643   evaluate/testlearners.rst 
     644   evaluate/predictions.rst 
     645 
     646   associate/associationrules.rst 
     647   associate/associationrulesfilter.rst 
     648   associate/associationrulesexplorer.rst 
     649 
     650   unsupervized/distancefile.rst 
     651   unsupervized/distancemap.rst 
     652   unsupervized/exampledistance.rst 
     653   unsupervized/attributedistance.rst 
     654   unsupervized/hierarchicalclustering.rst 
     655   unsupervized/interactiongraph.rst 
     656   unsupervized/kmeansclustering.rst 
     657   unsupervized/mds.rst 
     658   unsupervized/pca.rst 
    736659 
    737660**************** 
  • docs/widgets/rst/regression/earth.rst

    r10404 r11050  
    5555 
    5656 
    57 After changing one or more settings, you need to push |5| ``Apply``,  
     57After changing one or more settings, you need to push 5 ``Apply``, 
    5858which will put the new learner on the output and, if the training 
    5959examples are given, construct a new predictor and output it as well. 
  • docs/widgets/rst/regression/linear.rst

    r10410 r11050  
    4545    2. Train an ordinary least squares or ridge regression model 
    4646    3. If ``Ridge lambda`` is checked the learner will build a ridge regression model 
    47        with |4| as the ``lambda`` parameter. 
     47       with 4 as the ``lambda`` parameter. 
    4848    4. Ridge lambda parameter. 
    4949    5. Use `Lasso`_ regularization. 
  • docs/widgets/rst/unsupervized/PCA.rst

    r10843 r11050  
    4646The number of components of the transformation can be selected using either 
    4747the `Components Selection` input box or by dragging the vertical cutoff line 
    48 in the graph (|5|). 
     48in the graph. 
Note: See TracChangeset for help on using the changeset viewer.