ott.tools.progot.ProgOTOutput

Contents

ott.tools.progot.ProgOTOutput#

class ott.tools.progot.ProgOTOutput(prob, alphas, epsilons, outputs, xs=None)[source]#

Output of the ProgOT solver.

Parameters:
  • prob (LinearProblem) – Linear problem.

  • alphas (Array) – Stepsize schedule of shape [num_steps,].

  • epsilons (Array) – Entropy regularizations of shape [num_steps,].

  • outputs (SinkhornOutput | SinkhornDivergenceOutput) – OT solver outputs for every step, a struct of arrays.

  • xs (Array | None) – Intermediate interpolations of shape [num_steps, n, d], if present.

Methods

count(value, /)

Return number of occurrences of value.

get_output(step)

Get the OT solver output at a given step.

index(value[, start, stop])

Return first index of value.

transport(x[, num_steps, return_intermediate])

Transport points.

Attributes

alphas

Alias for field number 1

converged

Convergence at each step.

epsilons

Alias for field number 2

is_debiased

Whether the OT solver is debiased.

num_iters

Number of Sinkhorn iterations within each step.

num_steps

Number of ProgOT steps.

outputs

Alias for field number 3

prob

Alias for field number 0

xs

Alias for field number 4