summaryrefslogtreecommitdiff
path: root/docs/source/auto_examples/plot_screenkhorn_1D.rst
blob: 039479eb508c938140223db3fe73b9ae154fbe9a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        Click :ref:`here <sphx_glr_download_auto_examples_plot_screenkhorn_1D.py>`     to download the full example code
    .. rst-class:: sphx-glr-example-title

    .. _sphx_glr_auto_examples_plot_screenkhorn_1D.py:


===============================
1D Screened optimal transport
===============================

This example illustrates the computation of Screenkhorn:
Screening Sinkhorn Algorithm for Optimal transport.


.. code-block:: default


    # Author: Mokhtar Z. Alaya <mokhtarzahdi.alaya@gmail.com>
    #
    # License: MIT License

    import numpy as np
    import matplotlib.pylab as pl
    import ot.plot
    from ot.datasets import make_1D_gauss as gauss
    from ot.bregman import screenkhorn








Generate data
-------------


.. code-block:: default


    n = 100  # nb bins

    # bin positions
    x = np.arange(n, dtype=np.float64)

    # Gaussian distributions
    a = gauss(n, m=20, s=5)  # m= mean, s= std
    b = gauss(n, m=60, s=10)

    # loss matrix
    M = ot.dist(x.reshape((n, 1)), x.reshape((n, 1)))
    M /= M.max()








Plot distributions and loss matrix
----------------------------------


.. code-block:: default


    pl.figure(1, figsize=(6.4, 3))
    pl.plot(x, a, 'b', label='Source distribution')
    pl.plot(x, b, 'r', label='Target distribution')
    pl.legend()

    # plot distributions and loss matrix

    pl.figure(2, figsize=(5, 5))
    ot.plot.plot1D_mat(a, b, M, 'Cost matrix M')




.. rst-class:: sphx-glr-horizontal


    *

      .. image:: /auto_examples/images/sphx_glr_plot_screenkhorn_1D_001.png
            :class: sphx-glr-multi-img

    *

      .. image:: /auto_examples/images/sphx_glr_plot_screenkhorn_1D_002.png
            :class: sphx-glr-multi-img





Solve Screenkhorn
-----------------------


.. code-block:: default


    # Screenkhorn
    lambd = 2e-03  # entropy parameter
    ns_budget = 30  # budget number of points to be keeped in the source distribution
    nt_budget = 30  # budget number of points to be keeped in the target distribution

    G_screen = screenkhorn(a, b, M, lambd, ns_budget, nt_budget, uniform=False, restricted=True, verbose=True)
    pl.figure(4, figsize=(5, 5))
    ot.plot.plot1D_mat(a, b, G_screen, 'OT matrix Screenkhorn')
    pl.show()



.. image:: /auto_examples/images/sphx_glr_plot_screenkhorn_1D_003.png
    :class: sphx-glr-single-img


.. rst-class:: sphx-glr-script-out

 Out:

 .. code-block:: none

    /home/rflamary/PYTHON/POT/ot/bregman.py:2056: UserWarning: Bottleneck module is not installed. Install it from https://pypi.org/project/Bottleneck/ for better performance.
      "Bottleneck module is not installed. Install it from https://pypi.org/project/Bottleneck/ for better performance.")
    epsilon = 0.020986042861303855

    kappa = 3.7476531411890917

    Cardinality of selected points: |Isel| = 30      |Jsel| = 30 

    /home/rflamary/PYTHON/POT/examples/plot_screenkhorn_1D.py:68: UserWarning: Matplotlib is currently using agg, which is a non-GUI backend, so cannot show the figure.
      pl.show()





.. rst-class:: sphx-glr-timing

   **Total running time of the script:** ( 0 minutes  0.228 seconds)


.. _sphx_glr_download_auto_examples_plot_screenkhorn_1D.py:


.. only :: html

 .. container:: sphx-glr-footer
    :class: sphx-glr-footer-example



  .. container:: sphx-glr-download sphx-glr-download-python

     :download:`Download Python source code: plot_screenkhorn_1D.py <plot_screenkhorn_1D.py>`



  .. container:: sphx-glr-download sphx-glr-download-jupyter

     :download:`Download Jupyter notebook: plot_screenkhorn_1D.ipynb <plot_screenkhorn_1D.ipynb>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_