Add documentation for the dirgram model

finalfusion · Jun 12, 2019 · 4a75976 · 4a75976
1 parent a77cda4
commit 4a75976
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -12,6 +12,7 @@ word embeddings. finalfrontier currently has the following features:
   * Models:
     - skip-gram (Mikolov et al., 2013)
     - structured skip-gram (Ling et al., 2015)
+    - directional skip-gram (Song et al., 2018)
     - dependency (Levy and Goldberg, 2014)
   * Noise contrastive estimation (Gutmann and Hyvärinen, 2012)
   * Subword representations (Bojanowski et al., 2016)

diff --git a/man/ff-train-skipgram.1.md b/man/ff-train-skipgram.1.md
@@ -75,8 +75,9 @@ OPTIONS
 
 `--model` *MODEL*
 
-:   The model to use for training word embeddings. The choices here are
-    *skipgram* for the skip-gram model (Mikolov et al., 2013) and
+:   The model to use for training word embeddings. The choices here are:
+    *dirgram* for the directional skip-gram model (Song et al., 2018),
+    *skipgram* for the skip-gram model (Mikolov et al., 2013), and
     *structgram* for the stuctured skip-gram model (Ling et al. 2015).
 
     The structured skip-gram model takes the position of a context word