Ignore:
Timestamp:
02/28/12 19:25:51 (2 years ago)
Author:
Lan Zagar <lan.zagar@…>
Branch:
default
Message:

Fixed object addresses appearing in documentation (#1103).

File:
1 edited

Legend:

Unmodified
Added
Removed
  • Orange/clustering/kmeans.py

    r9994 r10393  
    99 
    1010 
    11 .. autoclass:: Orange.clustering.kmeans.Clustering 
    12    :members: 
     11.. autoclass:: Orange.clustering.kmeans.Clustering(data=None, centroids=3, maxiters=None, minscorechange=None, stopchanges=0, nstart=1, initialization=init_random, distance=Orange.distance.Euclidean, scoring=score_distance_to_centroids, inner_callback=None, outer_callback=None) 
     12    :members: 
     13    :exclude-members: __init__ 
     14 
     15    .. automethod:: __init__(data=None, centroids=3, maxiters=None, minscorechange=None, stopchanges=0, nstart=1, initialization=init_random, distance=Orange.distance.Euclidean, scoring=score_distance_to_centroids, inner_callback=None, outer_callback=None) 
     16 
    1317 
    1418Examples 
     
    394398                 stopchanges=0, nstart=1, initialization=init_random, 
    395399                 distance=Orange.distance.Euclidean, 
    396                  scoring=score_distance_to_centroids, inner_callback = None, 
    397                  outer_callback = None): 
    398         """ 
    399         :param data: Data instances to be clustered. If not None, clustering will be executed immediately after initialization unless initialize_only=True. 
    400         :type data: :class:`orange.ExampleTable` or None 
     400                 scoring=score_distance_to_centroids, inner_callback=None, 
     401                 outer_callback=None): 
     402        """ 
     403        :param data: Data instances to be clustered. If not None, clustering will be executed immediately after initialization unless ``initialize_only=True``. 
     404        :type data: :class:`~Orange.data.Table` or None 
    401405        :param centroids: either specify a number of clusters or provide a list of examples that will serve as clustering centroids. 
    402         :type centroids: integer or a list of :class:`orange.Example` 
     406        :type centroids: :obj:`int` or :obj:`list` of :class:`~Orange.data.Instance` 
    403407        :param nstart: If greater than one, nstart runs of the clustering algorithm will be executed, returning the clustering with the best (lowest) score. 
    404         :type nstart: integer 
     408        :type nstart: int 
    405409        :param distance: an example distance constructor, which measures the distance between two instances. 
    406         :type distance: :class:`Orange.distance.DistanceConstructor` 
    407         :param initialization: a function to select centroids given data instances, k and a example distance function. This module implements different approaches (:func:`init_random`, :func:`init_diversity`, :class:`init_hclustering`).  
     410        :type distance: :class:`~Orange.distance.DistanceConstructor` 
     411        :param initialization: a function to select centroids given data instances, k and a example distance function. This module implements different approaches (:obj:`init_random`, :obj:`init_diversity`, :obj:`init_hclustering`).  
    408412        :param scoring: a function that takes clustering object and returns the clustering score. It could be used, for instance, in procedure that repeats the clustering nstart times, returning the clustering with the lowest score. 
    409413        :param inner_callback: invoked after every clustering iteration. 
Note: See TracChangeset for help on using the changeset viewer.