Skip to content

Add document for eye_checker #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yangyaofei merged 1 commit into from
Nov 30, 2021
Merged

Add document for eye_checker #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ native call, make it easier to use.
| Classify | ✔ | ✔ | ✍ | | | | |
| DeepClassify | ✔ | ✔ | ✍ | | | | |
| Cluster | ✔ | ✔ | | ✔ | ✔ | | |
| EyeChecker | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | |
| DocCompare | | | | | | | |
| DocExtractor | ✔ | ✔ | | ✔ | ✔ | | |
| DocParser | | | | | | | |
Expand Down
11 changes: 11 additions & 0 deletions docs/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
Installation
============

Dependency
-----------------

EyeChecker(0.9.14+)依赖 libcurl4 需要安装

.. code:: bash

sudo apt install libcurl4

`yum` 方式同理, 没有用到对应的组件可以不安装

Install from pypi
-----------------

Expand Down
9 changes: 9 additions & 0 deletions docs/nlpir.native.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------------------------------------

Expand Down
8 changes: 8 additions & 0 deletions docs/nlpir.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------------------
Expand Down