Commits

Grzegorz Chrupała  committed a918de7

Change default lambda to 1.0
Better info in README.md

  • Participants
  • Parent commits 9096cb7

Comments (0)

Files changed (2)

 from text.  Song et al (2005) and Canini et al (2009) describe a
 simple modification of the Gibbs sampler for LDA to make it run
 online. Colada brings these two ideas together. Slides from CLIN 2012
-comparing of Colada with another word class induction algorithm
+comparing Colada with another word class induction algorithm
 (Chrupala and Alishahi 2010):
 https://bitbucket.org/gchrupala/delta-h/downloads/slides.pdf
 We have used Colada in Chrupała 2012 (in batch mode) and Alishahi
 
 Installation
 ------------
-
 The simplest way to start using colada is to install the [Haskell
 platform](http://www.haskell.org/platform/). Then run the following
 commands in the console:
 
-    > cabal update
-    > cabal install colada --prefix=$HOME
+    cabal update
+    cabal install colada --prefix=$HOME
 
-This will install the latest version of colada in $HOME/bin. Run the
-executable without any arguments for usage help.
+This will install the latest version of colada in $HOME/bin. Run 
+
+    colada help
+
+for usage help.
+
+Quick start
+-----------
+The input format is one word per line, sentences separated by a blank
+line. If the file INPUT contains your input sentences, you can induce
+a 20 word class model, using minibatches of 100 sentences with 10
+passes over each batch, while printing to OUTPUT the word class distributions
+for each token according to the evolving model:
+
+    colada learn --topic-num=20 --batch-size=100 --passes=10 \
+      --progressive --lambda=1.0 MODEL < INPUT > OUTPUT
+
+The model will be saved in the file MODEL. To display a human-readable
+summary of the induces classes, execute:
+
+    colada summary MODEL
 
 References 
 ----------

File colada/Colada/WordClass.hs

                          , _initPasses = 100
                          , _exponent   = Nothing
                          , _progressive= False
-                         , _lambda     = 0.5
+                         , _lambda     = 1.0
                          }
                  
 -- | @learn options xs@ runs the LDA Gibbs sampler for word classes