[mlpack] 66/324: Make a note that this set of update rules often creates lots of NaNs when sparse matrices are used.

[Barak A. Pearlmutter]

This is an automated email from the git hooks/post-receive script.

bap pushed a commit to branch svn-trunk
in repository mlpack.

commit 599af89e7a7c2981e1162e31a22d40ea9ae7389e
Author: rcurtin <rcurtin at 9d5b8971-822b-0410-80eb-d18c1038ef23>
Date:   Mon Jun 23 21:39:03 2014 +0000

    Make a note that this set of update rules often creates lots of NaNs when sparse
    matrices are used.
    
    
    git-svn-id: http://svn.cc.gatech.edu/fastlab/mlpack/trunk@16697 9d5b8971-822b-0410-80eb-d18c1038ef23
---
 src/mlpack/methods/amf/update_rules/nmf_mult_div.hpp | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/src/mlpack/methods/amf/update_rules/nmf_mult_div.hpp b/src/mlpack/methods/amf/update_rules/nmf_mult_div.hpp
index b4d7037..3b17f13 100644
--- a/src/mlpack/methods/amf/update_rules/nmf_mult_div.hpp
+++ b/src/mlpack/methods/amf/update_rules/nmf_mult_div.hpp
@@ -9,6 +9,10 @@
  * \f$ \sum_i \sum_j (V_{ij} log\frac{V_{ij}}{(WH)_{ij}}-V_{ij}+(WH)_{ij}) \f$is
  * non-increasing between subsequent iterations. Both of the update rules
  * for W and H are defined in this file.
+ *
+ * This set of update rules is not meant to work with sparse matrices.  Using
+ * sparse matrices often causes NaNs in the output, so other choices of update
+ * rules are better in that situation.
  */
 #ifndef __MLPACK_METHODS_LMF_UPDATE_RULES_NMF_MULT_DIV_HPP
 #define __MLPACK_METHODS_LMF_UPDATE_RULES_NMF_MULT_DIV_HPP
@@ -18,7 +22,6 @@
 namespace mlpack {
 namespace amf {
 
-
 class NMFMultiplicativeDivergenceUpdate
 {
  public:

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/mlpack.git