source: orange/docs/widgets/rst/index.rst @ 11050:e3c4699ca155

Revision 11050:e3c4699ca155, 17.9 KB checked in by Miha Stajdohar <miha.stajdohar@…>, 16 months ago (diff)

Widget docs From HTML to Sphinx.

Line 
1##############
2Orange Widgets
3##############
4
5
6Data
7----
8
9.. The first row shows how to insert rst documentation, the rest
10   link to the old documentation that is copied to '_static'
11
12.. list-table::
13    :class: widget-catalog-table
14    :widths: 1 1 1
15   
16    * - |File_icon| :ref:`File`
17      - |DataTable_icon| :ref:`Data Table`
18      - |SelectAttributes_icon| :ref:`Select Attributes`
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`
30      -
31
32.. |File_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/File_48.png
33    :align: middle
34    :alt: File
35    :width: 48
36    :height: 48
37
38.. |DataTable_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/DataTable_48.png
39    :align: middle
40    :alt: Data Table
41    :width: 48
42    :height: 48
43   
44.. |SelectAttributes_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/SelectAttributes_48.png
45    :align: middle
46    :alt: Select Attributes
47    :width: 48
48    :height: 48
49   
50.. |Rank_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/Rank_48.png
51    :align: middle
52    :alt: Rank
53    :width: 48
54    :height: 48
55   
56.. |PurgeDomain_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/PurgeDomain_48.png
57    :align: middle
58    :alt: Purge Domain
59    :width: 48
60    :height: 48
61   
62.. |MergeData_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/MergeData_48.png
63    :align: middle
64    :alt: Merge Data
65    :width: 48
66    :height: 48
67
68.. |Concat_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/Concatenate_48.png
69    :align: middle
70    :alt: Merge Data
71    :width: 48
72    :height: 48
73
74.. |DataSampler_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/DataSampler_48.png
75    :align: middle
76    :alt: Merge Data
77    :width: 48
78    :height: 48
79
80.. |SelectData_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/SelectData_48.png
81    :align: middle
82    :alt: Merge Data
83    :width: 48
84    :height: 48
85
86.. |Save_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/Save_48.png
87    :align: middle
88    :alt: Merge Data
89    :width: 48
90    :height: 48
91
92.. |Discretize_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/Discretize_48.png
93    :align: middle
94    :alt: Merge Data
95    :width: 48
96    :height: 48
97
98.. |Cont_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/Continuize_48.png
99    :align: middle
100    :alt: Merge Data
101    :width: 48
102    :height: 48
103   
104.. |Impute_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/Impute_48.png
105    :align: middle
106    :alt: Merge Data
107    :width: 48
108    :height: 48
109   
110.. |Outliers_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/Outliers_48.png
111    :align: middle
112    :alt: Merge Data
113    :width: 48
114    :height: 48
115
116
117Visualize
118---------
119
120.. list-table::
121    :class: widget-catalog-table
122    :widths: 1 1 1
123   
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`
134      - |SieveMultigram_icon| Sieve Multigram
135      -
136
137.. |Distributions_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/Distribution_48.png
138    :align: middle
139    :alt: Distributions
140    :width: 48
141    :height: 48
142   
143.. |ScatterPlot_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/ScatterPlot_48.png
144    :align: middle
145    :alt: Scatter Plot
146    :width: 48
147    :height: 48
148   
149.. |AttributeStatistics_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/AttributeStatistics_48.png
150    :align: middle
151    :alt: AttributeStatistics
152    :width: 48
153    :height: 48
154   
155.. |LinearProjection_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/LinearProjection_48.png
156    :align: middle
157    :alt: Linear Projection
158    :width: 48
159    :height: 48
160   
161.. |Radviz_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/Radviz_48.png
162    :align: middle
163    :alt: Rad Viz
164    :width: 48
165    :height: 48
166   
167.. |Polyviz_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/Polyviz_48.png
168    :align: middle
169    :alt: Poly Viz
170    :width: 48
171    :height: 48
172   
173.. |ParallelCoords_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/ParallelCoordinates_48.png
174    :align: middle
175    :alt: Parallel Coordinates
176    :width: 48
177    :height: 48
178   
179.. |SurveyPlot_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/SurveyPlot_48.png
180    :align: middle
181    :alt: Survey Plot
182    :width: 48
183    :height: 48
184   
185.. |MosaicDisplay_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/MosaicDisplay_48.png
186    :align: middle
187    :alt: Mosaic Display
188    :width: 48
189    :height: 48
190   
191.. |SieveDiagram_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/SieveDiagram_48.png
192    :align: middle
193    :alt: Sieve Diagram
194    :width: 48
195    :height: 48
196   
197.. |SieveMultigram_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/SieveMultigram_48.png
198    :align: middle
199    :alt: Sieve Multigram
200    :width: 48
201    :height: 48
202
203
204Classify
205--------
206   
207.. list-table::
208    :class: widget-catalog-table
209    :widths: 1 1 1
210   
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`
225      -
226
227.. |NaiveBayes_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/NaiveBayes_48.png
228    :align: middle
229    :alt: Naive Bayes
230    :width: 48
231    :height: 48
232
233.. |SVM_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/BasicSVM_48.png
234    :align: middle
235    :alt: Support Vector Machines
236    :width: 48
237    :height: 48
238
239.. |LogReg_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/LogisticRegression_48.png
240    :align: middle
241    :alt: Logistic Regression
242    :width: 48
243    :height: 48
244
245.. |Majority_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/Majority_48.png
246    :align: middle
247    :alt: Majority
248    :width: 48
249    :height: 48
250
251.. |ClassificationTree_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/ClassificationTree_48.png
252    :align: middle
253    :alt: Classification Tree
254    :width: 48
255    :height: 48
256
257.. |ClassificationTreeGraph_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/ClassificationTreeGraph_48.png
258    :align: middle
259    :alt: Classification Tree Graph
260    :width: 48
261    :height: 48
262
263.. |ClsTreeViewer_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/ClassificationTreeViewer_48.png
264    :align: middle
265    :alt: Classification Tree Viewer
266    :width: 48
267    :height: 48
268
269.. |CN2Rules_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/CN2_48.png
270    :align: middle
271    :alt: CN2 Rules
272    :width: 48
273    :height: 48
274
275.. |CN2RulesViewer_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/CN2RulesViewer_48.png
276    :align: middle
277    :alt: CN2 Rules Viewer
278    :width: 48
279    :height: 48
280
281.. |kNN_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/kNearestNeighbours_48.png
282    :align: middle
283    :alt: k-Nearest Neighbours
284    :width: 48
285    :height: 48
286
287.. |Nomogram_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/Nomogram_48.png
288    :align: middle
289    :alt: Nomogram
290    :width: 48
291    :height: 48
292
293.. |RandomForest_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/RandomForest_48.png
294    :align: middle
295    :alt: Random Forest
296    :width: 48
297    :height: 48
298
299.. |C4.5_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/C45_48.png
300    :align: middle
301    :alt: C4.5
302    :width: 48
303    :height: 48
304
305.. |ITreeBuilder_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/ITree_48.png
306    :align: middle
307    :alt: Interactive Tree Builder
308    :width: 48
309    :height: 48
310
311
312Regression
313----------
314
315.. list-table::
316    :widths: 1 1 1
317    :class: widget-catalog-table
318   
319    * - |Mean_icon| :ref:`Mean`
320      - |LinearRegression_icon| :ref:`Linear Regression`
321      - |Earth_icon| :ref:`Earth`
322    * - |RegressionTree_icon| :ref:`Regression Tree`
323      - |RegressionTreeGraph_icon| :ref:`Regression Tree Graph`
324      - |Pade_icon| :ref:`Pade`
325
326.. |Mean_icon| image:: ../../../Orange/OrangeWidgets/icons/Unknown.png
327    :align: middle
328    :alt: Mean
329    :width: 48
330    :height: 48
331
332.. |LinearRegression_icon| image:: ../../../Orange/OrangeWidgets/icons/Unknown.png
333    :align: middle
334    :alt: Linear Regression
335    :width: 48
336    :height: 48
337
338.. |Earth_icon| image:: ../../../Orange/OrangeWidgets/icons/Unknown.png
339    :align: middle
340    :alt: Earth
341    :width: 48
342    :height: 48
343
344.. |RegressionTree_icon| image:: ../../../Orange/OrangeWidgets/Regression/icons/RegressionTree.png
345    :align: middle
346    :alt: Regression Tree
347    :width: 48
348    :height: 48
349
350.. |RegressionTreeGraph_icon| image:: ../../../Orange/OrangeWidgets/Regression/icons/RegressionTreeGraph.png
351    :align: middle
352    :alt: Regression Tree Graph
353    :width: 48
354    :height: 48
355
356.. |Pade_icon| image:: ../../../Orange/OrangeWidgets/Regression/icons/Pade.png
357    :align: middle
358    :alt: Pade
359    :width: 48
360    :height: 48
361
362
363Evaluate
364--------
365
366.. list-table::
367    :widths: 1 1 1
368    :class: widget-catalog-table
369   
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
377
378.. |ConfusionMatrix_icon| image:: ../../../Orange/OrangeWidgets/Evaluate/icons/ConfusionMatrix_48.png
379    :align: middle
380    :alt: Confusion Matrix
381    :width: 48
382    :height: 48
383
384.. |ROCAnalysis_icon| image:: ../../../Orange/OrangeWidgets/Evaluate/icons/ROCAnalysis_48.png
385    :align: middle
386    :alt: Pade
387    :width: 48
388    :height: 48
389
390.. |LiftCurve_icon| image:: ../../../Orange/OrangeWidgets/Evaluate/icons/LiftCurve_48.png
391    :align: middle
392    :alt: Lift Curve
393    :width: 48
394    :height: 48
395
396.. |CalibrationPlot_icon| image:: ../../../Orange/OrangeWidgets/Evaluate/icons/CalibrationPlot_48.png
397    :align: middle
398    :alt: Calibration Plot
399    :width: 48
400    :height: 48
401
402.. |TestLearners_icon| image:: ../../../Orange/OrangeWidgets/Evaluate/icons/TestLearners_48.png
403    :align: middle
404    :alt: Test Learners
405    :width: 48
406    :height: 48
407
408.. |Predictions_icon| image:: ../../../Orange/OrangeWidgets/Evaluate/icons/Predictions_48.png
409    :align: middle
410    :alt: Predictions
411    :width: 48
412    :height: 48
413
414
415Associate
416---------
417
418.. list-table::
419    :widths: 1 1 1
420    :class: widget-catalog-table
421   
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`
427      -
428
429.. |AssociationRules_icon| image:: ../../../Orange/OrangeWidgets/Associate/icons/AssociationRules_48.png
430    :align: middle
431    :alt: Association Rules
432    :width: 48
433    :height: 48
434
435.. |AssociationRulesFilter_icon| image:: ../../../Orange/OrangeWidgets/Associate/icons/AssociationRulesViewer_48.png
436    :align: middle
437    :alt: AssociationRulesFilter
438    :width: 48
439    :height: 48
440
441.. |AssociationRulesExplorer_icon| image:: ../../../Orange/OrangeWidgets/Associate/icons/AssociationRulesTreeViewer_48.png
442    :align: middle
443    :alt: Association Rules Explorer
444    :width: 48
445    :height: 48
446
447.. |ItemSets_icon| image:: ../../../Orange/OrangeWidgets/Associate/icons/Itemsets_48.png
448    :align: middle
449    :alt: Item Sets
450    :width: 48
451    :height: 48
452
453.. |ItemSetsExplorer_icon| image:: ../../../Orange/OrangeWidgets/Associate/icons/ItemsetsExplorer_48.png
454    :align: middle
455    :alt: Item Sets Explorer
456    :width: 48
457    :height: 48
458
459
460Unsupervised
461------------
462
463.. list-table::
464    :widths: 1 1 1
465    :class: widget-catalog-table
466   
467    * - |DistanceFile_icon| :ref:`Distance File`
468      - |SaveDistanceFile_icon| `Save Distance File`
469      - |MatrixTransformation_icon| `Matrix Transformation`
470    * - |DistanceMatrixFilter_icon| `Distance Matrix Filter`
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`
478      - |PCA_icon| :ref:`PCA`
479    * - |SOM_icon| `SOM`
480      - |SOMVisualizer_icon| `SOM Visualizer`
481      -
482
483.. |DistanceFile_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/DistanceFile_48.png
484    :align: middle
485    :alt: Distance File
486    :width: 48
487    :height: 48
488
489.. |SaveDistanceFile_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/SaveDistanceFile_48.png
490    :align: middle
491    :alt: Save Distance File
492    :width: 48
493    :height: 48
494
495.. |MatrixTransformation_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/MatrixTransformation_48.png
496    :align: middle
497    :alt: Matrix Transformation
498    :width: 48
499    :height: 48
500
501.. |DistanceMatrixFilter_icon| image:: ../../../Orange/OrangeWidgets/icons/DistanceFilter.png
502    :align: middle
503    :alt: Distance Matrix Filter
504    :width: 48
505    :height: 48
506
507.. |DistanceMap_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/DistanceMap_48.png
508    :align: middle
509    :alt: Distance Map
510    :width: 48
511    :height: 48
512
513.. |ExampleDistance_icon| image:: ../../../Orange/OrangeWidgets/icons/ExampleDistance.png
514    :align: middle
515    :alt: Example Distance
516    :width: 48
517    :height: 48
518
519.. |AttributeDistance_icon| image:: ../../../Orange/OrangeWidgets/icons/AttributeDistance.png
520    :align: middle
521    :alt: Attribute Distance
522    :width: 48
523    :height: 48
524
525.. |HierarchicalClustering_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/HierarchicalClustering_48.png
526    :align: middle
527    :alt: Hierarchical Clustering
528    :width: 48
529    :height: 48
530
531.. |InteractionGraph_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/InteractionGraph_48.png
532    :align: middle
533    :alt: Interaction Graph
534    :width: 48
535    :height: 48
536
537.. |kMeansClustering_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/KMeans_48.png
538    :align: middle
539    :alt: k-Means Clustering
540    :width: 48
541    :height: 48
542
543.. |MDS_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/MDS_48.png
544    :align: middle
545    :alt: MDS
546    :width: 48
547    :height: 48
548
549.. |PCA_icon| image:: ../../../Orange/OrangeWidgets/icons/Unknown.png
550    :align: middle
551    :alt: PCA
552    :width: 48
553    :height: 48
554
555.. |NetworkFile_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/NetworkFile_48.png
556    :align: middle
557    :alt: NetworkFile
558    :width: 48
559    :height: 48
560
561.. |NetExplorer_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/Network_48.png
562    :align: middle
563    :alt: Net Explorer
564    :width: 48
565    :height: 48
566
567.. |NetworkFromDistances_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/NetworkFromDistances_48.png
568    :align: middle
569    :alt: Network From Distances
570    :width: 48
571    :height: 48
572
573.. |SOM_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/SOM_48.png
574    :align: middle
575    :alt: SOM
576    :width: 48
577    :height: 48
578
579.. |SOMVisualizer_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/SOMVisualizer_48.png
580    :align: middle
581    :alt: SOM Visualizer
582    :width: 48
583    :height: 48
584
585
586Index:
587
588.. toctree::
589   :maxdepth: 1
590   
591   data/file.rst
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
632   regression/mean.rst
633   regression/linear.rst
634   regression/earth.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
659
660****************
661Index and search
662****************
663
664* :ref:`genindex`
665* :ref:`search`
Note: See TracBrowser for help on using the repository browser.