ott.solvers.linear.continuous_barycenter.BarycenterState#

class ott.solvers.linear.continuous_barycenter.BarycenterState(costs=None, linear_convergence=None, errors=None, x=None, a=None)[source]#

Holds the state of the Wasserstein barycenter solver.

Parameters

  • costs (Optional[jax.Array]) – Holds the sequence of regularized GW costs seen through the outer loop of the solver.

  • linear_convergence (Optional[jax.Array]) – Holds the sequence of bool convergence flags of the inner Sinkhorn iterations.

  • errors (Optional[jax.Array]) – Holds sequence of vectors of errors of the Sinkhorn algorithm at each iteration.

  • x (Optional[jax.Array]) – barycenter points.

  • a (Optional[jax.Array]) – barycenter weights.

Methods

count(value, /)

Return number of occurrences of value.

index(value[, start, stop])

Return first index of value.

set(**kwargs)

Return a copy of self, possibly with overwrites.

update(iteration, bar_prob, ...)

rtype

BarycenterState

Attributes

a

Alias for field number 4

costs

Alias for field number 0

errors

Alias for field number 2

linear_convergence

Alias for field number 1

x

Alias for field number 3