Skip to content

Commit 73225c5

Browse files
Circle CICircle CI
Circle CI
authored and
Circle CI
committed
CircleCI update of dev docs (2503).
1 parent 0abb89b commit 73225c5

File tree

188 files changed

+728872
-727029
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

188 files changed

+728872
-727029
lines changed
Binary file not shown.
Binary file not shown.
-289 Bytes
-577 Bytes
-418 Bytes
-417 Bytes
-82 Bytes
-12 Bytes
-54 Bytes
-91 Bytes

master/_modules/ot/da.html

+150-6
Large diffs are not rendered by default.

master/_modules/ot/lp.html

+10-11
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,8 @@ <h1>Source code for ot.lp</h1><div class="highlight"><pre>
108108

109109
<span class="c1"># import compiled emd</span>
110110
<span class="kn">from</span> <span class="nn">.emd_wrap</span> <span class="kn">import</span> <span class="n">emd_c</span><span class="p">,</span> <span class="n">check_result</span><span class="p">,</span> <span class="n">emd_1d_sorted</span>
111-
<span class="kn">from</span> <span class="nn">.solver_1d</span> <span class="kn">import</span> <span class="p">(</span><span class="n">emd_1d</span><span class="p">,</span> <span class="n">emd2_1d</span><span class="p">,</span> <span class="n">wasserstein_1d</span><span class="p">,</span>
112-
<span class="n">binary_search_circle</span><span class="p">,</span> <span class="n">wasserstein_circle</span><span class="p">,</span>
111+
<span class="kn">from</span> <span class="nn">.solver_1d</span> <span class="kn">import</span> <span class="p">(</span><span class="n">emd_1d</span><span class="p">,</span> <span class="n">emd2_1d</span><span class="p">,</span> <span class="n">wasserstein_1d</span><span class="p">,</span>
112+
<span class="n">binary_search_circle</span><span class="p">,</span> <span class="n">wasserstein_circle</span><span class="p">,</span>
113113
<span class="n">semidiscrete_wasserstein2_unif_circle</span><span class="p">)</span>
114114

115115
<span class="kn">from</span> <span class="nn">..utils</span> <span class="kn">import</span> <span class="n">dist</span><span class="p">,</span> <span class="n">list_to_array</span>
@@ -360,7 +360,7 @@ <h1>Source code for ot.lp</h1><div class="highlight"><pre>
360360
<span class="sd"> check_marginals: bool, optional (default=True)</span>
361361
<span class="sd"> If True, checks that the marginals mass are equal. If False, skips the</span>
362362
<span class="sd"> check.</span>
363-
<span class="sd"> </span>
363+
364364

365365
<span class="sd"> Returns</span>
366366
<span class="sd"> -------</span>
@@ -439,8 +439,8 @@ <h1>Source code for ot.lp</h1><div class="highlight"><pre>
439439
<span class="c1"># ensure that same mass</span>
440440
<span class="k">if</span> <span class="n">check_marginals</span><span class="p">:</span>
441441
<span class="n">np</span><span class="o">.</span><span class="n">testing</span><span class="o">.</span><span class="n">assert_almost_equal</span><span class="p">(</span><span class="n">a</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="mi">0</span><span class="p">),</span>
442-
<span class="n">b</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="mi">0</span><span class="p">),</span> <span class="n">err_msg</span><span class="o">=</span><span class="s1">&#39;a and b vector must have the same sum&#39;</span><span class="p">,</span>
443-
<span class="n">decimal</span><span class="o">=</span><span class="mi">6</span><span class="p">)</span>
442+
<span class="n">b</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="mi">0</span><span class="p">),</span> <span class="n">err_msg</span><span class="o">=</span><span class="s1">&#39;a and b vector must have the same sum&#39;</span><span class="p">,</span>
443+
<span class="n">decimal</span><span class="o">=</span><span class="mi">6</span><span class="p">)</span>
444444
<span class="n">b</span> <span class="o">=</span> <span class="n">b</span> <span class="o">*</span> <span class="n">a</span><span class="o">.</span><span class="n">sum</span><span class="p">()</span> <span class="o">/</span> <span class="n">b</span><span class="o">.</span><span class="n">sum</span><span class="p">()</span>
445445

446446
<span class="n">asel</span> <span class="o">=</span> <span class="n">a</span> <span class="o">!=</span> <span class="mi">0</span>
@@ -541,8 +541,8 @@ <h1>Source code for ot.lp</h1><div class="highlight"><pre>
541541
<span class="sd"> check_marginals: bool, optional (default=True)</span>
542542
<span class="sd"> If True, checks that the marginals mass are equal. If False, skips the</span>
543543
<span class="sd"> check.</span>
544-
<span class="sd"> </span>
545-
<span class="sd"> </span>
544+
545+
546546
<span class="sd"> Returns</span>
547547
<span class="sd"> -------</span>
548548
<span class="sd"> W: float, array-like</span>
@@ -607,16 +607,15 @@ <h1>Source code for ot.lp</h1><div class="highlight"><pre>
607607
<span class="n">b</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">b</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float64</span><span class="p">)</span>
608608
<span class="n">M</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">M</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float64</span><span class="p">,</span> <span class="n">order</span><span class="o">=</span><span class="s1">&#39;C&#39;</span><span class="p">)</span>
609609

610-
611610
<span class="k">assert</span> <span class="p">(</span><span class="n">a</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="n">M</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">and</span> <span class="n">b</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="n">M</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">1</span><span class="p">]),</span> \
612611
<span class="s2">&quot;Dimension mismatch, check dimensions of M with a and b&quot;</span>
613612

614613
<span class="c1"># ensure that same mass</span>
615614
<span class="k">if</span> <span class="n">check_marginals</span><span class="p">:</span>
616615
<span class="n">np</span><span class="o">.</span><span class="n">testing</span><span class="o">.</span><span class="n">assert_almost_equal</span><span class="p">(</span><span class="n">a</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="mi">0</span><span class="p">),</span>
617-
<span class="n">b</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span><span class="n">keepdims</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> <span class="n">err_msg</span><span class="o">=</span><span class="s1">&#39;a and b vector must have the same sum&#39;</span><span class="p">,</span>
618-
<span class="n">decimal</span><span class="o">=</span><span class="mi">6</span><span class="p">)</span>
619-
<span class="n">b</span> <span class="o">=</span> <span class="n">b</span> <span class="o">*</span> <span class="n">a</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span> <span class="o">/</span> <span class="n">b</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span><span class="n">keepdims</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
616+
<span class="n">b</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">keepdims</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> <span class="n">err_msg</span><span class="o">=</span><span class="s1">&#39;a and b vector must have the same sum&#39;</span><span class="p">,</span>
617+
<span class="n">decimal</span><span class="o">=</span><span class="mi">6</span><span class="p">)</span>
618+
<span class="n">b</span> <span class="o">=</span> <span class="n">b</span> <span class="o">*</span> <span class="n">a</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span> <span class="o">/</span> <span class="n">b</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">keepdims</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
620619

621620
<span class="n">asel</span> <span class="o">=</span> <span class="n">a</span> <span class="o">!=</span> <span class="mi">0</span>
622621

master/_modules/ot/utils.html

+11-4
Original file line numberDiff line numberDiff line change
@@ -488,7 +488,7 @@ <h1>Source code for ot.utils</h1><div class="highlight"><pre>
488488

489489
<div class="viewcode-block" id="cost_normalization">
490490
<a class="viewcode-back" href="../../gen_modules/ot.utils.html#ot.cost_normalization">[docs]</a>
491-
<span class="k">def</span> <span class="nf">cost_normalization</span><span class="p">(</span><span class="n">C</span><span class="p">,</span> <span class="n">norm</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
491+
<span class="k">def</span> <span class="nf">cost_normalization</span><span class="p">(</span><span class="n">C</span><span class="p">,</span> <span class="n">norm</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">return_value</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
492492
<span class="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot; Apply normalization to the loss matrix</span>
493493

494494
<span class="sd"> Parameters</span>
@@ -510,9 +510,13 @@ <h1>Source code for ot.utils</h1><div class="highlight"><pre>
510510
<span class="k">if</span> <span class="n">norm</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
511511
<span class="k">pass</span>
512512
<span class="k">elif</span> <span class="n">norm</span> <span class="o">==</span> <span class="s2">&quot;median&quot;</span><span class="p">:</span>
513-
<span class="n">C</span> <span class="o">/=</span> <span class="nb">float</span><span class="p">(</span><span class="n">nx</span><span class="o">.</span><span class="n">median</span><span class="p">(</span><span class="n">C</span><span class="p">))</span>
513+
<span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
514+
<span class="n">value</span> <span class="o">=</span> <span class="n">nx</span><span class="o">.</span><span class="n">median</span><span class="p">(</span><span class="n">C</span><span class="p">)</span>
515+
<span class="n">C</span> <span class="o">/=</span> <span class="n">value</span>
514516
<span class="k">elif</span> <span class="n">norm</span> <span class="o">==</span> <span class="s2">&quot;max&quot;</span><span class="p">:</span>
515-
<span class="n">C</span> <span class="o">/=</span> <span class="nb">float</span><span class="p">(</span><span class="n">nx</span><span class="o">.</span><span class="n">max</span><span class="p">(</span><span class="n">C</span><span class="p">))</span>
517+
<span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
518+
<span class="n">value</span> <span class="o">=</span> <span class="n">nx</span><span class="o">.</span><span class="n">max</span><span class="p">(</span><span class="n">C</span><span class="p">)</span>
519+
<span class="n">C</span> <span class="o">/=</span> <span class="nb">float</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
516520
<span class="k">elif</span> <span class="n">norm</span> <span class="o">==</span> <span class="s2">&quot;log&quot;</span><span class="p">:</span>
517521
<span class="n">C</span> <span class="o">=</span> <span class="n">nx</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="mi">1</span> <span class="o">+</span> <span class="n">C</span><span class="p">)</span>
518522
<span class="k">elif</span> <span class="n">norm</span> <span class="o">==</span> <span class="s2">&quot;loglog&quot;</span><span class="p">:</span>
@@ -521,7 +525,10 @@ <h1>Source code for ot.utils</h1><div class="highlight"><pre>
521525
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;Norm </span><span class="si">%s</span><span class="s1"> is not a valid option.</span><span class="se">\n</span><span class="s1">&#39;</span>
522526
<span class="s1">&#39;Valid options are:</span><span class="se">\n</span><span class="s1">&#39;</span>
523527
<span class="s1">&#39;median, max, log, loglog&#39;</span> <span class="o">%</span> <span class="n">norm</span><span class="p">)</span>
524-
<span class="k">return</span> <span class="n">C</span></div>
528+
<span class="k">if</span> <span class="n">return_value</span><span class="p">:</span>
529+
<span class="k">return</span> <span class="n">C</span><span class="p">,</span> <span class="n">value</span>
530+
<span class="k">else</span><span class="p">:</span>
531+
<span class="k">return</span> <span class="n">C</span></div>
525532

526533

527534

master/_sources/auto_examples/backends/plot_dual_ot_pytorch.rst.txt

+40-40

master/_sources/auto_examples/backends/plot_optim_gromov_pytorch.rst.txt

+2-2

0 commit comments

Comments
 (0)