Referencia de la Clase vsm.model.base.BaseModel

Diagrama de herencias de vsm.model.base.BaseModel

Diagrama de colaboración para vsm.model.base.BaseModel:

Métodos públicos
def	__init__
def	save

Métodos públicos estáticos
def	load

Atributos públicos
	matrix
	context_type

Descripción detallada

Base class for models which store data in a single matrix.

:param matrix: A two-dimensional numpy array storing the results
    of model training. Default is `None`.
:type matrix: numpy.ndarray, optional

:param context_type: A string specifying the type of context over
    which the model trainer is applied. Default is `None`.
:type context_type: string, optional

:attributes:
    Same as parameters.

:methods:
    * **save**
        Takes a filename or file object and saves `self.matrix` 
        in an npz archive.
    * **load**
        Takes a filename or file object and loads it as an npz
        archive into a BaseModel object.

:See Also: :meth:`numpy.savez`, :meth:`numpy.load`

Documentación de las funciones miembro

def vsm.model.base.BaseModel.load (   f )

static

Takes a filename or file object and loads it as an npz archive
into a BaseModel object.

:param file: Designates the file to read. If `file` is a string
    ending in `.gz`, the file is first gunzipped. See `numpy.load`
    for further details.
:type file: str-like or file-like object

:returns: A dictionary storing the data found in `file`.

:See Also: :meth:`numpy.load`

def vsm.model.base.BaseModel.save	(		self,
			f
	)

Takes a filename or file object and saves `self.matrix` in an
npz archive.

:param file: Designates the file to which to save data. See
    `numpy.savez` for further details.
:type file: str-like or file-like object
    
:returns: `None`

:See Also: :meth:`numpy.savez`

---

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

• vsm/vsm/model/base.py