moscot.backends.ott.SinkhornSolver.__call__

SinkhornSolver.__call__(xy=None, x=None, y=None, tags=mappingproxy({}), device=None, **kwargs)

Solve an optimal transport problem.

Parameters:

• xy (Union[TaggedArray, ndarray[Any, dtype[float64]], Tuple[ndarray[Any, dtype[float64]], ndarray[Any, dtype[float64]]], None]) – Data that defines the linear term.

• x (Union[TaggedArray, ndarray[Any, dtype[float64]], None]) – Data of the first geometry that defines the quadratic term.

• y (Union[TaggedArray, ndarray[Any, dtype[float64]], None]) – Data of the second geometry that defines the quadratic term.

• tags (Mapping[Literal['xy', 'x', 'y'], Tag]) – How to interpret the data in xy, x and y.

• device (Union[Literal['cpu', 'gpu', 'tpu'], str, None]) – Device to transfer the output to, see to().

• kwargs (Any) – Keyword arguments for parent’s __call__().

Return type:

TypeVar(O, bound= BaseSolverOutput)

Returns:

: The optimal transport solution.