Update "Using the FAµST API in Algorithms" notebook with pyfaust version footer.

42ea80a6 · hhakim · 4a71c271 · 42ea80a6 · 42ea80a6
Commit 42ea80a6 authored 4 years ago by hhakim
--- a/gen_doc/Use_of_Faust_objects_in_algorithms.html
+++ b/gen_doc/Use_of_Faust_objects_in_algorithms.html
--- a/gen_doc/Use_of_Faust_objects_in_algorithms.ipynb
+++ b/gen_doc/Use_of_Faust_objects_in_algorithms.ipynb
@@ -403,6 +403,23 @@
    "<a name=\"manip_links\">Faust manipulation (2nd) notebook:</a> [html](https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/Faust_manipulation.html), [ipynb](https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/Faust_manipulation.ipynb)  \n",
    "<a name=\"[1]\">[1]</a> [Tropp, J. A. (2004). Greed is Good: Algorithmic Results for Sparse Approximation. IEEE Transactions on Information Theory, 50(10), 2231–2242](http://doi.org/10.1109/TIT.2004.834793)."
   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "**Note**: this notebook was executed using the following pyfaust version:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import pyfaust\n",
+    "pyfaust.version()"
+   ]
  }
 ],
 "metadata": {
@@ -421,7 +438,7 @@
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
-   "version": "3.7.6"
+   "version": "3.7.10"
  }
 },
 "nbformat": 4,

 %% Cell type:markdown id: tags:
 # Using the FAµST API in Algorithms
 After the little tour we've done in the previous notebooks, about the [creation of Faust objects](#creation_links), and their [manipulation](#manip_links), we shall see in this third notebook how the FAµST API can be deployed seamlessly in algorithms.
 Our example, already alluded in the [second notebook](#manip_links), will be the Orthogonal Matching Pursuit algorithm (OMP).
 This algorithm intervenes in the dictionary learning problem. Of course, I will not treat the theory behind but I assume the reader is already familiar with it.
 There is not so much to say so let's go straight to the code example.
 %% Cell type:markdown id: tags:
 ### 1. The Toy OMP Algorithm Implementation
 %% Cell type:code id: tags:
 ``` python
 from pyfaust import *
 from numpy import zeros, copy, argmax
 def tomp(y, D, niter):
    nrows, ncols = D.shape
    x = zeros((ncols,1))
    supp = []
    res = copy(y)
    i = 0
    K = min(nrows, ncols)
    while (len(supp) < K and i < niter):
        j = argmax(abs(D.T@res))
        supp += [j]
        x[supp,:] = pinv(D[:,supp])@y
        res = y-D[:,supp]@x[supp,:]
        i += 1
    return x
 ```
 %% Cell type:markdown id: tags:
 The most important point to notice in this code is that except the import part in the header, all the code seems to be a natural numpy implementation of OMP.
 This is in fact the core philosophy of the FAµST API, as explained in previous notebooks and also in the API documentation, we made sure that a Faust can be seen as a numpy array (or rather as a ``numpy.matrix``) hence this code is in fact totally compatible with the two APIs: the function argument D, which is the dictionary, can be indifferently a ``pyfaust.Faust`` object or a ``numpy.matrix`` object.
 A secondary point is that this implementation is more like a toy concept (as indicated by the "t" in the function name). A more advanced and optimized version is introduced in the [last part of this notebook](#4.-An-OMP-Cholesky-Implementation) and in particular allows to define the algorithm stopping criterion according to the error tolerance the user wants.
 Next we will test this implementation in both cases. But first, let us define a test case.
 %% Cell type:markdown id: tags:
 ### 2. The Test Case Dictionary
 %% Cell type:markdown id: tags:
 For convenience, we shall set up a dictionary which guarantees uniqueness of sufficiently sparse representations.
 The dictionary is the concatenation of an identity matrix and a Hadamard matrix, and because we work with Faust objects, this concatenation will be a Faust object.
 Below is the block matrix of our dictionary:
 $
 D =
 \left[
 \begin{array}{c|c}
 I_n & H_n \\
 \end{array}
 \right]
 $
 $I_n$ is the identity or Dirac matrix and $H_n$ the orthonormal Hadamard matrix, with n being a power of two.
 The condition on which the uniqueness of the sparse representation $x$ of a vector $y$  is ensured is defined by the following inequality:
 $ \| x \|_0 < (1 + 1/\mu)/2 $ where $\mu$ denotes the coherence of the dictionary and in case of our specially crafted dictionary $\mu = {1 \over \sqrt n}$.
 So let's construct the Faust of D, compute y for a sparse enough x and test our OMP implementation to find out if we effectively retrieve this unique x as we should according to this theorem.
 Note that, for a better view and understanding you might consult this article [[1]](#[1]).
 %% Cell type:code id: tags:
 ``` python
 from pyfaust import eye, wht
 n = 128
 FD = hstack((eye(n), wht(n)))
 D = FD.toarray()
 print(D)
 ```
 %% Cell type:markdown id: tags:
 Now that we have our dictionary both defined as a Faust (FD) and as a matrix (D), let's construct our reference sparse vector x, we'll call it $x_0$.
 %% Cell type:code id: tags:
 ``` python
 from numpy import zeros, count_nonzero
 from numpy.random import randn, permutation as randperm
 from math import floor, sqrt
 x0 = zeros((2*n, 1)) # NB: FD.shape[1] == 2*n
 nnz = floor(.5*(1+sqrt(n)))
 nonzero_inds = randperm(2*n)[:nnz]
 # we got nnz indices, now build the vector x0
 x0[nonzero_inds,0] = randn()
 print("l0 norm of x0: ", count_nonzero(x0))
 ```
 %% Cell type:markdown id: tags:
 It remains to compute $y$.
 %% Cell type:code id: tags:
 ``` python
 y = FD@x0
 ```
 %% Cell type:markdown id: tags:
 Our test case is complete, we are fully prepared to run the OMP algorithm using a well-defined dictionary as a Faust or as numpy array, this should retrieve our $x_0$ from the vector y. Let's try!
 %% Cell type:markdown id: tags:
 ### 3. Running the Algorithm
 %% Cell type:code id: tags:
 ``` python
 x = tomp(y, FD, nnz)
 from numpy import allclose
 assert(allclose(x,x0))
 print("We succeeded to retrieve x0, OMP works!")
 ```
 %% Cell type:markdown id: tags:
 We tested OMP on a Faust, go ahead and verify what I was aiming at in the first part of the notebook: is this OMP implementation really working identically on a Faust and a ``numpy.matrix``?
 %% Cell type:code id: tags:
 ``` python
 x = tomp(y, D, nnz)
 assert(allclose(x,x0))
 print("We succeeded to retrieve x0, OMP works!")
 ```
 %% Cell type:markdown id: tags:
 We can conclude that the algorithm is indeed available to both numpy and Faust worlds, and we can imagine surely that other algorithms are reachable through the FAµST API. That's anyway in that purpose that the FAµST library will be extended if needed in the future.
 %% Cell type:markdown id: tags:
 ### 4. An OMP-Cholesky Implementation
 Speaking of the OMP algorithm and the possibility to implement other optimization algorithms with FAµST, it would be a pity not to mention that the library is delivered with another implementation of OMP.
 This implementation is actually an optimized version which takes advantage of the Cholesky factorization to simplify the least-square problem to solve at each iteration.
 This algorithm is implemented into the ``tools`` module of pyfaust.
 %% Cell type:code id: tags:
 ``` python
 from pyfaust.tools import omp
 help(omp)
 ```
 %% Cell type:markdown id: tags:
 This implementation is integrated into pyfaust as a tool for the Brain Source Localization (BSL) demo which is documented [here](https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/classpyfaust_1_1demo_1_1bsl.html).
 To show off a little, let's run this demo.
 **Hint**: the demo takes a few minutes, it you find it too annoying to wait all this time you can jump to the next cell and render the precomputed data by changing the boolean ``use_precomputed_data`` to ``True``.
 %% Cell type:code id: tags:
 ``` python
 %%capture
 # It will take some time (sorry), many Faust-s are compared to the original MEG matrix
 # However running this cell is not mandatory, it'll be skipped if you switch use_precomputed_data to True in the next code cell
 from pyfaust.demo import bsl
 bsl.run()
 ```
 %% Cell type:code id: tags:
 ``` python
 %%capture --no-display
 %matplotlib inline
 from pyfaust.demo import bsl
 bsl.fig_time_cmp(use_precomputed_data=False)
 ```
 %% Cell type:markdown id: tags:
 What we see in this figure is that it takes a few dozens of milliseconds (the median time) to compute the BSL experiment on the dense matrix M. This is well above the time it takes with Faust approximates $\hat M_6$ to $\hat M_{23}$ in which the numbers 6 and 23 denote the Faust [RCG](https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/classpyfaust_1_1Faust.html#a6a51a05c20041504a0b8f2a73dd8d05a). The greater the RCG the better the computation time is, as we already saw in the [notebook about Faust manipulations](#manip_links).
 %% Cell type:markdown id: tags:
 As a complementary test, let's verify that the two runs of ``omp()`` on FD and D we constructed before for the toy omp give the same results even if the vector to retrieve is not very sparse. Here for instance, $ \| x_1 \|_0 = 98 $
 %% Cell type:code id: tags:
 ``` python
 nnz = 98
 x1 = zeros((2*n, 1))
 nnz_inds = randperm(2*n)[:nnz]
 x1[nnz_inds, 0] = [randn() for i in range(0,nnz)]
 y = FD@x1
 x2 = omp(y, D, maxiter=nnz)
 x3 = omp(y, FD, maxiter=nnz)
 # verify if the solutions differ
 print("Are x2 and x3 solutions almost equal?", norm(x2-x3)/norm(x3) < 10**-12)
 print("Is x1 retrieved into x2?", allclose(x1,x2))
 print("Is x1 retrieved into x3?", allclose(x1,x3))
 ```
 %% Cell type:markdown id: tags:
 As expected, we didn't retrieve our starting x1 (the reason is the condition already discussed in [2.](#2.-The-Test-Case-Dictionary)). However let's mention that here again (like it was with the toy OMP) it works the same with the Faust API or with numpy.
 Finally, let's check the computation time for applying our dictionary to a vector both for the numpy and Faust versions. Although, in order to avoid major differences in results calculated on distinct computer configurations the comparison is performed on a larger dimension than before.
 %% Cell type:code id: tags:
 ``` python
 from numpy.random import randn
 def dirac_hadamard(n):
      FD = hstack((eye(n), wht(n)))
      return FD
 n = 1024
 FD = dirac_hadamard(n)
 D = FD.toarray()
 x = randn(2*n,1)
 %timeit D@x
 %timeit FD@x
 ```
 %% Cell type:markdown id: tags:
 For a dimension as smaller than 128, it's possible on particular machines to obtain a slower FD multiplication comparatively to the D multiplication.
 This is essentially because the speedup offered by Faust appears rather for higher matrix dimensions.
 Let us illustrate the speedup more generally by repeating the experiment for various dimensions n.
 %% Cell type:code id: tags:
 ``` python
 %matplotlib inline
 from numpy.random import randn
 from numpy import array
 from pyfaust import eye, wht
 from time import process_time
 from matplotlib.pyplot import (plot, show,
                               legend, semilogy,
                               xlabel, ylabel,
                               title, scatter)
 d_times = []
 fd_times = []
 dims = []
 num_muls = 100
 for n in [2**i for i in range(8,13)]:
      FD = dirac_hadamard(n)
      D = FD.toarray()
      x = randn(2*n,1)
      dims += [n]
      t = process_time()
      [D@x for i in range(0,num_muls)]
      d_times += [process_time()-t]
      t = process_time()
      [FD@x for i in range(0,num_muls)]
      fd_times += [process_time()-t]
 p1 = semilogy(dims, fd_times, label="FD*x times")
 p2 = semilogy(dims, d_times, label="D*x times")
 xlabel("dimension")
 ylabel("time")
 legend()
 title("D*x and FD*x time comparison")
 show()
 ```
 %% Cell type:markdown id: tags:
 As shown for dimensions n above 1024 an actual speedup occurs, the speedup figure below confirms this result.
 Improving such a speedup and decreasing the dimensions where it occurs is part of the roadmap for future developments of pyfaust.
 %% Cell type:code id: tags:
 ``` python
 scatter(dims, array(d_times)/array(fd_times), label="speedup")
 title("Speedup factor of FD*x relatively to D*x")
 show()
 ```
 %% Cell type:markdown id: tags:
 ***The third notebook is ending here***, I hope you'll be interested in trying yourself to write another algorithm with the FAµST API and maybe discovering any current limitation. Don't hesitate to contact us in that case, we'll appreciate any feedback!
 %% Cell type:markdown id: tags:
 ### Links
 <a name="creation_links">Faust creation (1st) notebook: </a> [html](https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/Faust_creation.html), [ipynb](https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/Faust_creation.ipynb)
 <a name="manip_links">Faust manipulation (2nd) notebook:</a> [html](https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/Faust_manipulation.html), [ipynb](https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/Faust_manipulation.ipynb)
 <a name="[1]">[1]</a> [Tropp, J. A. (2004). Greed is Good: Algorithmic Results for Sparse Approximation. IEEE Transactions on Information Theory, 50(10), 2231–2242](http://doi.org/10.1109/TIT.2004.834793).
+%% Cell type:markdown id: tags:
+**Note**: this notebook was executed using the following pyfaust version:
+%% Cell type:code id: tags:
+``` python
+import pyfaust
+pyfaust.version()
+```