Update documention of the --threads option in the man pages

finalfusion · Nov 3, 2019 · 64429da · 64429da
1 parent 9838f33
commit 64429da
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/man/finalfrontier-deps.1.md b/man/finalfrontier-deps.1.md
@@ -102,8 +102,11 @@ arguments for `buckets`, `minn` and `maxn`.
 
 `--threads` *N*
 
-:   The number of thread to use during training for parallelization. The default
-is to use half of the logical CPUs of the machine.
+:   The number of thread to use during training for
+    parallelization. The default is to use half of the logical CPUs of
+    the machine, capped at 20 threads. Increasing the number of
+    threads increases the probability of update collisions, requiring
+    more epochs to reach the same loss.
 
 `--untyped_deps`
 

diff --git a/man/finalfrontier-skipgram.1.md b/man/finalfrontier-skipgram.1.md
@@ -100,8 +100,11 @@ arguments for `buckets`, `minn` and `maxn`.
 
 `--threads` *N*
 
-:   The number of thread to use during training for parallelization. The
-    default is to use half of the logical CPUs of the machine.
+:   The number of thread to use during training for
+    parallelization. The default is to use half of the logical CPUs of
+    the machine, capped at 20 threads. Increasing the number of
+    threads increases the probability of update collisions, requiring
+    more epochs to reach the same loss.
 
 `--zipf` *EXP*