function vamp_score

deeptime.decomposition.deep.vamp_score(data: Tensor, data_lagged: Tensor, method='VAMP2', epsilon: float = 1e-06, mode='trunc')

Computes the VAMP score based on data and corresponding time-shifted data.

Parameters:

  • data (torch.Tensor) – (N, d)-dimensional torch tensor

  • data_lagged (torch.Tensor) – (N, k)-dimensional torch tensor

  • method (str, default='VAMP2') – The scoring method. See score for details.

  • epsilon (float, default=1e-6) – Cutoff parameter for small eigenvalues, alternatively regularization parameter.

  • mode (str, default='trunc') – Regularization mode for Hermetian inverse. See sym_inverse().

Returns:

score – The score. It contains a contribution of \(+1\) for the constant singular function since the internally estimated Koopman operator is defined on a decorrelated basis set.

Return type:

torch.Tensor