ivis.models.base

Classes

BaseModel()

Abstract base class for IViS-compatible imaging models.

class ivis.models.base.BaseModel[source]

Bases: ABC

Abstract base class for IViS-compatible imaging models. All models must implement loss() and forward().

abstract loss(x, *args)[source]

Compute scalar loss and gradient for optimization.

Parameters:

x (np.ndarray) – Flattened parameter vector.

Return type:

tuple[float, ndarray]

Returns:

  • loss (float) – Scalar loss.

  • grad (np.ndarray) – Flattened gradient.