Skip to content

Commit de84f49

Browse files
Circle CICircle CI
Circle CI
authored and
Circle CI
committed
CircleCI update of dev docs (2703).
1 parent acaf9fe commit de84f49

File tree

377 files changed

+732311
-732451
lines changed

Some content is hidden

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

377 files changed

+732311
-732451
lines changed
Binary file not shown.
Binary file not shown.
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
-248 Bytes
-256 Bytes
-388 Bytes
-210 Bytes
-208 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
-667 Bytes
-203 Bytes
-182 Bytes
0 Bytes
0 Bytes
0 Bytes
-790 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
-348 Bytes
804 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes
0 Bytes

master/_modules/ot/backend.html

Lines changed: 29 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1257,16 +1257,17 @@ <h1>Source code for ot.backend</h1><div class="highlight"><pre>
12571257

12581258
<div class="viewcode-block" id="Backend.kl_div">
12591259
<a class="viewcode-back" href="../../gen_modules/ot.backend.html#ot.backend.Backend.kl_div">[docs]</a>
1260-
<span class="k">def</span> <span class="nf">kl_div</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">p</span><span class="p">,</span> <span class="n">q</span><span class="p">,</span> <span class="n">eps</span><span class="o">=</span><span class="mf">1e-16</span><span class="p">):</span>
1260+
<span class="k">def</span> <span class="nf">kl_div</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">p</span><span class="p">,</span> <span class="n">q</span><span class="p">,</span> <span class="n">mass</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">eps</span><span class="o">=</span><span class="mf">1e-16</span><span class="p">):</span>
12611261
<span class="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;</span>
1262-
<span class="sd"> Computes the Kullback-Leibler divergence.</span>
1262+
<span class="sd"> Computes the (Generalized) Kullback-Leibler divergence.</span>
12631263

12641264
<span class="sd"> This function follows the api from :any:`scipy.stats.entropy`.</span>
12651265

12661266
<span class="sd"> Parameter eps is used to avoid numerical errors and is added in the log.</span>
12671267

12681268
<span class="sd"> .. math::</span>
1269-
<span class="sd"> KL(p,q) = \sum_i p(i) \log (\frac{p(i)}{q(i)}+\epsilon)</span>
1269+
<span class="sd"> KL(p,q) = \langle \mathbf{p}, log(\mathbf{p} / \mathbf{q} + eps \rangle</span>
1270+
<span class="sd"> + \mathbb{1}_{mass=True} \langle \mathbf{q} - \mathbf{p}, \mathbf{1} \rangle</span>
12701271

12711272
<span class="sd"> See: https://docs.scipy.org/doc/scipy/reference/generated/scipy.stats.entropy.html</span>
12721273
<span class="sd"> &quot;&quot;&quot;</span>
@@ -1908,8 +1909,11 @@ <h1>Source code for ot.backend</h1><div class="highlight"><pre>
19081909

19091910
<div class="viewcode-block" id="NumpyBackend.kl_div">
19101911
<a class="viewcode-back" href="../../gen_modules/ot.backend.html#ot.backend.NumpyBackend.kl_div">[docs]</a>
1911-
<span class="k">def</span> <span class="nf">kl_div</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">p</span><span class="p">,</span> <span class="n">q</span><span class="p">,</span> <span class="n">eps</span><span class="o">=</span><span class="mf">1e-16</span><span class="p">):</span>
1912-
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">p</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="n">p</span> <span class="o">/</span> <span class="n">q</span> <span class="o">+</span> <span class="n">eps</span><span class="p">))</span></div>
1912+
<span class="k">def</span> <span class="nf">kl_div</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">p</span><span class="p">,</span> <span class="n">q</span><span class="p">,</span> <span class="n">mass</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">eps</span><span class="o">=</span><span class="mf">1e-16</span><span class="p">):</span>
1913+
<span class="n">value</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">p</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="n">p</span> <span class="o">/</span> <span class="n">q</span> <span class="o">+</span> <span class="n">eps</span><span class="p">))</span>
1914+
<span class="k">if</span> <span class="n">mass</span><span class="p">:</span>
1915+
<span class="n">value</span> <span class="o">=</span> <span class="n">value</span> <span class="o">+</span> <span class="n">np</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">q</span> <span class="o">-</span> <span class="n">p</span><span class="p">)</span>
1916+
<span class="k">return</span> <span class="n">value</span></div>
19131917

19141918

19151919
<div class="viewcode-block" id="NumpyBackend.isfinite">
@@ -2550,8 +2554,11 @@ <h1>Source code for ot.backend</h1><div class="highlight"><pre>
25502554

25512555
<div class="viewcode-block" id="JaxBackend.kl_div">
25522556
<a class="viewcode-back" href="../../gen_modules/ot.backend.html#ot.backend.JaxBackend.kl_div">[docs]</a>
2553-
<span class="k">def</span> <span class="nf">kl_div</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">p</span><span class="p">,</span> <span class="n">q</span><span class="p">,</span> <span class="n">eps</span><span class="o">=</span><span class="mf">1e-16</span><span class="p">):</span>
2554-
<span class="k">return</span> <span class="n">jnp</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">p</span> <span class="o">*</span> <span class="n">jnp</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="n">p</span> <span class="o">/</span> <span class="n">q</span> <span class="o">+</span> <span class="n">eps</span><span class="p">))</span></div>
2557+
<span class="k">def</span> <span class="nf">kl_div</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">p</span><span class="p">,</span> <span class="n">q</span><span class="p">,</span> <span class="n">mass</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">eps</span><span class="o">=</span><span class="mf">1e-16</span><span class="p">):</span>
2558+
<span class="n">value</span> <span class="o">=</span> <span class="n">jnp</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">p</span> <span class="o">*</span> <span class="n">jnp</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="n">p</span> <span class="o">/</span> <span class="n">q</span> <span class="o">+</span> <span class="n">eps</span><span class="p">))</span>
2559+
<span class="k">if</span> <span class="n">mass</span><span class="p">:</span>
2560+
<span class="n">value</span> <span class="o">=</span> <span class="n">value</span> <span class="o">+</span> <span class="n">jnp</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">q</span> <span class="o">-</span> <span class="n">p</span><span class="p">)</span>
2561+
<span class="k">return</span> <span class="n">value</span></div>
25552562

25562563

25572564
<div class="viewcode-block" id="JaxBackend.isfinite">
@@ -3280,8 +3287,11 @@ <h1>Source code for ot.backend</h1><div class="highlight"><pre>
32803287

32813288
<div class="viewcode-block" id="TorchBackend.kl_div">
32823289
<a class="viewcode-back" href="../../gen_modules/ot.backend.html#ot.backend.TorchBackend.kl_div">[docs]</a>
3283-
<span class="k">def</span> <span class="nf">kl_div</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">p</span><span class="p">,</span> <span class="n">q</span><span class="p">,</span> <span class="n">eps</span><span class="o">=</span><span class="mf">1e-16</span><span class="p">):</span>
3284-
<span class="k">return</span> <span class="n">torch</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">p</span> <span class="o">*</span> <span class="n">torch</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="n">p</span> <span class="o">/</span> <span class="n">q</span> <span class="o">+</span> <span class="n">eps</span><span class="p">))</span></div>
3290+
<span class="k">def</span> <span class="nf">kl_div</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">p</span><span class="p">,</span> <span class="n">q</span><span class="p">,</span> <span class="n">mass</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">eps</span><span class="o">=</span><span class="mf">1e-16</span><span class="p">):</span>
3291+
<span class="n">value</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">p</span> <span class="o">*</span> <span class="n">torch</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="n">p</span> <span class="o">/</span> <span class="n">q</span> <span class="o">+</span> <span class="n">eps</span><span class="p">))</span>
3292+
<span class="k">if</span> <span class="n">mass</span><span class="p">:</span>
3293+
<span class="n">value</span> <span class="o">=</span> <span class="n">value</span> <span class="o">+</span> <span class="n">torch</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">q</span> <span class="o">-</span> <span class="n">p</span><span class="p">)</span>
3294+
<span class="k">return</span> <span class="n">value</span></div>
32853295

32863296

32873297
<div class="viewcode-block" id="TorchBackend.isfinite">
@@ -3924,8 +3934,11 @@ <h1>Source code for ot.backend</h1><div class="highlight"><pre>
39243934

39253935
<div class="viewcode-block" id="CupyBackend.kl_div">
39263936
<a class="viewcode-back" href="../../gen_modules/ot.backend.html#ot.backend.CupyBackend.kl_div">[docs]</a>
3927-
<span class="k">def</span> <span class="nf">kl_div</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">p</span><span class="p">,</span> <span class="n">q</span><span class="p">,</span> <span class="n">eps</span><span class="o">=</span><span class="mf">1e-16</span><span class="p">):</span>
3928-
<span class="k">return</span> <span class="n">cp</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">p</span> <span class="o">*</span> <span class="n">cp</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="n">p</span> <span class="o">/</span> <span class="n">q</span> <span class="o">+</span> <span class="n">eps</span><span class="p">))</span></div>
3937+
<span class="k">def</span> <span class="nf">kl_div</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">p</span><span class="p">,</span> <span class="n">q</span><span class="p">,</span> <span class="n">mass</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">eps</span><span class="o">=</span><span class="mf">1e-16</span><span class="p">):</span>
3938+
<span class="n">value</span> <span class="o">=</span> <span class="n">cp</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">p</span> <span class="o">*</span> <span class="n">cp</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="n">p</span> <span class="o">/</span> <span class="n">q</span> <span class="o">+</span> <span class="n">eps</span><span class="p">))</span>
3939+
<span class="k">if</span> <span class="n">mass</span><span class="p">:</span>
3940+
<span class="n">value</span> <span class="o">=</span> <span class="n">value</span> <span class="o">+</span> <span class="n">cp</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">q</span> <span class="o">-</span> <span class="n">p</span><span class="p">)</span>
3941+
<span class="k">return</span> <span class="n">value</span></div>
39293942

39303943

39313944
<div class="viewcode-block" id="CupyBackend.isfinite">
@@ -4591,8 +4604,11 @@ <h1>Source code for ot.backend</h1><div class="highlight"><pre>
45914604

45924605
<div class="viewcode-block" id="TensorflowBackend.kl_div">
45934606
<a class="viewcode-back" href="../../gen_modules/ot.backend.html#ot.backend.TensorflowBackend.kl_div">[docs]</a>
4594-
<span class="k">def</span> <span class="nf">kl_div</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">p</span><span class="p">,</span> <span class="n">q</span><span class="p">,</span> <span class="n">eps</span><span class="o">=</span><span class="mf">1e-16</span><span class="p">):</span>
4595-
<span class="k">return</span> <span class="n">tnp</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">p</span> <span class="o">*</span> <span class="n">tnp</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="n">p</span> <span class="o">/</span> <span class="n">q</span> <span class="o">+</span> <span class="n">eps</span><span class="p">))</span></div>
4607+
<span class="k">def</span> <span class="nf">kl_div</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">p</span><span class="p">,</span> <span class="n">q</span><span class="p">,</span> <span class="n">mass</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">eps</span><span class="o">=</span><span class="mf">1e-16</span><span class="p">):</span>
4608+
<span class="n">value</span> <span class="o">=</span> <span class="n">tnp</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">p</span> <span class="o">*</span> <span class="n">tnp</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="n">p</span> <span class="o">/</span> <span class="n">q</span> <span class="o">+</span> <span class="n">eps</span><span class="p">))</span>
4609+
<span class="k">if</span> <span class="n">mass</span><span class="p">:</span>
4610+
<span class="n">value</span> <span class="o">=</span> <span class="n">value</span> <span class="o">+</span> <span class="n">tnp</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">q</span> <span class="o">-</span> <span class="n">p</span><span class="p">)</span>
4611+
<span class="k">return</span> <span class="n">value</span></div>
45964612

45974613

45984614
<div class="viewcode-block" id="TensorflowBackend.isfinite">

master/_modules/ot/bregman/_barycenter.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -460,7 +460,7 @@ <h1>Source code for ot.bregman._barycenter</h1><div class="highlight"><pre>
460460
<span class="n">log</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;err&#39;</span><span class="p">:</span> <span class="p">[]}</span>
461461

462462
<span class="n">M</span> <span class="o">=</span> <span class="o">-</span> <span class="n">M</span> <span class="o">/</span> <span class="n">reg</span>
463-
<span class="n">logA</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="n">A</span> <span class="o">+</span> <span class="mf">1e-15</span><span class="p">)</span>
463+
<span class="n">logA</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="n">A</span> <span class="o">+</span> <span class="mf">1e-16</span><span class="p">)</span>
464464
<span class="n">log_KU</span><span class="p">,</span> <span class="n">G</span> <span class="o">=</span> <span class="n">nx</span><span class="o">.</span><span class="n">zeros</span><span class="p">((</span><span class="mi">2</span><span class="p">,</span> <span class="o">*</span><span class="n">logA</span><span class="o">.</span><span class="n">shape</span><span class="p">),</span> <span class="n">type_as</span><span class="o">=</span><span class="n">A</span><span class="p">)</span>
465465
<span class="n">err</span> <span class="o">=</span> <span class="mi">1</span>
466466
<span class="k">for</span> <span class="n">ii</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">numItermax</span><span class="p">):</span>
@@ -804,7 +804,7 @@ <h1>Source code for ot.bregman._barycenter</h1><div class="highlight"><pre>
804804
<span class="n">log</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;err&#39;</span><span class="p">:</span> <span class="p">[]}</span>
805805

806806
<span class="n">M</span> <span class="o">=</span> <span class="o">-</span> <span class="n">M</span> <span class="o">/</span> <span class="n">reg</span>
807-
<span class="n">logA</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="n">A</span> <span class="o">+</span> <span class="mf">1e-15</span><span class="p">)</span>
807+
<span class="n">logA</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="n">A</span> <span class="o">+</span> <span class="mf">1e-16</span><span class="p">)</span>
808808
<span class="n">log_KU</span><span class="p">,</span> <span class="n">G</span> <span class="o">=</span> <span class="n">nx</span><span class="o">.</span><span class="n">zeros</span><span class="p">((</span><span class="mi">2</span><span class="p">,</span> <span class="o">*</span><span class="n">logA</span><span class="o">.</span><span class="n">shape</span><span class="p">),</span> <span class="n">type_as</span><span class="o">=</span><span class="n">A</span><span class="p">)</span>
809809
<span class="n">c</span> <span class="o">=</span> <span class="n">nx</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="n">dim</span><span class="p">,</span> <span class="n">type_as</span><span class="o">=</span><span class="n">A</span><span class="p">)</span>
810810
<span class="n">err</span> <span class="o">=</span> <span class="mi">1</span>

0 commit comments

Comments
 (0)