ott.core.sinkhorn.SinkhornOutput#

class ott.core.sinkhorn.SinkhornOutput(f=None, g=None, errors=None, reg_ot_cost=None, ot_prob=None)[source]#

Implements the problems.Transport interface, for a Sinkhorn solution.

Methods

apply(inputs[, axis])

Apply the transport to a ndarray; axis=1 for its transpose.

cost_at_geom(other_geom)

Return reg-OT cost for matrix, evaluated at other cost matrix.

count(value, /)

Return number of occurrences of value.

index(value[, start, stop])

Return first index of value.

marginal(axis)

rtype

ndarray

set(**kwargs)

Return a copy of self, with potential overwrites.

set_cost(ot_prob, lse_mode, use_danskin)

rtype

SinkhornOutput

transport_mass()

Sum of transport matrix.

Attributes

a

rtype

ndarray

b

rtype

ndarray

converged

rtype

bool

errors

Alias for field number 2

f

Alias for field number 0

g

Alias for field number 1

geom

rtype

Geometry

linear

rtype

bool

linear_output

rtype

bool

matrix

Transport matrix if it can be instantiated.

ot_prob

Alias for field number 4

reg_ot_cost

Alias for field number 3

scalings

rtype

Tuple[ndarray, ndarray]

Parameters