Changeset 8021:8f295c34499e in orange


Ignore:
Timestamp:
06/14/11 15:22:15 (3 years ago)
Author:
markotoplak
Branch:
default
Convert:
bcdb85492de792adb1843569d0875c61c5b81b53
Message:

Moved titles from .rst files into docstrings.

Location:
orange
Files:
37 edited

Legend:

Unmodified
Added
Removed
  • orange/Orange/classification/bayes.py

    r7977 r8021  
    55   single: classification; naive Bayes classifier 
    66 
    7 ********************** 
    8 Naive Bayes classifier 
    9 ********************** 
     7********************************** 
     8Naive Bayes classifier (``bayes``) 
     9********************************** 
    1010 
    1111The most primitive Bayesian classifier is :obj:`NaiveLearner`.  
  • orange/Orange/classification/knn.py

    r7926 r8021  
    44   single: classification; k-nearest neighbors (kNN) 
    55    
    6 ******************* 
    7 k-nearest neighbors 
    8 ******************* 
     6***************************** 
     7k-nearest neighbors (``knn``) 
     8***************************** 
    99 
    1010The module includes implementation of the `nearest neighbors  
  • orange/Orange/classification/logreg.py

    r7757 r8021  
    44   single: classification; logistic regression 
    55 
    6 ******************* 
    7 Logistic regression 
    8 ******************* 
     6******************************** 
     7Logistic regression (``logreg``) 
     8******************************** 
    99 
    1010Implements `logistic regression 
  • orange/Orange/classification/lookup.py

    r7761 r8021  
    33.. index:: classification; lookup 
    44 
    5 ****************** 
    6 Lookup classifiers 
    7 ****************** 
     5******************************* 
     6Lookup classifiers (``lookup``) 
     7******************************* 
    88 
    99Lookup classifiers predict classes by looking into stored lists of 
  • orange/Orange/classification/majority.py

    r7573 r8021  
    11""" 
    2 ******** 
    3 Majority 
    4 ******** 
     2*********************** 
     3Majority (``majority``) 
     4*********************** 
    55 
    66.. index:: majority classifier 
  • orange/Orange/classification/rules.py

    r7824 r8021  
    66   single: classification; rule induction 
    77 
    8 ************** 
    9 Rule induction 
    10 ************** 
     8************************** 
     9Rule induction (``rules``) 
     10************************** 
    1111 
    1212Orange implements several supervised rule induction algorithms 
  • orange/Orange/classification/svm/__init__.py

    r7660 r8021  
    22.. index:: classification, support vector machines (SVM) 
    33 
    4 *********************** 
    5 Support vector machines 
    6 *********************** 
     4********************************* 
     5Support vector machines (``svm``) 
     6********************************* 
    77 
    88A collection of classes that wrap the `LibSVM library 
  • orange/Orange/classification/tree.py

    r7939 r8021  
    66   single: classification; tree 
    77 
    8 ******************** 
    9 Classification trees 
    10 ******************** 
     8******************************* 
     9Classification trees (``tree``) 
     10******************************* 
    1111 
    1212To build a small tree (:obj:`TreeClassifier`) from the iris data set 
  • orange/Orange/data/sample.py

    r7895 r8021  
    11""" 
     2================================= 
     3Sampling of examples (``sample``) 
     4================================= 
     5 
    26Example sampling is one of the basic procedures in machine learning. If 
    37for nothing else, everybody needs to split dataset into training and 
  • orange/Orange/data/variable.py

    r7927 r8021  
    11""" 
     2======================== 
     3Variables (``variable``) 
     4======================== 
     5 
    26Data instances in Orange can contain several types of variables: 
    37:ref:`discrete <discrete>`, :ref:`continuous <continuous>`, 
  • orange/Orange/evaluation/reliability.py

    r7959 r8021  
    11""" 
     2######################################## 
     3Reliability estimation (``reliability``) 
     4######################################## 
     5 
    26.. index:: Reliability Estimation 
    37 
  • orange/Orange/evaluation/scoring.py

    r7876 r8021  
    11""" 
     2############################ 
     3Method scoring (``scoring``) 
     4############################ 
    25 
    36.. index: scoring 
  • orange/Orange/evaluation/testing.py

    r7898 r8021  
    22.. index:: Testing, Sampling 
    33 
    4 ==================== 
    5 Sampling and Testing 
    6 ==================== 
     4================================== 
     5Sampling and Testing (``testing``) 
     6================================== 
    77 
    88This module includes functions for data sampling and splitting, and for 
  • orange/Orange/misc/__init__.py

    r8010 r8021  
    11""" 
    2  
    32.. index:: misc 
    43 
  • orange/Orange/misc/addons.py

    r8010 r8021  
    11""" 
    2 ================== 
    3 Add-on Management 
    4 ================== 
     2============================== 
     3Add-on Management (``addons``) 
     4============================== 
    55 
    66.. index:: add-ons 
  • orange/Orange/misc/counters.py

    r8010 r8021  
    11""" 
    2 ================== 
    3 Counters 
    4 ================== 
     2======================= 
     3Counters (``counters``) 
     4======================= 
    55 
    66.. index:: misc 
  • orange/Orange/misc/environ.py

    r8010 r8021  
    11""" 
    2 ================================ 
    3 Orange environment configuration 
    4 ================================ 
     2============================================== 
     3Orange environment configuration (``environ``) 
     4============================================== 
    55 
    66This module contains some basic customization options for Orange 
  • orange/Orange/misc/r.py

    r8010 r8021  
    11""" 
    2 =============== 
    3 R compatibility 
    4 =============== 
     2======================= 
     3R compatibility (``r``) 
     4======================= 
    55 
    66.. index:: R 
  • orange/Orange/misc/render.py

    r8010 r8021  
    11""" 
    2 ================== 
    3 Render 
    4 ================== 
     2=================== 
     3Render (``render``) 
     4=================== 
    55 
    66.. index:: misc 
  • orange/Orange/misc/selection.py

    r8010 r8021  
    11""" 
    2 ================== 
    3 Selection 
    4 ================== 
     2========================= 
     3Selection (``selection``) 
     4========================= 
    55 
    66.. index:: selection 
  • orange/Orange/misc/serverfiles.py

    r8010 r8021  
    11""" 
    2 ================== 
    3 Server files 
    4 ================== 
     2============================== 
     3Server files (``serverfiles``) 
     4============================== 
    55 
    66.. index:: server files 
  • orange/Orange/projection/linear.py

    r7908 r8021  
    11''' 
     2############################## 
     3Linear projection (``linear``) 
     4############################## 
     5 
    26.. index:: linear projection 
    37 
     
    59   single: projection; linear 
    610 
    7 The functionality to perform linear projection of the data. 
    8  
    9 In particular, this module contains the FreeViz algorithm 
     11This module contains the FreeViz algorithm 
    1012`(Demsar et al, 2005) <http://www.ailab.si/idamap/idamap2005/papers/12%20Demsar%20CR.pdf>`_ 
    1113[1], which finds a good two-dimensional projection of the given data, where the 
  • orange/Orange/projection/mds.py

    r7825 r8021  
    55   single: projection; multidimensional scaling (mds) 
    66 
     7********************************** 
     8Multidimensional scaling (``mds``) 
     9********************************** 
     10 
    711The functionality to perform multidimensional scaling 
    812(http://en.wikipedia.org/wiki/Multidimensional_scaling). 
    9  
    10 ************************ 
    11 Multidimensional scaling 
    12 ************************ 
    1313 
    1414The main class to perform multidimensional scaling is 
     
    4040This module provides the following stress functions: 
    4141 
    42    * Orange.projection.mds.SgnRelStress 
    43    * Orange.projection.mds.KruskalStress 
    44    * Orange.projection.mds.SammonStress 
    45    * Orange.projection.mds.SgnSammonStress 
    46  
    47 Usage examples 
    48 ============== 
     42   * :obj:`SgnRelStress` 
     43   * :obj:`KruskalStress` 
     44   * :obj:`SammonStress` 
     45   * :obj:`SgnSammonStress` 
     46 
     47Examples 
     48======== 
    4949 
    5050MDS Scatterplot 
    5151--------------- 
    5252 
    53 The following script computes the Euclidean distance between the data instances 
    54 of the iris dataset and runs MDS on a distance matrix. Coordinates computed 
    55 with MDS are plotted using matplotlib (not included with orange,  
    56 http://matplotlib.sourceforge.net/). 
     53The following script computes the Euclidean distance between the data 
     54instances and runs MDS. Final coordinates are plotted with matplotlib 
     55(not included with orange, http://matplotlib.sourceforge.net/). 
    5756 
    5857Example (`mds-scatterplot.py`_, uses `iris.tab`_) 
     
    6463.. _iris.tab: code/iris.tab 
    6564 
    66 The script produces a file named *mds-scatterplot.py.png*. Color denotes 
    67 point's class. Iris is a relatively simple data set with respect to 
     65The script produces a file *mds-scatterplot.py.png*. Color denotes 
     66the class. Iris is a relatively simple data set with respect to 
    6867classification; to no surprise we see that MDS finds such instance 
    6968placement in 2D where instances of different classes are well separated. 
     
    7170 
    7271.. image:: files/mds-scatterplot.png 
    73  
    7472 
    7573 
  • orange/Orange/projection/som.py

    r7427 r8021  
    11""" 
     2************************** 
     3Self-organizing maps (``som``) 
     4************************** 
    25 
    36.. index:: self-organizing map (SOM) 
  • orange/doc/Orange/rst/Orange.data.domain.rst

    r7686 r8021  
    11.. py:currentmodule:: Orange.data 
    22 
    3 ================== 
    4 Domain description 
    5 ================== 
     3=============================== 
     4Domain description (``Domain``) 
     5=============================== 
    66 
    77In Orange, the term `domain` denotes a set of features, which will be 
  • orange/doc/Orange/rst/Orange.data.instance.rst

    r7820 r8021  
    11.. py:currentmodule:: Orange.data 
    22 
    3 ============== 
    4 Data instances 
    5 ============== 
     3============================= 
     4Data instances (``Instance``) 
     5============================= 
    66 
    77Class `Orange.data.Instance` holds data instances. Each data instance 
  • orange/doc/Orange/rst/Orange.data.sample.rst

    r7895 r8021  
    1 ========================= 
    2 Sampling of examples 
    3 ========================= 
    4  
    51.. automodule:: Orange.data.sample 
  • orange/doc/Orange/rst/Orange.data.table.rst

    r7980 r8021  
    11.. py:currentmodule:: Orange.data 
    22 
    3 ========== 
    4 Data table 
    5 ========== 
     3====================== 
     4Data table (``Table``) 
     5====================== 
    66 
    77Class `Orange.data.Table` holds a list of data instances of type 
  • orange/doc/Orange/rst/Orange.data.value.rst

    r7795 r8021  
    11.. py:currentmodule:: Orange.data 
    22 
    3 ====== 
    4 Values 
    5 ====== 
     3================== 
     4Values (``Value``) 
     5================== 
    66 
    77.. class:: Value 
  • orange/doc/Orange/rst/Orange.evaluation.reliability.rst

    r7924 r8021  
    1 ============================= 
    2 Orange.evaluation.reliability 
    3 ============================= 
    4  
    51.. automodule:: Orange.evaluation.reliability 
  • orange/doc/Orange/rst/Orange.evaluation.scoring.rst

    r7396 r8021  
    1 ========================= 
    2 Orange.evaluation.scoring 
    3 ========================= 
    4  
    51.. automodule:: Orange.evaluation.scoring 
  • orange/doc/Orange/rst/Orange.evaluation.testing.rst

    r7413 r8021  
    1 ========================= 
    2 Orange.evaluation.testing 
    3 ========================= 
    4  
    51.. automodule:: Orange.evaluation.testing 
  • orange/doc/Orange/rst/Orange.projection.linear.rst

    r7905 r8021  
    1 ======================== 
    2 Orange.projection.linear 
    3 ======================== 
    4  
    51.. automodule:: Orange.projection.linear 
  • orange/doc/Orange/rst/Orange.projection.mds.rst

    r7493 r8021  
    1 ===================== 
    2 Orange.projection.mds 
    3 ===================== 
    4  
    51.. automodule:: Orange.projection.mds 
  • orange/doc/Orange/rst/Orange.projection.rst

    r7905 r8021  
    44 
    55.. toctree:: 
    6    :maxdepth: 1 
     6   :maxdepth: 2 
    77 
    88   Orange.projection.linear 
  • orange/doc/Orange/rst/orange.data.feature.rst

    r7686 r8021  
    1 ========= 
    2 Variables 
    3 ========= 
    4  
    51.. automodule:: Orange.data.variable 
  • orange/doc/Orange/rst/orange.projection.som.rst

    r7246 r8021  
    1 ===================== 
    2 orange.projection.som 
    3 ===================== 
    4  
    51.. automodule:: Orange.projection.som 
Note: See TracChangeset for help on using the changeset viewer.