mendevi.models.base

Unify all the models with a common sctucture.

Classes

Model([title])

Common structure to all models.

Details

class mendevi.models.base.Model(title: str | None = None, **kwargs)

Common structure to all models.

Attributes

citestr

The latex bibtext model citation.

parameterstorch.Tensor | None

The trainable parameters of the model (read and write).

input_labelslist[str]

The name of all input parameters (readonly).

output_labelslist[str]

The name of all output parameters (readonly).

Initialise the model.

Parameters

titlestr, optional

The model title.

sourcesstr

All sources for the model, the conference paper, the authors, etc.

input_labelslist[str]

The name of all input parameters. The possibles values are :py:cst:`mendevi.plot.axis.Name`.

output_labelslist[str]

The name of all output parameters. The possibles values are :py:cst:`mendevi.plot.axis.Name`.

parameterstorch.Tensor, optional

The learnable parameters for regressive models.