Referencia de la Clase vsm.viewer.tfidfviewer.TfIdfViewer

Diagrama de herencias de vsm.viewer.tfidfviewer.TfIdfViewer

Diagrama de colaboración para vsm.viewer.tfidfviewer.TfIdfViewer:

Métodos públicos
def	__init__
def	sim_word_word
def	dist_word_word
def	sim_doc_doc
def	dist_doc_doc
def	sim_word_doc
def	dist_word_doc
def	simmat_words
def	dismat_word
def	simmat_docs
def	dismat_doc

Atributos públicos
	corpus
	model

Descripción detallada

A class for viewing Term frequency-Inverse document Frequency model.

Documentación del constructor y destructor

def vsm.viewer.tfidfviewer.TfIdfViewer.__init__	(		self,
			corpus,
			model
	)

Initialize TfIdfViewer.

:param corpus: Source of observed data.
:type corpus: :class:`Corpus`

:param model: A Term frequency-Inverse document Frequency model.
:type model: TfIdf.

Documentación de las funciones miembro

def vsm.viewer.tfidfviewer.TfIdfViewer.dismat_doc	(		self,
			doc_list,
			dist_fn = angle_sparse
	)

Calculates a distance matrix for a given list of documents.

:param doc_list: A list of documents whose distance matrix is 
    to be computed.
:type doc_list: list

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

:returns: an instance of :class:`IndexedSymmArray`.
    n x n matrix containing floats where n is the number of 
    documents.

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

def vsm.viewer.tfidfviewer.TfIdfViewer.dismat_word	(		self,
			word_list,
			dist_fn = angle_sparse
	)

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

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

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

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

def vsm.viewer.tfidfviewer.TfIdfViewer.dist_doc_doc	(		self,
			doc_or_docs,
			weights = [],
			print_len = 10,
			filter_nan = True,
			label_fn = def_label_fn,
			as_strings = True,
			dist_fn = angle_sparse,
			order = 'i'
	)

Computes and sorts the distances between a document or list
of documents and every document.

:param doc_or_docs: Query document(s) to which distances
    are calculated.
:type doc_or_docs: string/integer or list of strings/integers

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

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

:param filter_nan: If `True` not a number entries are filtered.
    Default is `True`.
:type filter_nan: boolean, optional
 
:param label_fn: A function that defines how documents are represented.
    Default is def_label_fn which retrieves the labels from corpus
    metadata.
:type label_fn: string, optional

:param as_strings: If `True`, returns a list of words 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_sparse`.
: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 documents and their cosine values to 
    `doc_or_docs`. 

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

def vsm.viewer.tfidfviewer.TfIdfViewer.dist_word_doc	(		self,
			word_or_words,
			weights = [],
			label_fn = def_label_fn,
			filter_nan = True,
			print_len = 10,
			as_strings = True,
			dist_fn = angle_sparse,
			order = 'i'
	)

Computes and sorts distances between a word or a list of words to every
document.

:param word_or_words: Query word(s) to which a pseudo-document is
    created for computation of distances.
:type word_or_words: string/integer or list of strings/integers

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

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

:param filter_nan: If `True` not a number entries are filtered.
    Default is `True`.
:type filter_nan: boolean, optional
 
:param label_fn: A function that defines how documents are represented.
    Default is :meth:`def_label_fn` which retrieves the labels 
    from corpus metadata.
:type label_fn: string, optional

:param as_strings: If `True`, returns a list of documents as strings
    rather than indices. Default is `True`.
:type as_strings: boolean, optional

:param dist_fn: A distance function from functions in vsm.spatial.
    Default is :meth:`angle_sparse`.
: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 documents and their distances to 
    `word_or_words`. 

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

def vsm.viewer.tfidfviewer.TfIdfViewer.dist_word_word	(		self,
			word_or_words,
			weights = [],
			filter_nan = True,
			print_len = 10,
			as_strings = True,
			dist_fn = angle_sparse,
			order = 'i'
	)

Computes and sorts the distances between a word or list
of words 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_sparse`.
: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 cosine values 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/tfidfviewer.py