doc latex

gen_doc/LaTeX/annexes.tex

@@ -116,23 +116,6 @@ You can generated the target using the terminal command \texttt{xcodebuild} :
 \end{lstlisting}
 
 
-\section{Optional FAuST installation using GPU process}\label{sec:OptionalGPU}
 
-The toolbox FA$\mu$ST integrates optional Graphics Processing Unit (GPU) to improve its performances.
-\paragraph{Warning:} This optional GPU install has only be realized on a Linux machine. There is no guarantee that the installation and the use will be effective for every system.
-
-\begin{itemize}
-\item \textbf{Install} the CUDA Toolkit and the drivers for NVIDIA.
-\item \textbf{Verify install} of GPU tools by typing in a terminal :
-\lstset{style=customBash} 
-\begin{lstlisting}
-> which nvcc
-\end{lstlisting}
-You must obtain the path of your \texttt{nvcc} compiler like 
-\begin{lstlisting}
-/usr/local/cuda-7.5/bin/nvcc
-\end{lstlisting}
-If not, add \texttt{nvcc} directory in your environment path (in your ~/.bashrc file). 
-\end{itemize}
 
 

gen_doc/LaTeX/chapInstallUnix.tex

@@ -296,13 +296,14 @@ Instead the ccmake GUI, an other possibility to configure and generate the proje
 \texttt{cmake\ ..\ -D<BUILD\_NAME>=<value>}
 
 \begin{itemize}
-\item CMAKE\_INSTALL\_PREFIX : Install directory
+\item CMAKE\_INSTALL\_PREFIX : Install directory for the FA$\mu$ST library
+\item CMAKE\_INSTALL\_MATLAB\_PREFIX : Install path directory for the Matlab wrapper
 \item BUILD\_TESTING : Enable the ctest option (default value is ON)
 \item BUILD\_DOCUMENTATION : Generating the doxygen documentation (default value is OFF)  
 \item BUILD\_MULTITHREAD : Enable multithread with OpenMP Multithreading (default value is OFF)
 \item BUILD\_VERBOSE : Enable verbose option when compile (-v) (default value is OFF)
 \item BUILD\_DEBUG : Enable FA$\mu$ST Debug mode (default value is OFF )
-\item BUILD\_USE\_GPU : Using both CPU and GPU process (default value is OFF) (refer to Annex \ref{sec:OptionalGPU} for installation and more detail)
+\item BUILD\_USE\_GPU : Using both CPU and GPU process (default value is OFF) (refer to Section \ref{sec:OptionalGPU} for installation and more detail)
 \item BUILD\_MATLAB\_MEX\_FILES : Enable building Matlab MEX files (default value is ON)
 \item BUILD\_OPENBLAS : Using openBLAS for matrix and vector computations (default value is OFF )
 %\item BUILD\_READ\_XML\_FILE : Using xml2 library to read xml files (default value is OFF)

gen_doc/LaTeX/chapInstallWindows.tex

@@ -61,7 +61,7 @@ You must obtain the path of your matlab binary file like:
 \begin{lstlisting}
 C:\Program Files\MATLAB\<R2015b>\bin\matlab.exe
 \end{lstlisting}
-If not, please add the directory of your \texttt{matlab.exe} file in your environment variable. (to add an environment variable, follow instructions given in \ref{sec:ANNEXEEnvironmentVariableWindows}). \\
+If not, please add the directory of your \texttt{matlab.exe} file in your environment variable. To add an environment variable, follow instructions given in \ref{sec:ANNEXEEnvironmentVariableWindows}. \\
 
 \item \textbf{Verify Matlab} has a MEX supported compiler by typing in a Matlab Command Window :
 \lstset{style=customMatlab}
@@ -436,7 +436,8 @@ When clicking for the first time on the [Configure] button, CMake will ask for t
 
 Here is the list of available options: 
 \begin{itemize}
-\item CMAKE\_INSTALL\_PREFIX : Install directory
+\item CMAKE\_INSTALL\_PREFIX : Install directory for the FA$\mu$ST library
+\item CMAKE\_INSTALL\_MATLAB\_PREFIX : Install path directory for the Matlab wrapper
 \item BUILD\_TESTING : Enable the ctest option (default value is ON)
 \item BUILD\_DOCUMENTATION : Generating the doxygen documentation (default value is OFF)  
 \item BUILD\_MULTITHREAD : Enable multithread with OpenMP Multithreading (default value is OFF)

gen_doc/LaTeX/chapIntroduction.tex

@@ -50,7 +50,7 @@ The Figure \ref{fig:faustStructure} presents a brief structure of the FA$\mu$ST
 \end{enumerate}
 
 
-\paragraph{Organization:}Chapter \ref{sec:InstallUnix} explains how to install the library FA$\mu$ST for UNIX (including Linux and Mac OS X) platform  and Chapter \ref{sec:WinInstall} corresponds to the Windows installation. Chapter \ref{sec:firstUse} shows quickly how to use this library and finally an example is given Chapter \ref{sec:example}. 
+\paragraph{Organization:}Chapter \ref{sec:InstallUnix} explains how to install the library FA$\mu$ST for UNIX (including Linux and Mac OS X) platform  and Chapter \ref{sec:WinInstall} corresponds to the Windows installation. Chapter \ref{sec:firstUse} shows quickly how to use this library and gives an example of application. Finally, a "working progress" part is given Chapter \ref{sec:WorkingProgress} to review the current and future work. 
 
 \paragraph{License:}Copyright (2016) Luc Le Magoarou, Remi Gribonval INRIA Rennes, FRANCE \\
 The FAuST Toolbox is distributed under the terms of the GNU Affero General Public License. This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more details. You should have received a copy of the GNU Affero General Public License along with this program.  If not, see \url{http://www.gnu.org/licenses/}.

gen_doc/LaTeX/chapWorkingProgress.tex

@@ -2,20 +2,20 @@
 Various features are still under development and not yet stable.
 But here is a list of features that will be improved/integrated in the next release :
 \begin{itemize}
-	\item \textbf{Factorization algorithm : } they are available in this release. You can even used them
+	\item \textbf{Factorization algorithm : } They are available in this release. You can even used them
 from user-friendly approach (cf Section \ref{sec:WorkingProgressBuildFromMatrix}) but they are not
 that stable. In the sense that they are not fitted to all types of matrices.
 	\item \textbf{GPU : } A GPU version of the code is under development, it already shows 
 some time saving compared to the CPU code but is not enought user-friendly, easy to install to be in this release.
 	\item \textbf{Python wrapper : } A Python wrapper is also planned, it will used Cython module.
-	\item \textbf{Image denoising experiment (cf \cite[chapter VI.]{LeMagoarou2016}) :} This experiment was in the previous release (Faust version 1.0) 
+	\item \textbf{Image denoising experiment (cf \cite[chapter VI.]{LeMagoarou2016}) :} This experiment was in the previous release (FA$\mu$ST version 1.0) 
 	but is not in the current one because our C++ wrapper is not yet fitted to the algorithm used in this experiment.    
 \end{itemize}
 
-\section{Construct a Faust from a given matrix}\label{sec:WorkingProgressBuildFromMatrix}
+\section{Construct a FAuST from a given matrix}\label{sec:WorkingProgressBuildFromMatrix}
 \paragraph{}
 	After checking that you have configured your Matlab environment (cf section \ref{sec:firstUseMatlabPath})  
-	To see an example of building a Faust from a matrix, you can run \texttt{factorise\_matrix.m} in the Matlab Command Window by typing :
+	To see an example of building a FA$\mu$ST from a matrix, you can run \texttt{factorise\_matrix.m} in the Matlab Command Window by typing :
 \lstset{style=customMatlab}
 \begin{lstlisting}
 >> factorise_matrix
@@ -25,17 +25,59 @@ some time saving compared to the CPU code but is not enought user-friendly, easy
 
 In this script, from a given matrix A of size 100x200 :
 \lstinputlisting[firstline=42,lastline=47,style=customMatlab]{../../misc/demo/Quick_start/factorise_matrix.m}
-We generate the parameters of the factorisation from :
+We generate the parameters of the factorization from :
 \begin{itemize}
 \item The dimension of A (\textbf{dim1} and \textbf{dim2}),
-\item \textbf{nb\_factor} the number of factor of the Faust,
-\item \textbf{rcg} the Rational Complexity Gain, which represents the theoretical memory gain and multiplication speed-up of the Faust compared to the initial matrix .
-\\ \\\textbf{WARNING :}  A trade-off exists between the RCG/speed-up of the Faust and the data fidelity to the input matrix.
-The higher the RCG, the higher the error of the Faust relative to the input matrix
+\item \textbf{nb\_factor} the number of factor of the FA$\mu$ST,
+\item \textbf{rcg} the Rational Complexity Gain, which represents the theoretical memory gain and multiplication speed-up of the FA$\mu$ST compared to the initial matrix .
+\\ \\\textbf{WARNING :}  A trade-off exists between the RCG/speed-up of the FA$\mu$ST and the data fidelity to the input matrix.
+The higher the RCG, the higher the error of the FA$\mu$ST relative to the input matrix
 \end{itemize}
 
 \lstset{style=customBash}
 \lstinputlisting[firstline=51,lastline=56,style=customMatlab]{../../misc/demo/Quick_start/factorise_matrix.m}
-Then we factorize the matrix \textbf{A} into a Faust \textbf{Faust\_A}
+Then we factorize the matrix \textbf{A} into a FA$\mu$ST \textbf{Faust\_A}
 \lstinputlisting[firstline=58,lastline=59,style=customMatlab]{../../misc/demo/Quick_start/factorise_matrix.m}
 
+
+\section{FAuST installation using Optional GPU process}\label{sec:OptionalGPU}
+
+The toolbox FA$\mu$ST integrates optional Graphics Processing Unit (GPU) to improve its time performances.
+\paragraph{Warning:} This optional GPU install has only be realized on a Linux machine. There is no guarantee that the installation and the use will be effective for every system.
+
+\begin{itemize}
+\item \textbf{Install} the CUDA Toolkit from NVIDIA website:  \url{https://developer.nvidia.com/cuda-downloads}).
+\item \textbf{Install} the drivers for NVIDIA from NVIDIA website: \url{http://www.nvidia.fr/Download/index.aspx}.
+\item \textbf{Verify install} of GPU tools by typing in a terminal :
+\lstset{style=customBash} 
+\begin{lstlisting}
+> which nvcc
+\end{lstlisting}
+You must obtain the path of your \texttt{nvcc} compiler like 
+\begin{lstlisting}
+/usr/local/cuda-7.5/bin/nvcc
+\end{lstlisting}
+If not, add \texttt{nvcc} directory in your environment path (in your ~/.bashrc file). 
+\end{itemize}
+
+When prerequisities listed in Section \ref{sec:RequiredTools} are checked, you can get the package FA$\mu$ST.
+\begin{itemize}
+\item \textbf{Download} the FA$\mu$ST package on the website :  \url{http://faust.gforge.inria.fr/}
+\item \textbf{Unzip} the FA$\mu$ST package into your FA$\mu$ST directory.
+\item \textbf{Open} a command terminal
+\item \textbf{Set the current directory} to your FA$\mu$ST directory (NOTE: do not use any special character in your FA$\mu$ST directory path, for example the character $\mu$) and type :
+
+\lstset{style=customBash}
+\begin{lstlisting}
+> mkdir build
+> cd build
+> cmake -DBUILD_USE_GPU="ON" ..
+> make
+> sudo make install # run with administrator privilege
+\end{lstlisting}
+
+\end{itemize}
+
+
+FA$\mu$ST Toolbox should be installed. Now, refer to Quick-Start Chapter \ref{sec:firstUse} to check the install and to try FA$\mu$ST toolbox using GPU process.
+