romcomma.base.classes.Model§

class Model(folder, read_data=False, **kwargs)[source]§

Bases: ABC

Abstract base class for any model. This base class implements generic file storage and parameter handling. The latter is dealt with by each subclass overriding Data.NamedTuple with its own NamedTuple[NamedTuple] defining the parameter set it takes. model.data.values is a Model.Data.NamedTuple of NP.Matrices.

A Model also may include a calibrate method taking meta stored in an meta.json file, which default to cls.META.

Parameters:

  • folder (Path | str) –

  • read_data (bool) –

  • kwargs (NP.Matrix) –

abstract __init__(folder, read_data=False, **kwargs)[source]§

Model constructor, to be called by all subclasses as a matter of priority.

Parameters:

  • folder (Path | str) – The model file location.

  • read_data (bool) – If True, the model.data are read from folder, otherwise defaults are used.

  • **kwargs (ndarray) – The model.data fields=values to replace after reading from file/defaults.

Methods

__init__(folder[, read_data])

Model constructor, to be called by all subclasses as a matter of priority.

calibrate(method, **kwargs)

read_meta()

write_meta(meta)

Attributes

META

data

folder

class Data(folder, **kwargs)[source]§

Bases: Data

This is a placeholder which must be overridden in any implementation.

Parameters:

  • folder (Path | str) –

  • kwargs (Data.Matrix) –

class NamedTuple(NotImplemented=array([['NotImplemented']], dtype='<U14'))[source]§

Bases: NamedTuple

A NamedTuple of data. Must be overridden.

Parameters:

NotImplemented (Frame | DataFrame | ndarray | Tensor) –

NotImplemented: Frame | DataFrame | ndarray | Tensor§

NamedTuple can have any number of members.

count(value, /)§

Return number of occurrences of value.

index(value, start=0, stop=9223372036854775807, /)§

Return first index of value.

Raises ValueError if the value is not present.

static copy(src_folder, dst_folder)§

Returns a copy of src_folder at dst_folder, deleting anything existing at the destination.

Parameters:

  • src_folder (Path | str) –

  • dst_folder (Path | str) –

Return type:

Path

static delete(folder)§

Returns a non-existent folder.

Parameters:

folder (Path | str) –

Return type:

Path

static empty(folder)§

Returns an empty folder.

Parameters:

folder (Path | str) –

Return type:

Path

move(dst_folder)§

Move self to dst_folder.

Parameters:

dst_folder (Path | str) – The folder to move to. If this exists, it will be emptied.

Return type:

Data

Returns: self for chaining calls.

classmethod read(folder, **kwargs)§

Read Data from folder.

Parameters:

  • folder (Path | str) – The folder to record the data. Must exist

  • **kwargs (Frame | DataFrame | ndarray | Tensor) – key=ordinate initial pairs of NamedTuple fields, precisely as in NamedTuple(**kwargs). Missing fields receive their defaults, so Data(folder) is the default Data.

Return type:

Data

Returns: The Data stored in folder.

class property META: Dict[str, Any]§

Default meta data.

Type:

Returns