Improved MatLab build process and some smaller misc changes
[libdai.git] / README
diff --git a/README b/README
index 1d5abbf..9dd8b2e 100644 (file)
--- a/README
+++ b/README
-libDAI - A free/open source C++ library for Discrete Approximate Inference methods
-==================================================================================
+libDAI  -  A free/open source C++ library for Discrete Approximate Inference
 
-v 0.2.2 - September 30, 2008
+-------------------------------------------------------------------------------
 
+Version:  git HEAD
+Date:     February 11, 2010 - or later
+See also: http://www.libdai.org
 
-Copyright (C) 2006-2008  Joris Mooij  [joris dot mooij at tuebingen dot mpg dot de]
-Radboud University Nijmegen, The Netherlands /
-Max Planck Institute for Biological Cybernetics, Germany
+-------------------------------------------------------------------------------
 
-with contributions from:
+License
 
-Martijn Leisink
-Giuseppe Passino
-Frederik Eaton
-Bastian Wemmenhove
-Christian Wojek
-Claudio Lima
-Jiuxiang Hu
-Peter Gober
-Patrick Pletscher
+libDAI is free software; you can redistribute it and/or modify it under the
+terms of the GNU General Public License as published by the Free Software
+Foundation; either version 2 of the License, or (at your option) any later
+version.
 
+libDAI 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 General Public License for more details.
 
-----------------------------------------------------------------------------------
-This file is part of libDAI.
+You should have received a copy of the GNU General Public License
+along with libDAI in the file COPYING. If not, see http://www.gnu.org/licenses/
 
-libDAI is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.
+-------------------------------------------------------------------------------
 
-libDAI 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 General Public License for more details.
+Citing libDAI
 
-You should have received a copy of the GNU General Public License
-along with libDAI; if not, write to the Free Software
-Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
-----------------------------------------------------------------------------------
+If you write a scientific paper describing research that made substantive use
+of this program, please:
+
+  * mention the fashion in which this software was used, including the version
+    number, with a citation to the literature, to allow replication;
+  * mention this software in the Acknowledgements section.
+
+An appropriate citation would be:
 
+Joris M. Mooij et al. (2010) "libDAI 0.2.4: A free/open source C++ library for
+Discrete Approximate Inference", http://www.libdai.org
 
-SCIENTISTS: If you write a scientific paper describing research that made 
-substantive use of this program, please (a) mention the fashion in which 
-this software was used, including the version number, with a citation 
-to the literature, to allow replication; (b) mention this software in the 
-Acknowledgements section.  The appropriate citation is: 
+or in BiBTeX format:
 
-J. M. Mooij (2008) "libDAI 0.2.2: A free/open source C++ library for Discrete 
-Approximate Inference methods", http://mloss.org/software/view/77/.
+  @misc{mooij2010libdai,
+    author = "Joris M. Mooij et al.",
+    title = "lib{DAI} 0.2.4: A free/open source {C}++ library for {D}iscrete {A}pproximate {I}nference",
+    howpublished = "http://www.libdai.org/",
+    year = 2010
+  }
 
-Moreover, as a personal note, I would appreciate it if you would email me with
-citations of papers referencing this work so I can mention them to my funding
-agent and tenure committee.
 
+Moreover, as a personal note, I would appreciate it if you would email
+(citations of) papers referencing this work to joris dot mooij at libdai dot org.
+
+-------------------------------------------------------------------------------
 
 About libDAI
-------------
-libDAI is a free/open source C++ library (licensed under GPL) that provides
+
+libDAI is a free/open source C++ library (licensed under GPL 2+) that provides
 implementations of various (approximate) inference methods for discrete
 graphical models. libDAI supports arbitrary factor graphs with discrete
 variables; this includes discrete Markov Random Fields and Bayesian Networks.
 
-The library is targeted at researchers; to be able to use the library, a good
+The library is targeted at researchers. To be able to use the library, a good
 understanding of graphical models is needed.
 
+The best way to use libDAI is by writing C++ code that invokes the library; in
+addition, part of the functionality is accessibly by using the
+
+  * command line interface
+  * (limited) MatLab interface
+  * (experimental) python interface
+  * (experimental) octave interface.
+
+libDAI can be used to implement novel (approximate) inference algorithms and to
+easily compare the accuracy and performance with existing algorithms that have
+been implemented already.
+
+Features
+
+Currently, libDAI supports the following (approximate) inference methods:
+
+  * Exact inference by brute force enumeration;
+  * Exact inference by junction-tree methods;
+  * Mean Field;
+  * Loopy Belief Propagation [KFL01];
+  * Fractional Belief Propagation [WiH03];
+  * Tree-Reweighted Belief Propagation [WJW03];
+  * Tree Expectation Propagation [MiQ04];
+  * Generalized Belief Propagation [YFW05];
+  * Double-loop GBP [HAK03];
+  * Various variants of Loop Corrected Belief Propagation [MoK07, MoR05];
+  * Gibbs sampler;
+  * Conditioned Belief Propagation [EaG09].
+
+These inference methods can be used to calculate partition sums, marginals over
+subsets of variables, and MAP states (the joint state of variables that has
+maximum probability).
+
+In addition, libDAI supports parameter learning of conditional probability
+tables by Expectation Maximization.
 
 Limitations
------------
+
 libDAI is not intended to be a complete package for approximate inference.
 Instead, it should be considered as an "inference engine", providing various
 inference methods. In particular, it contains no GUI, currently only supports
 its own file format for input and output (although support for standard file
 formats may be added later), and provides very limited visualization
-functionalities.
+functionalities. The only learning method supported currently is Expectation
+Maximization (or Maximum Likelihood if no data is missing) for learning factor
+parameters.
 
+Rationale
 
-Features
---------
-Currently, libDAI supports the following (approximate) inference methods:
+In my opinion, the lack of open source "reference" implementations hampers
+progress in research on approximate inference. Methods differ widely in terms
+of quality and performance characteristics, which also depend in different ways
+on various properties of the graphical models. Finding the best approximate
+inference method for a particular application therefore often requires
+empirical comparisons. However, implementing and debugging these methods takes
+a lot of time which could otherwise be spent on research. I hope that this code
+will aid researchers to be able to easily compare various (existing as well as
+new) approximate inference methods, in this way accelerating research and
+stimulating real-world applications of approximate inference.
 
-    * Exact inference by brute force enumeration;
-    * Exact inference by junction-tree methods;
-    * Mean Field;
-    * Loopy Belief Propagation [KFL01];
-    * Tree Expectation Propagation [MiQ04];
-    * Generalized Belief Propagation [YFW05];
-    * Double-loop GBP [HAK03];
-    * Various variants of Loop Corrected Belief Propagation [MoK07, MoR05];
-    * Gibbs sampler.
+Language
 
-
-Why C++?
---------
 Because libDAI is implemented in C++, it is very fast compared with
 implementations in MatLab (a factor 1000 faster is not uncommon). libDAI does
-provide a MatLab interface for easy integration with MatLab.
+provide a (limited) MatLab interface for easy integration with MatLab. It also
+provides a command line interface and experimental python and octave interfaces
+(thanks to Patrick Pletscher).
 
+Compatibility
 
-Releases
---------
-Releases can be obtained from http://mloss.org/software/view/77/
-License: GNU Public License v2 (or higher).
+The code has been developed under Debian GNU/Linux with the GCC compiler suite.
+libDAI compiles successfully with g++ versions 3.4, 4.1, 4.2 and 4.3.
 
-libDAI-0.2      December 1, 2006
-libDAI-0.2.1    May 26, 2008
-libDAI-0.2.2   September 30, 2008
+libDAI has also been successfully compiled with MS Visual Studio 2008 under
+Windows (but not all build targets are supported yet) and with Cygwin under
+Windows.
 
+Finally, libDAI has been compiled successfully on MacOS X.
 
-Acknowledgments
----------------
-This work is part of the Interactive Collaborative Information Systems (ICIS) 
-project, supported by the Dutch Ministry of Economic Affairs, grant BSIK03024. 
-I would like to thank Martijn Leisink for providing the basis on which libDAI has been built.
+Downloading libDAI
 
+The libDAI sources and documentation can be downloaded from the libDAI website:
+http://www.libdai.org.
 
-Documentation
--------------
-Some doxygen documentation is available. Install doxygen and use "make doc" to build the
-documentation. If the documentation is not clear enough, feel free to send me an email 
-(or even better, to improve the documentation!).
+Mailing list
 
-A description of the factor graph (.fg) file format can be found in the file FILEFORMAT.
+The Google group "libDAI" (http://groups.google.com/group/libdai) can be used
+for getting support and discussing development issues.
+-------------------------------------------------------------------------------
 
+Building libDAI under UNIX variants (Linux / Cygwin / Mac OS X)
 
-Compatibility
--------------
-The code has been developed under Debian GNU/Linux with the GCC compiler suite.
-libDAI compiles successfully with g++ versions 3.4, 4.1, 4.2 and 4.3.
+Preparations
 
-libDAI has also been successfully compiled with MS Visual Studio 2008 under Windows
-(but not all build targets are supported yet) and with Cygwin under Windows.
+You need:
 
-Finally, libDAI has been compiled successfully on MacOS X.
+  * a recent version of gcc (at least version 3.4)
+  * GNU make
+  * doxygen
+  * graphviz
+  * recent boost C++ libraries (at least version 1.34 if you have a recent
+    version of GCC, otherwise at least version 1.37; however, version 1.37
+    shipped with Ubuntu 9.04 is known not to work)
 
+On Debian/Ubuntu, you can easily install all these packages with a single
+command:
+
+  apt-get install g++ make doxygen graphviz libboost-dev libboost-graph-dev libboost-program-options-dev
 
-Quick start (linux/cygwin/Mac OS X)
------------------------------------
-You need:
-- a recent version of gcc (at least version 3.4)
-- GNU make
-- doxygen
-- graphviz
-- recent boost C++ libraries (at least version 1.34, or 1.37 for cygwin)
-
-On Debian/Ubuntu, you can easily install all these packages with a single command:
-"apt-get install g++ make doxygen graphviz libboost-dev libboost-graph-dev libboost-program-options-dev"
 (root permissions needed).
 
-On Mac OS X (10.4 is known to work), these packages can be installed easily via MacPorts.
-First, install MacPorts according to the instructions at http://www.macports.org/
-Then, a simple "sudo port install gmake boost doxygen graphviz"
+On Mac OS X (10.4 is known to work), these packages can be installed easily via
+MacPorts. If MacPorts is not already installed, install it according to the
+instructions at http://www.macports.org/. Then, a simple
+
+  sudo port install gmake boost doxygen graphviz
+
 should be enough to install everything that is needed.
 
-On Cygwin, the prebuilt Cygwin package boost-1.33.1-x is known not to work.
-You can however obtain the latest boost version (you need at least 1.37.0)
-from http://www.boost.org/ and compile/install it with:
+On Cygwin, the prebuilt Cygwin package boost-1.33.1-x is known not to work. You
+can however obtain the latest boost version (you need at least 1.37.0) from
+http://www.boost.org/ and compile/install it with:
 
   ./configure
   make
   make install
 
 
+Building libDAI
+
 To build the libDAI source, first copy a template Makefile.* to Makefile.conf
-(for example, copy Makefile.LINUX to Makefile.conf if you use GNU/Linux). 
-Then, edit the Makefile.conf template to adapt it to your local setup.
-Especially directories may change from system to system. Finally, run
-    
-    make
+(for example, copy Makefile.LINUX to Makefile.conf if you use GNU/Linux). Then,
+edit the Makefile.conf template to adapt it to your local setup. Especially
+directories may differ from system to system. Platform independent build
+options can be set in Makefile.ALL. Finally, run
 
-If the build was successful, you can test the example program:
+  make
+
+The build includes a regression test, which may take a while to complete.
+
+If the build is successful, you can test the example program:
+
+  examples/example tests/alarm.fg
 
-    ./example tests/alarm.fg
+or the more extensive test program:
 
-or the more elaborate test program:
+  tests/testdai --aliases tests/aliases.conf --filename tests/alarm.fg --methods JTREE_HUGIN BP_SEQMAX
 
-    tests/testdai --aliases tests/aliases.conf --filename tests/alarm.fg --methods JTREE_HUGIN BP_SEQMAX
+-------------------------------------------------------------------------------
 
+Building libDAI under Windows
+
+Preparations
 
-Quick start (Windows)
----------------------
 You need:
-- A recent version of MicroSoft Visual Studio (2008 works)
-- recent boost C++ libraries (version 1.34 or higher)
-- GNU make (can be obtained from http://gnuwin32.sourceforge.net)
+
+  * A recent version of MicroSoft Visual Studio (2008 is known to work)
+  * recent boost C++ libraries (version 1.37 or higher)
+  * GNU make (can be obtained from http://gnuwin32.sourceforge.net)
+
 For the regression test, you need:
-- GNU diff, GNU sed (can be obtained from http://gnuwin32.sourceforge.net)
 
-To build the source, copy Makefile.WINDOWS to Makefile.conf. Then, edit 
-Makefile.conf to adapt it to your local setup. Finally, run (from the command line)
-    
-    make
+  * GNU diff, GNU sed (can be obtained from http://gnuwin32.sourceforge.net)
+
+Building libDAI
+
+To build the source, copy Makefile.WINDOWS to Makefile.conf. Then, edit
+Makefile.conf to adapt it to your local setup. Platform independent build
+options can be set in Makefile.ALL. Finally, run (from the command line)
+
+  make
+
+The build includes a regression test, which may take a while to complete.
+
+If the build is successful, you can test the example program:
+
+  examples\example tests\alarm.fg
+
+or the more extensive test program:
+
+  tests\testdai --aliases tests\aliases.conf --filename tests\alarm.fg --methods JTREE_HUGIN BP_SEQMAX
+
+-------------------------------------------------------------------------------
+
+Building the libDAI MatLab interface
+
+You need:
+
+  * MatLab
+  * The platform-dependent requirements described above
+
+First, you need to build the libDAI source as described above for your
+platform. By default, the MatLab interface is disabled, so before compiling the
+source, you have to enable it in Makefile.ALL by setting
+
+  WITH_MATLAB=true
+
+Also, you have to configure the MatLab-specific parts of Makefile.conf to match
+your system (in particular, the Makefile variables ME, MATLABDIR and MEX). The
+MEX file extension depends on your platform; for a 64-bit linux x86_64 system
+this would be "ME=.mexa64", for a 32-bit linux x86 system "ME=.mexglx". If you
+are unsure about your MEX file extension: it needs to be the same as what the
+MatLab command "mexext" returns. The required MEX files are built by issuing
+
+  make
+
+from the command line. The MatLab interface is much less powerful than using
+libDAI from C++. There are two reasons for this: (i) it is boring to write MEX
+files; (ii) the large performance penalty paid when large data structures (like
+factor graphs) have to be converted between their native C++ data structure to
+something that MatLab understands.
+
+A simple example of how to use the MatLab interface is the following (entered
+at the MatLab prompt), which performs exact inference by the junction tree
+algorithm and approximate inference by belief propagation on the ALARM network:
+
+  cd path_to_libdai/matlab
+  [psi] = dai_readfg ('../tests/alarm.fg');
+  [logZ,q,md,qv,qf] = dai (psi, 'JTREE', '[updates=HUGIN,verbose=0]')
+  [logZ,q,md,qv,qf] = dai (psi, 'BP', '[updates=SEQMAX,tol=1e-9,maxiter=10000,logdomain=0]')
+
+where "path_to_libdai" has to be replaced with the directory in which libDAI
+was installed. For other algorithms and some default parameters, see the file
+tests/aliases.conf.
+
+-------------------------------------------------------------------------------
 
-If the build was successful, you can test the example program:
+Building the documentation
 
-    example tests\alarm.fg
+Install doxygen, graphviz and a TeX distribution and use
 
-or the more elaborate test program:
+  make doc
 
-    tests\testdai --aliases tests\aliases.conf --filename tests\alarm.fg --methods JTREE_HUGIN BP_SEQMAX
+to build the documentation. If the documentation is not clear enough, feel free
+to send me an email (or even better, to improve the documentation and send a
+patch!). The documentation can also be browsed online at http://www.libdai.org.