gemmr.metrics.mk_weightError

gemmr.metrics.mk_weightError(ds, suffix='', prefix='')

Evaluate the weight error.

Weight error is the maximum cosine-distance between estimated and true weights across datasets \(X\) and \(Y\).

Parameters:

  • ds (xr.Dataset) – outcome dataset

  • suffix (str) – the calculation is based on the outcome metric 'x/y_weights_true_cossim' + suffix

  • prefix (str) – will be prepended to the name of the property when looking it up in ds

Returns:

metric – evaluated metric

Return type:

xr.DataArray