add document for eye_checker (#45)

NLPIR-team · Nov 30, 2021 · 8655b14 · 8655b14
1 parent 895c8ff
commit 8655b14
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -76,6 +76,7 @@ native call, make it easier to use.
 | Classify          |       ✔       |       ✔       |       ✍       |               |                   |                   |               |
 | DeepClassify      |       ✔       |       ✔       |       ✍       |               |                   |                   |               |
 | Cluster           |       ✔       |       ✔       |               |       ✔       |         ✔         |                   |               |
+| EyeChecker        |       ✔       |       ✔       |       ✔       |       ✔       |         ✔         |         ✔         |               |
 | DocCompare        |               |               |               |               |                   |                   |               |
 | DocExtractor      |       ✔       |       ✔       |               |       ✔       |         ✔         |                   |               |
 | DocParser         |               |               |               |               |                   |                   |               |

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -1,6 +1,17 @@
 Installation
 ============
 
+Dependency
+-----------------
+
+EyeChecker(0.9.14+)依赖 libcurl4 需要安装
+
+.. code:: bash
+
+    sudo apt install libcurl4
+
+`yum` 方式同理, 没有用到对应的组件可以不安装
+
 Install from pypi
 -----------------
 

diff --git a/docs/nlpir.native.rst b/docs/nlpir.native.rst
@@ -97,6 +97,15 @@ nlpir.native.text\_similarity module
    :undoc-members:
    :show-inheritance:
 
+nlpir.native.eye\_checker module
+-------------------------------------
+
+.. automodule:: nlpir.native.eye_checker
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
 nlpir.native.nlpir\_base module
 ---------------------------------------
 

diff --git a/docs/nlpir.rst b/docs/nlpir.rst
@@ -89,6 +89,14 @@ nlpir.sentiment_analysis module
    :undoc-members:
    :show-inheritance:
 
+nlpir.eye_checker module
+-------------------------------
+
+.. automodule:: nlpir.eye_checker
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 
 nlpir.tools module
 --------------------