update doc

aksnzhy · Oct 24, 2018 · 549c7f3 · 549c7f3
1 parent 26542d9
commit 549c7f3
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/cli_api/index.rst b/cli_api/index.rst
@@ -379,7 +379,10 @@ Users can set the number of thread for xLearn by using ``-nthread`` option: ::
 
    ./xlearn_train ./small_train.txt -nthread 2
 
-If you don't set this option, xLearn uses all of the CPU cores by default.
+If you don't set this option, xLearn uses all of the CPU cores by default. xLearn will show the number of threads: ::
+
+    [------------] xLearn uses 2 threads for training task.
+    [ ACTION     ] Read Problem ...
 
 Users can disable lock-free training by using ``--dis-lock-free``: ::
 

diff --git a/python_api/index.rst b/python_api/index.rst
@@ -456,6 +456,11 @@ Users can set the number of thread for xLearn by using ``nthread`` parameter: ::
             
    ffm_model.fit(param, "./model.out") 
 
+xLearn will show the number of threads: ::
+
+    [------------] xLearn uses 4 threads for training task.
+    [ ACTION     ] Read Problem ...
+
 Users can also disable lock-free training by using ``disableLockFree()`` API: ::
 
    import xlearn as xl