Referencia de la Clase vsm.viewer.beagleviewer.BeagleViewer

Diagrama de herencias de vsm.viewer.beagleviewer.BeagleViewer

Diagrama de colaboración para vsm.viewer.beagleviewer.BeagleViewer:

Métodos públicos
def	__init__
def	dist_word_word
def	sim_word_word
def	simmat_word
def	dismat_word

Atributos públicos
	corpus
	model

Descripción detallada

A class for viewing BEAGLE models.

Documentación del constructor y destructor

def vsm.viewer.beagleviewer.BeagleViewer.__init__	(		self,
			corpus,
			model
	)

Initialize BeagleViewer.

:param corpus: Source of observed data.
:type corpus: :class:`Corpus`
    
:param model: One of the Beagle objects.
:type model: BEAGLE model

Documentación de las funciones miembro

def vsm.viewer.beagleviewer.BeagleViewer.dismat_word	(		self,
			word_list,
			dist_fn = angle
	)

Calculates a distance matrix for a given list of words.

:param word_list: A list of words whose distance matrix is to be
    computed.
:type word_list: list of strings

:param dist_fn: A distance function from functions in vsm.spatial. 
    Default is :meth:`angle`.
:type dist_fn: string, optional

:returns: an instance of :class:`IndexedSymmArray`.
    A n x n matrix containing floats where n is the number of words
    in `word_list`.

:See Also: :meth:`vsm.viewer.wrappers.dismat_word`

def vsm.viewer.beagleviewer.BeagleViewer.dist_word_word	(		self,
			word_or_words,
			weights = [],
			filter_nan = True,
			print_len = 10,
			as_strings = True,
			dist_fn = angle,
			order = 'i'
	)

Computes and sorts the distances between word(s) and every word.

:param word_or_words: Query word(s) to which distances are calculated.
:type word_or_words: string or list of strings

:param weights: Specify weights for each query word in `word_or_words`. 
    Default uses equal weights (i.e. arithmetic mean)
:type weights: list of floating point, optional

:param filter_nan: If `True` not a number entries are filtered.
    Default is `True`.
:type filter_nan: boolean, optional

:param print_len: Number of words to be displayed. Default is 10.
:type print_len: int, optional

:param as_strings: If `True`, returns a list of words as strings rather
    than their integer representations. Default is `True`.
:type as_strings: boolean, optional

:param dist_fn: A distance function from functions in vsm.spatial. 
    Default is :meth:`angle`.
:type dist_fn: string, optional

:param order: Order of sorting. 'i' for increasing and 'd' for
    decreasing order. Default is 'i'.
:type order: string, optional

:returns: an instance of :class:`LabeledColumn`.
    A 2-dim array containing words and their distances to 
    `word_or_words`. 

:See Also: :meth:`vsm.viewer.wrappers.dist_word_word`

---

La documentación para esta clase fue generada a partir del siguiente fichero:

• vsm/vsm/viewer/beagleviewer.py