pythonot.github.io/master/_modules/ot/utils.html at master · PythonOT/pythonot.github.io

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

<!DOCTYPE html>

<head>

<title>ot.utils — POT Python Optimal Transport 0.9.8.dev documentation</title>

</head>

POT Python Optimal Transport

</a>

</form>

</div>

</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">

<ul>

<li class="toctree-l1"><a class="reference internal" href="../../index.html">POT: Python Optimal Transport</a></li>

<li class="toctree-l1"><a class="reference internal" href="../../auto_examples/plot_quickstart_guide.html">Quickstart Guide</a></li>

<li class="toctree-l1"><a class="reference internal" href="../../auto_examples/index.html">Examples gallery</a></li>

<li class="toctree-l1"><a class="reference internal" href="../../user_guide.html">User guide</a></li>

<li class="toctree-l1"><a class="reference internal" href="../../all.html">API and modules</a></li>

<li class="toctree-l1"><a class="reference internal" href="../../releases.html">Releases</a></li>

<li class="toctree-l1"><a class="reference internal" href="../../contributors.html">Contributors</a></li>

<li class="toctree-l1"><a class="reference internal" href="../../contributing.html">Contributing to POT</a></li>

<li class="toctree-l1"><a class="reference internal" href="../../code_of_conduct.html">Code of conduct</a></li>

</ul>

</div>

</nav>

<a href="../../index.html">POT Python Optimal Transport</a>

</nav>

<li class="breadcrumb-item"><a href="../index.html">Module code</a></li>

<li class="breadcrumb-item active">ot.utils</li>

</li>

</ul>

<hr/>

</div>

<h1>Source code for ot.utils</h1><div class="highlight"><pre>

# -*- coding: utf-8 -*-

"""

Various useful functions

"""

# Author: Remi Flamary <remi.flamary@unice.fr>

#

# License: MIT License

from functools import reduce

import time

import numpy as np

from scipy.spatial.distance import cdist

import sys

import warnings

from inspect import signature

from .backend import get_backend, Backend, NumpyBackend, JaxBackend

__time_tic_toc = time.perf_counter()

def tic():

r"""Python implementation of Matlab tic() function"""

global __time_tic_toc

__time_tic_toc = time.perf_counter()</div>

def toc(message="Elapsed time : {} s"):

r"""Python implementation of Matlab toc() function"""

t = time.perf_counter()

print(message.format(t - __time_tic_toc))

return t - __time_tic_toc</div>

def toq():

r"""Python implementation of Julia toc() function"""

t = time.perf_counter()

return t - __time_tic_toc</div>

def kernel(x1, x2, method="gaussian", sigma=1, **kwargs):

r"""Compute kernel matrix"""

nx = get_backend(x1, x2)

if method.lower() in ["gaussian", "gauss", "rbf"]:

K = nx.exp(-dist(x1, x2) / (2 * sigma**2))

return K</div>

def laplacian(x):

r"""Compute Laplacian matrix"""

nx = get_backend(x)

L = nx.diag(nx.sum(x, axis=0)) - x

return L</div>

def list_to_array(*lst, nx=None):

r"""Convert a list if in numpy format"""

# Filter to non-empty, non-list items (handle sparse matrices gracefully)

lst_not_empty = []

for a in lst:

if isinstance(a, list):

continue

try:

if len(a) > 0:

lst_not_empty.append(a)

except TypeError:

# Sparse matrices don't support len(), but they're not empty

lst_not_empty.append(a)

if nx is None: # find backend

if len(lst_not_empty) == 0:

type_as = np.zeros(0)

nx = get_backend(type_as)

else:

nx = get_backend(*lst_not_empty)

type_as = lst_not_empty[0]

else:

type_as = None

else:

type_as = lst_not_empty[0]

if len(lst) > 1:

return [

nx.from_numpy(np.array(a), type_as=type_as) if isinstance(a, list) else a

for a in lst

]

else:

if isinstance(lst[0], list):

return nx.from_numpy(np.array(lst[0]), type_as=type_as)

else:

return lst[0]</div>

def proj_simplex(v, z=1):

r"""Compute the closest point (orthogonal projection) on the

generalized `(n-1)`-simplex of a vector :math:`\mathbf{v}` wrt. to the Euclidean

distance, thus solving:

.. math::

\mathcal{P}(w) \in \mathop{\arg \min}_\gamma \| \gamma - \mathbf{v} \|_2

s.t. \ \gamma^T \mathbf{1} = z

\gamma \geq 0

If :math:`\mathbf{v}` is a 2d array, compute all the projections wrt. axis 0

.. note:: This function is backend-compatible and will work on arrays

from all compatible backends.

Parameters

----------

v : {array-like}, shape (n, d)

z : int, optional

'size' of the simplex (each vectors sum to z, 1 by default)

Returns

-------

h : ndarray, shape (`n`, `d`)

Array of projections on the simplex

"""

nx = get_backend(v)

n = v.shape[0]

if v.ndim == 1:

d1 = 1

v = v[:, None]

else:

d1 = 0

d = v.shape[1]

# sort u in ascending order

u = nx.sort(v, axis=0)

# take the descending order

u = nx.flip(u, 0)

cssv = nx.cumsum(u, axis=0) - z

ind = nx.arange(n, type_as=v)[:, None] + 1

cond = u - cssv / ind > 0

rho = nx.sum(cond, 0)

theta = cssv[rho - 1, nx.arange(d)] / rho

w = nx.maximum(v - theta[None, :], nx.zeros(v.shape, type_as=v))

if d1:

return w[:, 0]

else:

return w</div>

def projection_sparse_simplex(V, max_nz, z=1, axis=None, nx=None):

r"""Projection of :math:`\mathbf{V}` onto the simplex with cardinality constraint (maximum number of non-zero elements) and then scaled by `z`.

.. math::

P\left(\mathbf{V}, \text{max_nz}, z\right) = \mathop{\arg \min}_{\substack{\mathbf{y} >= 0 \\ \sum_i \mathbf{y}_i = z} \\ ||p||_0 \le \text{max_nz}} \quad \|\mathbf{y} - \mathbf{V}\|^2

Parameters

----------

V: 1-dim or 2-dim ndarray

max_nz: int

Maximum number of non-zero elements in the projection.

If `max_nz` is larger than the number of elements in `V`, then

the projection is equivalent to `proj_simplex(V, z)`.

z: float or array

If array, len(z) must be compatible with :math:`\mathbf{V}`

axis: None or int

- axis=None: project :math:`\mathbf{V}` by :math:`P(\mathbf{V}.\mathrm{ravel}(), \text{max_nz}, z)`

- axis=1: project each :math:`\mathbf{V}_i` by :math:`P(\mathbf{V}_i, \text{max_nz}, z_i)`

- axis=0: project each :math:`\mathbf{V}_{:, j}` by :math:`P(\mathbf{V}_{:, j}, \text{max_nz}, z_j)`

Returns

-------

projection: ndarray, shape :math:`\mathbf{V}`.shape

References

----------

.. [1] Sparse projections onto the simplex

Anastasios Kyrillidis, Stephen Becker, Volkan Cevher and, Christoph Koch

ICML 2013

https://arxiv.org/abs/1206.1529

"""

if nx is None:

nx = get_backend(V)

if V.ndim == 1:

return projection_sparse_simplex(

# V[nx.newaxis, :], max_nz, z, axis=1).ravel()

V[None, :],

max_nz,

z,

axis=1,

).ravel()

if V.ndim > 2:

raise ValueError("V.ndim must be <= 2")

if axis == 1:

# For each row of V, find top max_nz values; arrange the

# corresponding column indices such that their values are

# in a descending order.

max_nz_indices = nx.argsort(V, axis=1)[:, -max_nz:]

max_nz_indices = nx.flip(max_nz_indices, axis=1)

row_indices = nx.arange(V.shape[0], type_as=max_nz_indices)

row_indices = row_indices.reshape(-1, 1)

# Extract the top max_nz values for each row

# and then project to simplex.

U = V[row_indices, max_nz_indices]

z = nx.ones(len(U), type_as=U) * z

cssv = nx.cumsum(U, axis=1) - z[:, None]

ind = nx.arange(max_nz, type_as=max_nz_indices) + 1

cond = U - cssv / ind > 0

# rho = nx.count_nonzero(cond, axis=1)

theta = cssv[nx.arange(len(U), type_as=rho), rho - 1] / rho

nz_projection = nx.maximum(U - theta[:, None], 0)

# Put the projection of max_nz_values to their original column indices

# while keeping other values zero.

sparse_projection = nx.zeros(V.shape, type_as=nz_projection)

if isinstance(nx, JaxBackend):

# in Jax, we need to use the `at` property of `jax.numpy.ndarray`

# to do in-place array modifications.

sparse_projection = sparse_projection.at[row_indices, max_nz_indices].set(

nz_projection

)

else:

sparse_projection[row_indices, max_nz_indices] = nz_projection

return sparse_projection

elif axis == 0:

return projection_sparse_simplex(V.T, max_nz, z, axis=1).T

else:

V = V.ravel().reshape(1, -1)

return projection_sparse_simplex(V, max_nz, z, axis=1).ravel()</div>

def unif(shape, type_as=None):

r"""

Return a uniform histogram normalized over its last dimension (simplex).

Parameters

----------

shape : int or tuple of int

Number of bins in the histogram, or the full output shape. An integer

``n`` is equivalent to ``(n,)``. For a shape ``(..., n)`` the output is

normalized over the last dimension, e.g. ``(B, n)`` returns ``B``

uniform histograms of length ``n``.

type_as : array-like

array of the same type of the expected output (numpy/pytorch/jax)

Returns

-------

h : array-like, shape ``shape``

uniform histogram(s) such that each slice along the last dimension sums

to one, i.e. every entry equals :math:`\frac{1}{n}` with ``n`` the last

dimension.

"""

size = (int(shape),) if isinstance(shape, (int, np.integer)) else tuple(shape)

n = size[-1]

if type_as is None:

return np.ones(size) / n

else:

nx = get_backend(type_as)

return nx.ones(size, type_as=type_as) / n</div>

def check_marginal(a, shape, type_as=None, nx=None):

r"""Validate or fill a marginal :math:`\mathbf{a}` against an expected shape.

When ``a`` is ``None`` it is filled with the uniform marginal of the given

``shape`` on the backend, device and dtype of ``type_as`` (via :func:`unif`).

When provided, its shape is checked against ``shape`` and, if ``type_as`` is

given, it must share ``type_as``'s dtype and device -- otherwise an explicit

error is raised instead of a deep error later in the solver.

Parameters

----------

a : array-like, shape ``shape``, or None

The marginal to validate, or None to fill with a uniform marginal.

shape : int or tuple of int

Expected shape of the marginal (see :func:`unif`).

type_as : array-like, optional

Array fixing the backend, device and dtype of the filled/validated marginal.

nx : backend object, optional

Numerical backend to use. If None, it is inferred from ``type_as``.

Returns

-------

a : array-like, shape ``shape``

The validated marginal.

"""

if a is None:

return unif(size, type_as=type_as)

if tuple(a.shape) != size:

raise ValueError(f"marginal has shape {tuple(a.shape)}, expected {size}")

if type_as is not None:

if nx is None:

nx = get_backend(type_as, a)

nx.assert_same_dtype_device(type_as, a)

return a</div>

def clean_zeros(a, b, M):

r"""Remove all components with zeros weights in :math:`\mathbf{a}` and :math:`\mathbf{b}`"""

M2 = M[a > 0, :][:, b > 0].copy() # copy force c style matrix (froemd)

a2 = a[a > 0]

b2 = b[b > 0]

return a2, b2, M2</div>

def euclidean_distances(X, Y, squared=False, nx=None):

r"""

Considering the rows of :math:`\mathbf{X}` (and :math:`\mathbf{Y} = \mathbf{X}`) as vectors, compute the

distance matrix between each pair of vectors.

.. note:: This function is backend-compatible and will work on arrays

from all compatible backends.

Parameters

----------

X : array-like, shape (n_samples_1, n_features)

Y : array-like, shape (n_samples_2, n_features)

squared : boolean, optional

Return squared Euclidean distances.

Returns

-------

distances : array-like, shape (`n_samples_1`, `n_samples_2`)

"""

if nx is None:

nx = get_backend(X, Y)

a2 = nx.einsum("ij,ij->i", X, X)

b2 = nx.einsum("ij,ij->i", Y, Y)

c = -2 * nx.dot(X, nx.transpose(Y))

c += a2[:, None]

c += b2[None, :]

c = nx.maximum(c, 0)

if not squared:

c = nx.sqrt(c)

if X is Y:

c = c * (1 - nx.eye(X.shape[0], type_as=c))

return c</div>

def sparse_ot_dist(

x1,

x2,

i,

j,

w=None,

metric="sqeuclidean",

p=2,

batch_size=None,

):

r"""Compute ot distance between samples in :math:`\mathbf{x_1}` and :math:`\mathbf{x_2}`

with sparse weights given by `w` for the pairs of samples with indices `i` and `j`.

.. note:: This function is backend-compatible and will work on arrays

from all compatible backends for the following metrics:

'sqeuclidean', 'euclidean', 'cityblock', 'minkowski'.

Parameters

----------

x1 : array-like, shape (n1,d)

matrix with `n1` samples of size `d`

x2 : array-like, shape (n2,d), optional

matrix with `n2` samples of size `d` (if None then :math:`\mathbf{x_2} = \mathbf{x_1}`)

i : array-like, shape (k,)

indices of samples in `x1` to compute distance from

j : array-like, shape (k,)

indices of samples in `x2` to compute distance to

w : array-like, shape (k,), optional

weights for each pair of samples to compute distance between.

If None, all pairs are weighted equally (=1/k).

metric : str | callable, optional

'sqeuclidean', 'euclidean', 'cityblock' or 'minkowski'.

p : float, optional

p-norm for the Minkowski metric. Default value is 2.

batch_size : int, optional

If specified, compute the distance in batches of size `batch_size` to avoid memory issues for large datasets. Default is None (no batching).

Returns

-------

dist : float

sum of the distance between :math:`\mathbf{x_1}_i` and :math:`\mathbf{x_2}_j` computed with given metric and weighted by `w`

"""

assert x1.ndim == 2, f"x1 must be a 2d array, got {x1.ndim}d array instead"

assert x2.ndim == 2, f"x2 must be a 2d array, got {x2.ndim}d array instead"

assert len(i) == len(

j

), f"i and j must have the same length, got {len(i)} and {len(j)}"

if w is not None:

assert len(w) == len(

i

), f"w must have the same length as i and j, got {len(w)} and {len(i)}"

assert metric in ("minkowski", "euclidean", "cityblock", "sqeuclidean"), (

"sparse_dist work only with metrics from the following list: "

+ "`['sqeuclidean', 'minkowski', 'cityblock', 'euclidean']`"

)

assert (

x1.shape[1] == x2.shape[1]

), f"x1 ({x1.shape}) and x2 ({x2.shape}) must have the same number of columns"

if metric == "euclidean":

p = 2

elif metric == "cityblock":

p = 1

def dist_idxs(idx_x1, idx_x2):

if metric == "sqeuclidean":

return nx.sum((x1[idx_x1] - x2[idx_x2]) ** 2, axis=1)

else:

return nx.sum(nx.abs(x1[idx_x1] - x2[idx_x2]) ** p, axis=1) ** (1 / p)

if w is None:

w = nx.ones(len(i), type_as=x1) / len(i)

d = 0

if batch_size is None:

batch_size = len(i)

for b in range(0, len(i), batch_size):

d += nx.sum(

dist_idxs(i[b : b + batch_size], j[b : b + batch_size])

* w[b : b + batch_size]

)

return d</div>

def dist(

x1,

x2=None,

metric="sqeuclidean",

p=2,

w=None,

backend="auto",

nx=None,

use_tensor=False,

):

r"""Compute distance between samples in :math:`\mathbf{x_1}` and :math:`\mathbf{x_2}`

.. note:: This function is backend-compatible and will work on arrays

from all compatible backends for the following metrics:

'sqeuclidean', 'euclidean', 'cityblock', 'minkowski', 'cosine', 'correlation'.

Parameters

----------

x1 : array-like, shape (n1,d)

matrix with `n1` samples of size `d`

x2 : array-like, shape (n2,d), optional

matrix with `n2` samples of size `d` (if None then :math:`\mathbf{x_2} = \mathbf{x_1}`)

metric : str | callable, optional

'sqeuclidean' or 'euclidean' on all backends. On numpy the function also

accepts from the scipy.spatial.distance.cdist function : 'braycurtis',

'canberra', 'chebyshev', 'cityblock', 'correlation', 'cosine', 'dice',

'euclidean', 'hamming', 'jaccard', 'kulczynski1', 'mahalanobis',

'matching', 'minkowski', 'rogerstanimoto', 'russellrao', 'seuclidean',

'sokalmichener', 'sokalsneath', 'sqeuclidean', 'wminkowski', 'yule'.

p : float, optional

p-norm for the Minkowski and the Weighted Minkowski metrics. Default value is 2.

w : array-like, rank 1

Weights for the weighted metrics.

backend : str, optional

Backend to use for the computation. If 'auto', the backend is

automatically selected based on the input data. if 'scipy',

the ``scipy.spatial.distance.cdist`` function is used (and gradients are

detached).

use_tensor : bool, optional

If true use tensorized computation for the distance matrix which can

cause memory issues for large datasets. Default is False and the

parameter is used only for the 'cityblock' and 'minkowski' metrics.

nx : Backend, optional

Backend to perform computations on. If omitted, the backend defaults to that of `x1`.

Returns

-------

M : array-like, shape (`n1`, `n2`)

distance matrix computed with given metric

"""

if nx is None:

if x2 is None:

x2 = x1

if backend == "scipy": # force scipy backend with cdist function

x1 = nx.to_numpy(x1)

x2 = nx.to_numpy(x2)

if isinstance(metric, str) and metric.endswith("minkowski"):

return nx.from_numpy(cdist(x1, x2, metric=metric, p=p, w=w))

if w is not None:

return nx.from_numpy(cdist(x1, x2, metric=metric, w=w))

elif metric == "sqeuclidean":

return euclidean_distances(x1, x2, squared=True, nx=nx)

elif metric == "euclidean":

return euclidean_distances(x1, x2, squared=False, nx=nx)

elif metric == "cityblock":

if w is None:

if use_tensor:

return nx.sum(nx.abs(x1[:, None, :] - x2[None, :, :]), axis=2)

else:

M = 0.0

for i in range(x1.shape[1]):

M += nx.abs(x1[:, i][:, None] - x2[:, i][None, :])

return M

else:

if use_tensor:

return nx.sum(

w[None, None, :] * nx.abs(x1[:, None, :] - x2[None, :, :]), axis=2

)

else:

M = 0.0

M += w[i] * nx.abs(x1[:, i][:, None] - x2[:, i][None, :])

return M

elif metric == "minkowski":

if w is None:

if use_tensor:

return nx.power(

nx.sum(

nx.power(nx.abs(x1[:, None, :] - x2[None, :, :]), p), axis=2

),

1 / p,

)

else:

M = 0.0

return M ** (1 / p)

else:

if use_tensor:

return nx.power(

nx.sum(

w[None, None, :]

* nx.power(nx.abs(x1[:, None, :] - x2[None, :, :]), p),

axis=2,

),

1 / p,

)

else:

M = 0.0

elif metric == "cosine":

nx1 = nx.sqrt(nx.einsum("ij,ij->i", x1, x1))

nx2 = nx.sqrt(nx.einsum("ij,ij->i", x2, x2))

return 1.0 - (nx.dot(x1, nx.transpose(x2)) / nx1[:, None] / nx2[None, :])

elif metric == "correlation":

x1 = x1 - nx.mean(x1, axis=1)[:, None]

x2 = x2 - nx.mean(x2, axis=1)[:, None]

else:

if not get_backend(x1, x2).__name__ == "numpy":

raise NotImplementedError()

else:

return cdist(x1, x2, metric=metric, p=p, w=w)

# Only pass w parameter for metrics that support it

# According to SciPy docs, only 'minkowski' and 'wminkowski' support w

if w is not None and metric in ["minkowski", "wminkowski"]:

return cdist(x1, x2, metric=metric, w=w)

def dist0(n, method="lin_square"):

r"""Compute standard cost matrices of size (`n`, `n`) for OT problems

Parameters

----------

n : int

Size of the cost matrix.

method : str, optional

Type of loss matrix chosen from:

* 'lin_square' : linear sampling between 0 and `n-1`, quadratic loss

Returns

-------

M : ndarray, shape (`n1`, `n2`)

Distance matrix computed with given metric.

"""

res = 0

if method == "lin_square":

x = np.arange(n, dtype=np.float64).reshape((n, 1))

res = dist(x, x)

return res</div>

def cost_normalization(C, norm=None, return_value=False, value=None):

r"""Apply normalization to the loss matrix

Parameters

----------

C : ndarray, shape (n1, n2)

The cost matrix to normalize.

norm : str

Type of normalization from 'median', 'max', 'log', 'loglog'. Any

other value do not normalize.

Returns

-------

C : ndarray, shape (`n1`, `n2`)

The input cost matrix normalized according to given norm.

"""

nx = get_backend(C)

if norm is None:

pass

elif norm == "median":

if value is None:

value = nx.median(C)

C /= value

elif norm == "max":

if value is None:

value = nx.max(C)

C /= float(value)

elif norm == "log":

elif norm == "loglog":

C = nx.log(1 + nx.log(1 + C))

else:

raise ValueError(

"Norm %s is not a valid option.\n"

"Valid options are:\n"

"median, max, log, loglog" % norm

)

if return_value:

return C, value

else:

return C</div>

def dots(*args):

r"""dots function for multiple matrix multiply"""

nx = get_backend(*args)

return reduce(nx.dot, args)</div>

def is_all_finite(*args):

r"""Tests element-wise for finiteness in all arguments."""

nx = get_backend(*args)

return all(not nx.any(~nx.isfinite(arg)) for arg in args)</div>

def label_normalization(y, start=0, nx=None):

r"""Transform labels to start at a given value

Parameters

----------

y : array-like, shape (n, )

The vector of labels to be normalized.

start : int

Desired value for the smallest label in :math:`\mathbf{y}` (default=0)

nx : Backend, optional

Backend to perform computations on. If omitted, the backend defaults to that of `y`.

Returns

-------

y : array-like, shape (`n1`, )

The input vector of labels normalized according to given start value.

"""

if nx is None:

nx = get_backend(y)

diff = nx.min(y) - start

return y if diff == 0 else (y - diff)</div>

def labels_to_masks(y, type_as=None, nx=None):

r"""Transforms (n_samples,) vector of labels into a (n_samples, n_labels) matrix of masks.

Parameters

----------

y : array-like, shape (n_samples, )

The vector of labels.

type_as : array_like

Array of the same type of the expected output.

nx : Backend, optional

Backend to perform computations on. If omitted, the backend defaults to that of `y`.

Returns

-------

masks : array-like, shape (n_samples, n_labels)

The (n_samples, n_labels) matrix of label masks.

"""

if nx is None:

nx = get_backend(y)

if type_as is None:

type_as = y

labels_u, labels_idx = nx.unique(y, return_inverse=True)

n_labels = labels_u.shape[0]

masks = nx.eye(n_labels, type_as=type_as)[labels_idx]

return masks</div>

def parmap(f, X, nprocs="default"):

r"""parallel map for multiprocessing.

The function has been deprecated and only performs a regular map.

"""

return list(map(f, X))</div>

def check_params(**kwargs):

r"""check_params: check whether some parameters are missing"""

missing_params = []

check = True

for param in kwargs:

if kwargs[param] is None:

missing_params.append(param)

if len(missing_params) > 0:

print("POT - Warning: following necessary parameters are missing")

for p in missing_params:

print("\n", p)

check = False

return check</div>

def check_random_state(seed):

r"""Turn `seed` into a np.random.RandomState instance

Parameters

----------

seed : None | int | instance of RandomState

If `seed` is None, return the RandomState singleton used by np.random.

If `seed` is an int, return a new RandomState instance seeded with `seed`.

If `seed` is already a RandomState instance, return it.

Otherwise raise ValueError.

"""

if seed is None or seed is np.random:

return np.random.mtrand._rand

if isinstance(seed, (int, np.integer)):

return np.random.RandomState(seed)

if isinstance(seed, np.random.RandomState):

return seed

raise ValueError(

"{} cannot be used to seed a numpy.random.RandomState instance".format(seed)

)</div>

def get_coordinate_circle(x):

r"""For :math:`x\in S^1 \subset \mathbb{R}^2`, returns the coordinates in

turn (in [0,1[).

.. math::

u = \frac{\pi + \mathrm{atan2}(-x_2,-x_1)}{2\pi}

Parameters

----------

x: ndarray, shape (n, 2)

Samples on the circle with ambient coordinates

Returns

-------

x_t: ndarray, shape (n,)

Coordinates on [0,1[

Examples

--------

>>> u = np.array([[0.2,0.5,0.8]]) * (2 * np.pi)

>>> x1, y1 = np.cos(u), np.sin(u)

>>> x = np.concatenate([x1, y1]).T

>>> get_coordinate_circle(x)

array([0.2, 0.5, 0.8])

"""

nx = get_backend(x)

x_t = (nx.atan2(-x[:, 1], -x[:, 0]) + np.pi) / (2 * np.pi)

return x_t</div>

def reduce_lazytensor(a, func, axis=None, nx=None, batch_size=100):

"""Reduce a LazyTensor along an axis with function fun using batches.

When axis=None, reduce the LazyTensor to a scalar as a sum of fun over

batches taken along dim.

.. warning::

This function works for tensor of any order but the reduction can be done

only along the first two axis (or global). Also, in order to work, it requires that the slice of size `batch_size` along the axis to reduce (or axis 0 if `axis=None`) is can be computed and fits in memory.

Parameters

----------

a : LazyTensor

LazyTensor to reduce

func : callable

Function to apply to the LazyTensor

axis : int, optional

Axis along which to reduce the LazyTensor. If None, reduce the

LazyTensor to a scalar as a sum of fun over batches taken along axis 0.

If 0 or 1 reduce the LazyTensor to a vector/matrix as a sum of fun over

batches taken along axis.

nx : Backend, optional

Backend to use for the reduction

batch_size : int, optional

Size of the batches to use for the reduction (default=100)

Returns

-------

res : array-like

Result of the reduction

"""

if nx is None:

nx = get_backend(a[0:1])

if axis is None:

res = 0.0

for i in range(0, a.shape[0], batch_size):

res += func(a[i : i + batch_size])

return res

elif axis == 0:

res = nx.zeros(a.shape[1:], type_as=a[0])

if nx.__name__ in ["jax", "tf"]:

lst = []

for j in range(0, a.shape[1], batch_size):

lst.append(func(a[:, j : j + batch_size], 0))

return nx.concatenate(lst, axis=0)

else:

View remainder of file in raw view

FilesExpand file tree

utils.html

Latest commit

History

utils.html

File metadata and controls