source: orange/docs/widgets/rst/index.rst @ 11778:ecd4beec2099

Revision 11778:ecd4beec2099, 16.1 KB checked in by Ales Erjavec <ales.erjavec@…>, 5 months ago (diff)

Use new SVG icons in the widget documentation.

Line 
1##############
2Orange Widgets
3##############
4
5
6Data
7----
8
9
10.. list-table::
11    :class: widget-catalog-table
12    :widths: 1 1 1
13   
14    * - |File_icon| :ref:`File`
15      - |DataTable_icon| :ref:`Data Table`
16      - |SelectAttributes_icon| :ref:`Select Attributes`
17    * - |Rank_icon| :ref:`Rank`
18      - |PurgeDomain_icon| :ref:`Purge Domain`
19      - |MergeData_icon| :ref:`Merge Data`
20    * - |Concat_icon| :ref:`Concatenate`
21      - |DataSampler_icon| :ref:`Data Sampler`
22      - |SelectData_icon| :ref:`Select Data`
23    * - |Save_icon| :ref:`Save`
24      - |Discretize_icon| :ref:`Discretize`
25      - |Cont_icon| :ref:`Continuize`
26    * - |Impute_icon| :ref:`Impute`
27      - |Outliers_icon| :ref:`Outliers`
28      - |EditDomain_icon| :ref:`Edit Domain`
29    * - |PythonScript_icon| :ref:`Python Script`
30      -
31      -
32
33.. |File_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/File.svg
34    :alt: File
35    :width: 48
36    :height: 48
37
38.. |DataTable_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/DataTable.svg
39    :alt: Data Table
40    :width: 48
41    :height: 48
42   
43.. |SelectAttributes_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/SelectAttributes.svg
44    :alt: Select Attributes
45    :width: 48
46    :height: 48
47   
48.. |Rank_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/Rank.svg
49    :alt: Rank
50    :width: 48
51    :height: 48
52   
53.. |PurgeDomain_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/PurgeDomain.svg
54    :alt: Purge Domain
55    :width: 48
56    :height: 48
57   
58.. |MergeData_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/MergeData.svg
59    :alt: Merge Data
60    :width: 48
61    :height: 48
62
63.. |Concat_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/Concatenate.svg
64    :alt: Merge Data
65    :width: 48
66    :height: 48
67
68.. |DataSampler_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/DataSampler.svg
69    :alt: Merge Data
70    :width: 48
71    :height: 48
72
73.. |SelectData_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/SelectData.svg
74    :alt: Merge Data
75    :width: 48
76    :height: 48
77
78.. |Save_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/Save.svg
79    :alt: Merge Data
80    :width: 48
81    :height: 48
82
83.. |Discretize_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/Discretize.svg
84    :alt: Merge Data
85    :width: 48
86    :height: 48
87
88.. |Cont_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/Continuize.svg
89    :alt: Merge Data
90    :width: 48
91    :height: 48
92   
93.. |Impute_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/Impute.svg
94    :alt: Merge Data
95    :width: 48
96    :height: 48
97   
98.. |Outliers_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/Outliers.svg
99    :alt: Merge Data
100    :width: 48
101    :height: 48
102
103.. |EditDomain_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/EditDomain.svg
104   :alt: Edit Domain
105   :width: 48
106   :height: 48
107
108.. |PythonScript_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/PythonScript.svg
109   :alt: Edit Domain
110   :width: 48
111   :height: 48
112
113
114Visualize
115---------
116
117.. list-table::
118    :class: widget-catalog-table
119    :widths: 1 1 1
120   
121    * - |Distributions_icon| :ref:`Distributions`
122      - |ScatterPlot_icon| :ref:`Scatter Plot`
123      - |AttributeStatistics_icon| :ref:`Attribute Statistics`
124    * - |LinearProjection_icon| :ref:`Linear Projection`
125      - |Radviz_icon| :ref:`Radviz`
126      - |Polyviz_icon| :ref:`Polyviz`
127    * - |ParallelCoords_icon| :ref:`Parallel Coordinates`
128      - |SurveyPlot_icon| :ref:`Survey Plot`
129      - |MosaicDisplay_icon| :ref:`Mosaic Display`
130    * - |SieveDiagram_icon| :ref:`Sieve Diagram`
131      - |SieveMultigram_icon| `Sieve Multigram`
132      -
133
134.. |Distributions_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/Distribution.svg
135    :alt: Distributions
136    :width: 48
137    :height: 48
138   
139.. |ScatterPlot_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/ScatterPlot.svg
140    :alt: Scatter Plot
141    :width: 48
142    :height: 48
143   
144.. |AttributeStatistics_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/AttributeStatistics.svg
145    :alt: AttributeStatistics
146    :width: 48
147    :height: 48
148   
149.. |LinearProjection_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/LinearProjection.svg
150    :alt: Linear Projection
151    :width: 48
152    :height: 48
153   
154.. |Radviz_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/Radviz.svg
155    :alt: Rad Viz
156    :width: 48
157    :height: 48
158   
159.. |Polyviz_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/Polyviz.svg
160    :alt: Poly Viz
161    :width: 48
162    :height: 48
163   
164.. |ParallelCoords_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/ParallelCoordinates.svg
165    :alt: Parallel Coordinates
166    :width: 48
167    :height: 48
168
169.. |SurveyPlot_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/SurveyPlot.svg
170    :alt: Survey Plot
171    :width: 48
172    :height: 48
173   
174.. |MosaicDisplay_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/MosaicDisplay.svg
175    :alt: Mosaic Display
176    :width: 48
177    :height: 48
178   
179.. |SieveDiagram_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/SieveDiagram.svg
180    :alt: Sieve Diagram
181    :width: 48
182    :height: 48
183   
184.. |SieveMultigram_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/SieveMultigram.svg
185    :alt: Sieve Multigram
186    :width: 48
187    :height: 48
188
189
190Classify
191--------
192   
193.. list-table::
194    :class: widget-catalog-table
195    :widths: 1 1 1
196   
197    * - |NaiveBayes_icon| :ref:`Naive Bayes`
198      - |SVM_icon| :ref:`SVM`
199      - |LogReg_icon| :ref:`Logistic Regression`
200    * - |Majority_icon| :ref:`Majority`
201      - |ClassificationTree_icon| :ref:`Classification Tree`
202      - |ClassificationTreeGraph_icon| :ref:`Classification Tree Graph`
203    * - |ClsTreeViewer_icon| :ref:`Classification Tree Viewer`
204      - |CN2Rules_icon| :ref:`CN2 Rules`
205      - |CN2RulesViewer_icon| :ref:`CN2 Rules Viewer`
206    * - |kNN_icon| :ref:`k-Nearest Neighbours`
207      - |Nomogram_icon| :ref:`Nomogram`
208      - |RandomForest_icon| :ref:`Random Forest`
209    * - |C4.5_icon| :ref:`C4.5`
210      - |ITreeBuilder_icon| :ref:`Interactive Tree Builder`
211      -
212
213.. |NaiveBayes_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/NaiveBayes.svg
214    :alt: Naive Bayes
215    :width: 48
216    :height: 48
217
218.. |SVM_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/SVM.svg
219    :alt: Support Vector Machines
220    :width: 48
221    :height: 48
222
223.. |LogReg_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/LogisticRegression.svg
224    :alt: Logistic Regression
225    :width: 48
226    :height: 48
227
228.. |Majority_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/Majority.svg
229    :alt: Majority
230    :width: 48
231    :height: 48
232
233.. |ClassificationTree_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/ClassificationTree.svg
234    :alt: Classification Tree
235    :width: 48
236    :height: 48
237
238.. |ClassificationTreeGraph_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/ClassificationTreeGraph.svg
239    :alt: Classification Tree Graph
240    :width: 48
241    :height: 48
242
243.. |ClsTreeViewer_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/ClassificationTreeViewer.svg
244    :alt: Classification Tree Viewer
245    :width: 48
246    :height: 48
247
248.. |CN2Rules_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/CN2.svg
249    :alt: CN2 Rules
250    :width: 48
251    :height: 48
252
253.. |CN2RulesViewer_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/CN2RulesViewer.svg
254    :alt: CN2 Rules Viewer
255    :width: 48
256    :height: 48
257
258.. |kNN_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/kNearestNeighbours.svg
259    :alt: k-Nearest Neighbours
260    :width: 48
261    :height: 48
262
263.. |Nomogram_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/Nomogram.svg
264    :alt: Nomogram
265    :width: 48
266    :height: 48
267
268.. |RandomForest_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/RandomForest.svg
269    :alt: Random Forest
270    :width: 48
271    :height: 48
272
273.. |C4.5_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/C4.5.svg
274    :alt: C4.5
275    :width: 48
276    :height: 48
277
278.. |ITreeBuilder_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/InteractiveTreeBuilder.svg
279    :alt: Interactive Tree Builder
280    :width: 48
281    :height: 48
282
283
284Regression
285----------
286
287.. list-table::
288    :widths: 1 1 1
289    :class: widget-catalog-table
290   
291    * - |Mean_icon| :ref:`Mean`
292      - |LinearRegression_icon| :ref:`Linear Regression`
293      - |RegressionTree_icon| :ref:`Regression Tree`
294    * - |RegressionTreeGraph_icon| :ref:`Regression Tree Graph`
295      - |Pade_icon| :ref:`Pade`
296      -
297
298
299.. |Mean_icon| image:: ../../../Orange/OrangeWidgets/Regression/icons/Mean.svg
300    :alt: Mean
301    :width: 48
302    :height: 48
303
304.. |LinearRegression_icon| image:: ../../../Orange/OrangeWidgets//Regression/icons/LinearRegression.svg
305    :alt: Linear Regression
306    :width: 48
307    :height: 48
308
309.. |RegressionTree_icon| image:: ../../../Orange/OrangeWidgets/Regression/icons/RegressionTree.svg
310    :alt: Regression Tree
311    :width: 48
312    :height: 48
313
314.. |RegressionTreeGraph_icon| image:: ../../../Orange/OrangeWidgets/Regression/icons/RegressionTreeGraph.svg
315    :alt: Regression Tree Graph
316    :width: 48
317    :height: 48
318
319.. |Pade_icon| image:: ../../../Orange/OrangeWidgets/Regression/icons/Pade.svg
320    :alt: Pade
321    :width: 48
322    :height: 48
323
324
325Evaluate
326--------
327
328.. list-table::
329    :widths: 1 1 1
330    :class: widget-catalog-table
331   
332    * - |ConfusionMatrix_icon| :ref:`Confusion Matrix`
333      - |ROCAnalysis_icon| :ref:`ROC Analysis`
334      - |LiftCurve_icon| :ref:`Lift Curve`
335    * - |CalibrationPlot_icon| :ref:`Calibration Plot`
336      - |TestLearners_icon| :ref:`Test Learners`
337      - |Predictions_icon| :ref:`Predictions`
338
339
340.. |ConfusionMatrix_icon| image:: ../../../Orange/OrangeWidgets/Evaluate/icons/ConfusionMatrix.svg
341    :alt: Confusion Matrix
342    :width: 48
343    :height: 48
344
345.. |ROCAnalysis_icon| image:: ../../../Orange/OrangeWidgets/Evaluate/icons/ROCAnalysis.svg
346    :alt: Pade
347    :width: 48
348    :height: 48
349
350.. |LiftCurve_icon| image:: ../../../Orange/OrangeWidgets/Evaluate/icons/LiftCurve.svg
351    :alt: Lift Curve
352    :width: 48
353    :height: 48
354
355.. |CalibrationPlot_icon| image:: ../../../Orange/OrangeWidgets/Evaluate/icons/CalibrationPlot.svg
356    :alt: Calibration Plot
357    :width: 48
358    :height: 48
359
360.. |TestLearners_icon| image:: ../../../Orange/OrangeWidgets/Evaluate/icons/TestLearners1.svg
361    :alt: Test Learners
362    :width: 48
363    :height: 48
364
365.. |Predictions_icon| image:: ../../../Orange/OrangeWidgets/Evaluate/icons/Predictions.svg
366    :alt: Predictions
367    :width: 48
368    :height: 48
369
370
371Associate
372---------
373
374.. list-table::
375    :widths: 1 1 1
376    :class: widget-catalog-table
377   
378    * - |AssociationRules_icon| :ref:`Association Rules`
379      - |AssociationRulesFilter_icon| :ref:`Association Rules Filter`
380      - |AssociationRulesExplorer_icon| :ref:`Association Rules Explorer`
381    * - |ItemSets_icon| `Item Sets`
382      - |ItemSetsExplorer_icon| `Item Sets Explorer`
383      -
384
385.. |AssociationRules_icon| image:: ../../../Orange/OrangeWidgets/Associate/icons/AssociationRules.svg
386    :alt: Association Rules
387    :width: 48
388    :height: 48
389
390.. |AssociationRulesFilter_icon| image:: ../../../Orange/OrangeWidgets/Associate/icons/AssociationRulesFilter.svg
391    :alt: AssociationRulesFilter
392    :width: 48
393    :height: 48
394
395.. |AssociationRulesExplorer_icon| image:: ../../../Orange/OrangeWidgets/Associate/icons/AssociationRulesExplorer.svg
396    :alt: Association Rules Explorer
397    :width: 48
398    :height: 48
399
400.. |ItemSets_icon| image:: ../../../Orange/OrangeWidgets/Associate/icons/Itemsets.svg
401    :alt: Item Sets
402    :width: 48
403    :height: 48
404
405.. |ItemSetsExplorer_icon| image:: ../../../Orange/OrangeWidgets/Associate/icons/ItemsetsExplorer.svg
406    :alt: Item Sets Explorer
407    :width: 48
408    :height: 48
409
410
411Unsupervised
412------------
413
414.. list-table::
415    :widths: 1 1 1
416    :class: widget-catalog-table
417   
418    * - |DistanceFile_icon| :ref:`Distance File`
419      - |SaveDistanceFile_icon| `Save Distance File`
420      - |MatrixTransformation_icon| `Matrix Transformation`
421    * - |DistanceMatrixFilter_icon| `Distance Matrix Filter`
422      - |DistanceMap_icon| :ref:`Distance Map`
423      - |ExampleDistance_icon| :ref:`Example Distance`
424    * - |AttributeDistance_icon| :ref:`Attribute Distance`
425      - |HierarchicalClustering_icon| :ref:`Hierarchical Clustering`
426      - |InteractionGraph_icon| :ref:`Interaction Graph`
427    * - |kMeansClustering_icon| :ref:`k-Means Clustering`
428      - |MDS_icon| :ref:`MDS`
429      - |PCA_icon| :ref:`PCA`
430    * - |SOM_icon| `SOM`
431      - |SOMVisualizer_icon| `SOM Visualizer`
432      -
433
434.. |DistanceFile_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/LoadDistances.svg
435    :alt: Distance File
436    :width: 48
437    :height: 48
438
439.. |SaveDistanceFile_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/SaveDistances.svg
440    :alt: Save Distance File
441    :width: 48
442    :height: 48
443
444.. |MatrixTransformation_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/MatrixTransformation.svg
445    :alt: Matrix Transformation
446    :width: 48
447    :height: 48
448
449.. |DistanceMatrixFilter_icon| image:: ../../../Orange/OrangeWidgets/icons/DistanceFilter.png
450    :alt: Distance Matrix Filter
451    :width: 48
452    :height: 48
453
454.. |DistanceMap_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/DistanceMatrix.svg
455    :alt: Distance Map
456    :width: 48
457    :height: 48
458
459.. |ExampleDistance_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/Distance.svg
460    :alt: Example Distance
461    :width: 48
462    :height: 48
463
464.. |AttributeDistance_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/Distance.svg
465    :alt: Attribute Distance
466    :width: 48
467    :height: 48
468
469.. |HierarchicalClustering_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/HierarchicalClustering.svg
470    :alt: Hierarchical Clustering
471    :width: 48
472    :height: 48
473
474.. |InteractionGraph_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/InteractionGraph_48.png
475    :alt: Interaction Graph
476    :width: 48
477    :height: 48
478
479.. |kMeansClustering_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/kMeansClustering.svg
480    :alt: k-Means Clustering
481    :width: 48
482    :height: 48
483
484.. |MDS_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/MDS.svg
485    :alt: MDS
486    :width: 48
487    :height: 48
488
489.. |PCA_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/PCA.svg
490    :alt: PCA
491    :width: 48
492    :height: 48
493
494.. |SOM_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/SOM.svg
495    :alt: SOM
496    :width: 48
497    :height: 48
498
499.. |SOMVisualizer_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/SOMVisualizer.svg
500    :alt: SOM Visualizer
501    :width: 48
502    :height: 48
503
504
505Index:
506
507.. toctree::
508   :maxdepth: 1
509   
510   data/file.rst
511   data/datatable.rst
512   data/selectattributes.rst
513   data/rank.rst
514   data/purgedomain.rst
515   data/mergedata.rst
516   data/concatenate.rst
517   data/datasampler.rst
518   data/selectdata.rst
519   data/save.rst
520   data/discretize.rst
521   data/continuize.rst
522   data/impute.rst
523   data/outliers.rst
524   data/editdomain.rst
525   data/pythonscript.rst
526
527   visualize/distributions.rst
528   visualize/scatterplot.rst
529   visualize/attributestatistics.rst
530   visualize/linearprojection.rst
531   visualize/radviz.rst
532   visualize/polyviz.rst
533   visualize/parallelcoordinates.rst
534   visualize/surveyplot.rst
535   visualize/mosaicdisplay.rst
536   visualize/sievediagram.rst
537
538   classify/naivebayes.rst
539   classify/svm.rst
540   classify/logisticregression.rst
541   classify/majority.rst
542   classify/classificationtree.rst
543   classify/classificationtreegraph.rst
544   classify/classificationtreeviewer.rst
545   classify/cn2.rst
546   classify/cn2rulesviewer.rst
547   classify/knearestneighbours.rst
548   classify/nomogram.rst
549   classify/randomforest.rst
550   classify/c45.rst
551   classify/interactivetreebuilder.rst
552
553   regression/mean.rst
554   regression/linear.rst
555   regression/regressiontree.rst
556   regression/regressiontreegraph.rst
557   regression/pade.rst
558
559   evaluate/confusionmatrix.rst
560   evaluate/rocanalysis.rst
561   evaluate/liftcurve.rst
562   evaluate/calibrationplot.rst
563   evaluate/testlearners.rst
564   evaluate/predictions.rst
565
566   associate/associationrules.rst
567   associate/associationrulesfilter.rst
568   associate/associationrulesexplorer.rst
569
570   unsupervized/distancefile.rst
571   unsupervized/distancemap.rst
572   unsupervized/exampledistance.rst
573   unsupervized/attributedistance.rst
574   unsupervized/hierarchicalclustering.rst
575   unsupervized/interactiongraph.rst
576   unsupervized/kmeansclustering.rst
577   unsupervized/mds.rst
578   unsupervized/PCA.rst
579
580****************
581Index and search
582****************
583
584* :ref:`genindex`
585* :ref:`search`
Note: See TracBrowser for help on using the repository browser.