debugged

LiyuanLucasLiu · Sep 15, 2017 · 6146587 · 6146587
1 parent 8fad924
commit 6146587
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 10 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -3,18 +3,38 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
+:github_url: https://github.com/LiyuanLucasLiu/LM-LSTM-CRF
+
 Welcome to LM-LSTM-CRF's documentation!
 =======================================
 
 .. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+   :glob:
+   :maxdepth: 1
+   :caption: training and evaluation
+
+   .. autofunction:: train_wc
+   .. autofunction:: train_w
+   .. autofunction:: eval_wc
+   .. autofunction:: eval_w
+
+.. toctree::
+   :glob:
+   :maxdepth: 1
+   :caption: model
+
+	.. autofunction:: crf
+	.. autofunction:: evaluator
+	.. autofunction:: highway
+	.. autofunction:: lm_lstm_crf
+	.. autofunction:: lstm_crf
+	.. autofunction:: ner_dataset
+	.. autofunction:: utils
 
-   readme
 
 Indices and tables
 ==================
 
 * :ref:`genindex`
 * :ref:`modindex`
-* :ref:`search`
+* :ref:`search`
diff --git a/docs/source/readme.rst b/docs/source/readme.rst
diff --git a/model/lm_lstm_crf.py b/model/lm_lstm_crf.py
@@ -1,6 +1,6 @@
 """
-.. module:: LM_LSTM_CRF
-    :synopsis: LM_LSTM_CRF
+.. module:: lm_lstm_crf
+    :synopsis: lm_lstm_crf
  
 .. moduleauthor:: Liyuan Liu
 """

diff --git a/model/lstm_crf.py b/model/lstm_crf.py
@@ -1,6 +1,6 @@
 """
-.. module:: LSTM_CRF
-    :synopsis: LSTM_CRF
+.. module:: lstm_crf
+    :synopsis: lstm_crf
  
 .. moduleauthor:: Liyuan Liu
 """

diff --git a/model/utils.py b/model/utils.py
@@ -2,7 +2,7 @@
 .. module:: utils
     :synopsis: utility tools
  
-.. moduleauthor:: Liyuan Liu
+.. moduleauthor:: Liyuan Liu, Frank Xu
 """
 
 import codecs