p71924506
/
deepke
1
0
Fork 0
Code Issues Pull Requests 1 Projects Releases Wiki Activity

delete docs

This commit is contained in:
tlk-dsg 2021-11-04 17:59:37 +08:00
parent b9ad18575b
commit f7b77578aa
37 changed files with 0 additions and 1342 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/Makefile
View File

@ -1,20 +0,0 @@
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

35
docs/make.bat
View File

@ -1,35 +0,0 @@
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build
if "%1" == "" goto help
%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.https://www.sphinx-doc.org/
exit /b 1
)
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
:end
popd

BIN
docs/source/_static/architectures.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 85 KiB

118
docs/source/_static/css/custom.css
View File

@ -1,118 +0,0 @@
a,
.wy-menu-vertical header,
.wy-menu-vertical p.caption,
.wy-nav-top .fa-bars,
.wy-menu-vertical a:hover,
.rst-content code.literal, .rst-content tt.literal
{
color: rgb(0, 63, 136) !important;
}
/* inspired by sphinx press theme */
.wy-menu.wy-menu-vertical li.toctree-l1.current > a {
border-left: solid 8px #4122f0 !important;
border-top: none;
border-bottom: none;
}
.wy-menu.wy-menu-vertical li.toctree-l1.current > ul {
border-left: solid 8px #4719ee !important;
}
/* inspired by sphinx press theme */
.wy-nav-side {
color: unset !important;
background: unset !important;
border-right: solid 1px #ccc !important;
}
.wy-side-nav-search,
.wy-nav-top,
.wy-menu-vertical li,
.wy-menu-vertical li a:hover,
.wy-menu-vertical li a
{
background: unset !important;
}
.wy-menu-vertical li.current a {
border-right: unset !important;
}
.wy-side-nav-search div,
.wy-menu-vertical a {
color: #404040 !important;
}
.wy-menu-vertical button.toctree-expand {
color: #333 !important;
}
.wy-nav-content {
max-width: unset;
}
.rst-content {
max-width: 900px;
}
.wy-nav-content .icon-home:before {
content: "Docs";
}
.wy-side-nav-search .icon-home:before {
content: "";
}
dl.field-list {
display: block !important;
}
dl.field-list > dt:after {
content: "" !important;
}
dl.field-list > dt {
display: table;
padding-left: 6px !important;
padding-right: 6px !important;
margin-bottom: 4px !important;
padding-bottom: 1px !important;
background: #f6ecd852;
border-left: solid 2px #ccc;
}
dl.py.class>dt
{
color: rgba(17, 16, 17, 0.822) !important;
background: rgba(248, 191, 224, 0.1) !important;
border-top: solid 2px #674ef7 !important;
}
dl.py.method>dt
{
background: rgba(248, 191, 224, 0.1) !important;
border-left: solid 2px #bcb3be !important;
}
dl.py.attribute>dt,
dl.py.property>dt
{
background: rgba(194, 233, 248, 0.1) !important;
border-left: solid 2px #58b5cc !important;
}
.fa-plus-square-o::before, .wy-menu-vertical li button.toctree-expand::before,
.fa-minus-square-o::before, .wy-menu-vertical li.current > a button.toctree-expand::before, .wy-menu-vertical li.on a button.toctree-expand::before
{
content: "";
}
.rst-content .viewcode-back,
.rst-content .viewcode-link
{
font-size: 120%;
}

BIN
docs/source/_static/logo.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 207 KiB

82
docs/source/conf.py
View File

@ -1,82 +0,0 @@
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import sys
sys.path.insert(0, os.path.abspath('../../src'))
import sphinx_rtd_theme
import doctest
import deepke
# -- Project information -----------------------------------------------------
project = 'DeepKE'
copyright = '2021, zjunlp'
author = 'tlk'
# The full version, including alpha/beta/rc tags
release = '1.0.0'
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.mathjax',
'sphinx.ext.napoleon',
'sphinx.ext.viewcode',
'sphinx.ext.githubpages',
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx_copybutton',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []
doctest_default_flags = doctest.NORMALIZE_WHITESPACE
autodoc_member_order = 'bysource'
intersphinx_mapping = {'python': ('https://docs.python.org/', None)}
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_css_files = ['css/custom.css']
# html_logo = './_static/logo.png'
html_context = {
"display_github": True, # Integrate GitHub
"github_user": "tlk1997", # Username
"github_repo": "test_doc", # Repo name
"github_version": "main", # Version
"conf_py_path": "/docs/source/", # Path in the checkout to the docs root
}

13
docs/source/deepke.attribution_extraction.rst
View File

@ -1,13 +0,0 @@
deepke.attribution\_extraction package
======================================
.. toctree::
:maxdepth: 4
deepke.attribution_extraction.standard
.. automodule:: deepke.attribution_extraction
:members:
:undoc-members:
:show-inheritance:

61
docs/source/deepke.attribution_extraction.standard.models.rst
View File

@ -1,61 +0,0 @@
deepke.attribution\_extraction.standard.models package
======================================================
deepke.attribution\_extraction.standard.models.BasicModule module
-----------------------------------------------------------------
.. automodule:: deepke.attribution_extraction.standard.models.BasicModule
:members:
:undoc-members:
:show-inheritance:
deepke.attribution\_extraction.standard.models.BiLSTM module
------------------------------------------------------------
.. automodule:: deepke.attribution_extraction.standard.models.BiLSTM
:members:
:undoc-members:
:show-inheritance:
deepke.attribution\_extraction.standard.models.Capsule module
-------------------------------------------------------------
.. automodule:: deepke.attribution_extraction.standard.models.Capsule
:members:
:undoc-members:
:show-inheritance:
deepke.attribution\_extraction.standard.models.GCN module
---------------------------------------------------------
.. automodule:: deepke.attribution_extraction.standard.models.GCN
:members:
:undoc-members:
:show-inheritance:
deepke.attribution\_extraction.standard.models.LM module
--------------------------------------------------------
.. automodule:: deepke.attribution_extraction.standard.models.LM
:members:
:undoc-members:
:show-inheritance:
deepke.attribution\_extraction.standard.models.PCNN module
----------------------------------------------------------
.. automodule:: deepke.attribution_extraction.standard.models.PCNN
:members:
:undoc-members:
:show-inheritance:
deepke.attribution\_extraction.standard.models.Transformer module
-----------------------------------------------------------------
.. automodule:: deepke.attribution_extraction.standard.models.Transformer
:members:
:undoc-members:
:show-inheritance:

61
docs/source/deepke.attribution_extraction.standard.module.rst
View File

@ -1,61 +0,0 @@
deepke.attribution\_extraction.standard.module package
======================================================
deepke.attribution\_extraction.standard.module.Attention module
---------------------------------------------------------------
.. automodule:: deepke.attribution_extraction.standard.module.Attention
:members:
:undoc-members:
:show-inheritance:
deepke.attribution\_extraction.standard.module.CNN module
---------------------------------------------------------
.. automodule:: deepke.attribution_extraction.standard.module.CNN
:members:
:undoc-members:
:show-inheritance:
deepke.attribution\_extraction.standard.module.Capsule module
-------------------------------------------------------------
.. automodule:: deepke.attribution_extraction.standard.module.Capsule
:members:
:undoc-members:
:show-inheritance:
deepke.attribution\_extraction.standard.module.Embedding module
---------------------------------------------------------------
.. automodule:: deepke.attribution_extraction.standard.module.Embedding
:members:
:undoc-members:
:show-inheritance:
deepke.attribution\_extraction.standard.module.GCN module
---------------------------------------------------------
.. automodule:: deepke.attribution_extraction.standard.module.GCN
:members:
:undoc-members:
:show-inheritance:
deepke.attribution\_extraction.standard.module.RNN module
---------------------------------------------------------
.. automodule:: deepke.attribution_extraction.standard.module.RNN
:members:
:undoc-members:
:show-inheritance:
deepke.attribution\_extraction.standard.module.Transformer module
-----------------------------------------------------------------
.. automodule:: deepke.attribution_extraction.standard.module.Transformer
:members:
:undoc-members:
:show-inheritance:

13
docs/source/deepke.attribution_extraction.standard.rst
View File

@ -1,13 +0,0 @@
deepke.attribution\_extraction.standard package
===============================================
.. toctree::
:maxdepth: 4
deepke.attribution_extraction.standard.models
deepke.attribution_extraction.standard.module
deepke.attribution_extraction.standard.tools
deepke.attribution_extraction.standard.utils

53
docs/source/deepke.attribution_extraction.standard.tools.rst
View File

@ -1,53 +0,0 @@
deepke.attribution\_extraction.standard.tools package
=====================================================
deepke.attribution\_extraction.standard.tools.dataset module
------------------------------------------------------------
.. automodule:: deepke.attribution_extraction.standard.tools.dataset
:members:
:undoc-members:
:show-inheritance:
deepke.attribution\_extraction.standard.tools.metrics module
------------------------------------------------------------
.. automodule:: deepke.attribution_extraction.standard.tools.metrics
:members:
:undoc-members:
:show-inheritance:
deepke.attribution\_extraction.standard.tools.preprocess module
---------------------------------------------------------------
.. automodule:: deepke.attribution_extraction.standard.tools.preprocess
:members:
:undoc-members:
:show-inheritance:
deepke.attribution\_extraction.standard.tools.serializer module
---------------------------------------------------------------
.. automodule:: deepke.attribution_extraction.standard.tools.serializer
:members:
:undoc-members:
:show-inheritance:
deepke.attribution\_extraction.standard.tools.trainer module
------------------------------------------------------------
.. automodule:: deepke.attribution_extraction.standard.tools.trainer
:members:
:undoc-members:
:show-inheritance:
deepke.attribution\_extraction.standard.tools.vocab module
----------------------------------------------------------
.. automodule:: deepke.attribution_extraction.standard.tools.vocab
:members:
:undoc-members:
:show-inheritance:

20
docs/source/deepke.attribution_extraction.standard.utils.rst
View File

@ -1,20 +0,0 @@
deepke.attribution\_extraction.standard.utils package
=====================================================
deepke.attribution\_extraction.standard.utils.ioUtils module
------------------------------------------------------------
.. automodule:: deepke.attribution_extraction.standard.utils.ioUtils
:members:
:undoc-members:
:show-inheritance:
deepke.attribution\_extraction.standard.utils.nnUtils module
------------------------------------------------------------
.. automodule:: deepke.attribution_extraction.standard.utils.nnUtils
:members:
:undoc-members:
:show-inheritance:

21
docs/source/deepke.name_entity_re.few_shot.models.rst
View File

@ -1,21 +0,0 @@
deepke.name\_entity\_re.few\_shot.models package
================================================
deepke.name\_entity\_re.few\_shot.models.model module
-----------------------------------------------------
.. automodule:: deepke.name_entity_re.few_shot.models.model
:members:
:undoc-members:
:show-inheritance:
deepke.name\_entity\_re.few\_shot.models.modeling\_bart module
--------------------------------------------------------------
.. automodule:: deepke.name_entity_re.few_shot.models.modeling_bart
:members:
:undoc-members:
:show-inheritance:

36
docs/source/deepke.name_entity_re.few_shot.module.rst
View File

@ -1,36 +0,0 @@
deepke.name\_entity\_re.few\_shot.module package
================================================
deepke.name\_entity\_re.few\_shot.module.datasets module
--------------------------------------------------------
.. automodule:: deepke.name_entity_re.few_shot.module.datasets
:members:
:undoc-members:
:show-inheritance:
deepke.name\_entity\_re.few\_shot.module.mapping\_type module
-------------------------------------------------------------
.. automodule:: deepke.name_entity_re.few_shot.module.mapping_type
:members:
:undoc-members:
:show-inheritance:
deepke.name\_entity\_re.few\_shot.module.metrics module
-------------------------------------------------------
.. automodule:: deepke.name_entity_re.few_shot.module.metrics
:members:
:undoc-members:
:show-inheritance:
deepke.name\_entity\_re.few\_shot.module.train module
-----------------------------------------------------
.. automodule:: deepke.name_entity_re.few_shot.module.train
:members:
:undoc-members:
:show-inheritance:

10
docs/source/deepke.name_entity_re.few_shot.rst
View File

@ -1,10 +0,0 @@
deepke.name\_entity\_re.few\_shot package
=========================================
.. toctree::
:maxdepth: 4
deepke.name_entity_re.few_shot.models
deepke.name_entity_re.few_shot.module
deepke.name_entity_re.few_shot.utils

12
docs/source/deepke.name_entity_re.few_shot.utils.rst
View File

@ -1,12 +0,0 @@
deepke.name\_entity\_re.few\_shot.utils package
===============================================
deepke.name\_entity\_re.few\_shot.utils.util module
---------------------------------------------------
.. automodule:: deepke.name_entity_re.few_shot.utils.util
:members:
:undoc-members:
:show-inheritance:

10
docs/source/deepke.name_entity_re.rst
View File

@ -1,10 +0,0 @@
deepke.name\_entity\_re package
===============================
.. toctree::
:maxdepth: 4
deepke.name_entity_re.few_shot
deepke.name_entity_re.standard

12
docs/source/deepke.name_entity_re.standard.models.rst
View File

@ -1,12 +0,0 @@
deepke.name\_entity\_re.standard.models package
===============================================
deepke.name\_entity\_re.standard.models.InferBert module
--------------------------------------------------------
.. automodule:: deepke.name_entity_re.standard.models.InferBert
:members:
:undoc-members:
:show-inheritance:

10
docs/source/deepke.name_entity_re.standard.rst
View File

@ -1,10 +0,0 @@
deepke.name\_entity\_re.standard package
========================================
.. toctree::
:maxdepth: 4
deepke.name_entity_re.standard.models
deepke.name_entity_re.standard.tools

19
docs/source/deepke.name_entity_re.standard.tools.rst
View File

@ -1,19 +0,0 @@
deepke.name\_entity\_re.standard.tools package
==============================================
deepke.name\_entity\_re.standard.tools.dataset module
-----------------------------------------------------
.. automodule:: deepke.name_entity_re.standard.tools.dataset
:members:
:undoc-members:
:show-inheritance:
deepke.name\_entity\_re.standard.tools.preprocess module
--------------------------------------------------------
.. automodule:: deepke.name_entity_re.standard.tools.preprocess
:members:
:undoc-members:
:show-inheritance:

51
docs/source/deepke.relation_extraction.document.rst
View File

@ -1,51 +0,0 @@
deepke.relation\_extraction.document package
============================================
deepke.relation\_extraction.document.evaluation module
------------------------------------------------------
.. automodule:: deepke.relation_extraction.document.evaluation
:members:
:undoc-members:
:show-inheritance:
deepke.relation\_extraction.document.losses module
--------------------------------------------------
.. automodule:: deepke.relation_extraction.document.losses
:members:
:undoc-members:
:show-inheritance:
deepke.relation\_extraction.document.model module
-------------------------------------------------
.. automodule:: deepke.relation_extraction.document.model
:members:
:undoc-members:
:show-inheritance:
deepke.relation\_extraction.document.module module
--------------------------------------------------
.. automodule:: deepke.relation_extraction.document.module
:members:
:undoc-members:
:show-inheritance:
deepke.relation\_extraction.document.prepro module
--------------------------------------------------
.. automodule:: deepke.relation_extraction.document.prepro
:members:
:undoc-members:
:show-inheritance:
deepke.relation\_extraction.document.utils module
-------------------------------------------------
.. automodule:: deepke.relation_extraction.document.utils
:members:
:undoc-members:
:show-inheritance:

28
docs/source/deepke.relation_extraction.few_shot.dataset.rst
View File

@ -1,28 +0,0 @@
deepke.relation\_extraction.few\_shot.dataset package
=====================================================
deepke.relation\_extraction.few\_shot.dataset.base\_data\_module module
-----------------------------------------------------------------------
.. automodule:: deepke.relation_extraction.few_shot.dataset.base_data_module
:members:
:undoc-members:
:show-inheritance:
deepke.relation\_extraction.few\_shot.dataset.dialogue module
-------------------------------------------------------------
.. automodule:: deepke.relation_extraction.few_shot.dataset.dialogue
:members:
:undoc-members:
:show-inheritance:
deepke.relation\_extraction.few\_shot.dataset.processor module
--------------------------------------------------------------
.. automodule:: deepke.relation_extraction.few_shot.dataset.processor
:members:
:undoc-members:
:show-inheritance:

28
docs/source/deepke.relation_extraction.few_shot.lit_models.rst
View File

@ -1,28 +0,0 @@
deepke.relation\_extraction.few\_shot.lit\_models package
=========================================================
deepke.relation\_extraction.few\_shot.lit\_models.base module
-------------------------------------------------------------
.. automodule:: deepke.relation_extraction.few_shot.lit_models.base
:members:
:undoc-members:
:show-inheritance:
deepke.relation\_extraction.few\_shot.lit\_models.transformer module
--------------------------------------------------------------------
.. automodule:: deepke.relation_extraction.few_shot.lit_models.transformer
:members:
:undoc-members:
:show-inheritance:
deepke.relation\_extraction.few\_shot.lit\_models.util module
-------------------------------------------------------------
.. automodule:: deepke.relation_extraction.few_shot.lit_models.util
:members:
:undoc-members:
:show-inheritance:

27
docs/source/deepke.relation_extraction.few_shot.rst
View File

@ -1,27 +0,0 @@
deepke.relation\_extraction.few\_shot package
=============================================
.. toctree::
:maxdepth: 4
deepke.relation_extraction.few_shot.dataset
deepke.relation_extraction.few_shot.lit_models
deepke.relation\_extraction.few\_shot.generate\_k\_shot module
--------------------------------------------------------------
.. automodule:: deepke.relation_extraction.few_shot.generate_k_shot
:members:
:undoc-members:
:show-inheritance:
deepke.relation\_extraction.few\_shot.get\_label\_word module
-------------------------------------------------------------
.. automodule:: deepke.relation_extraction.few_shot.get_label_word
:members:
:undoc-members:
:show-inheritance:

11
docs/source/deepke.relation_extraction.rst
View File

@ -1,11 +0,0 @@
deepke.relation\_extraction package
===================================
.. toctree::
:maxdepth: 4
deepke.relation_extraction.document
deepke.relation_extraction.few_shot
deepke.relation_extraction.standard

59
docs/source/deepke.relation_extraction.standard.models.rst
View File

@ -1,59 +0,0 @@
deepke.relation\_extraction.standard.models package
===================================================
deepke.relation\_extraction.standard.models.BasicModule module
--------------------------------------------------------------
.. automodule:: deepke.relation_extraction.standard.models.BasicModule
:members:
:undoc-members:
:show-inheritance:
deepke.relation\_extraction.standard.models.BiLSTM module
---------------------------------------------------------
.. automodule:: deepke.relation_extraction.standard.models.BiLSTM
:members:
:undoc-members:
:show-inheritance:
deepke.relation\_extraction.standard.models.Capsule module
----------------------------------------------------------
.. automodule:: deepke.relation_extraction.standard.models.Capsule
:members:
:undoc-members:
:show-inheritance:
deepke.relation\_extraction.standard.models.GCN module
------------------------------------------------------
.. automodule:: deepke.relation_extraction.standard.models.GCN
:members:
:undoc-members:
:show-inheritance:
deepke.relation\_extraction.standard.models.LM module
-----------------------------------------------------
.. automodule:: deepke.relation_extraction.standard.models.LM
:members:
:undoc-members:
:show-inheritance:
deepke.relation\_extraction.standard.models.PCNN module
-------------------------------------------------------
.. automodule:: deepke.relation_extraction.standard.models.PCNN
:members:
:undoc-members:
:show-inheritance:
deepke.relation\_extraction.standard.models.Transformer module
--------------------------------------------------------------
.. automodule:: deepke.relation_extraction.standard.models.Transformer
:members:
:undoc-members:
:show-inheritance:

59
docs/source/deepke.relation_extraction.standard.module.rst
View File

@ -1,59 +0,0 @@
deepke.relation\_extraction.standard.module package
===================================================
deepke.relation\_extraction.standard.module.Attention module
------------------------------------------------------------
.. automodule:: deepke.relation_extraction.standard.module.Attention
:members:
:undoc-members:
:show-inheritance:
deepke.relation\_extraction.standard.module.CNN module
------------------------------------------------------
.. automodule:: deepke.relation_extraction.standard.module.CNN
:members:
:undoc-members:
:show-inheritance:
deepke.relation\_extraction.standard.module.Capsule module
----------------------------------------------------------
.. automodule:: deepke.relation_extraction.standard.module.Capsule
:members:
:undoc-members:
:show-inheritance:
deepke.relation\_extraction.standard.module.Embedding module
------------------------------------------------------------
.. automodule:: deepke.relation_extraction.standard.module.Embedding
:members:
:undoc-members:
:show-inheritance:
deepke.relation\_extraction.standard.module.GCN module
------------------------------------------------------
.. automodule:: deepke.relation_extraction.standard.module.GCN
:members:
:undoc-members:
:show-inheritance:
deepke.relation\_extraction.standard.module.RNN module
------------------------------------------------------
.. automodule:: deepke.relation_extraction.standard.module.RNN
:members:
:undoc-members:
:show-inheritance:
deepke.relation\_extraction.standard.module.Transformer module
--------------------------------------------------------------
.. automodule:: deepke.relation_extraction.standard.module.Transformer
:members:
:undoc-members:
:show-inheritance:

12
docs/source/deepke.relation_extraction.standard.rst
View File

@ -1,12 +0,0 @@
deepke.relation\_extraction.standard package
============================================
.. toctree::
:maxdepth: 4
deepke.relation_extraction.standard.models
deepke.relation_extraction.standard.module
deepke.relation_extraction.standard.tools
deepke.relation_extraction.standard.utils

52
docs/source/deepke.relation_extraction.standard.tools.rst
View File

@ -1,52 +0,0 @@
deepke.relation\_extraction.standard.tools package
==================================================
deepke.relation\_extraction.standard.tools.dataset module
---------------------------------------------------------
.. automodule:: deepke.relation_extraction.standard.tools.dataset
:members:
:undoc-members:
:show-inheritance:
deepke.relation\_extraction.standard.tools.metrics module
---------------------------------------------------------
.. automodule:: deepke.relation_extraction.standard.tools.metrics
:members:
:undoc-members:
:show-inheritance:
deepke.relation\_extraction.standard.tools.preprocess module
------------------------------------------------------------
.. automodule:: deepke.relation_extraction.standard.tools.preprocess
:members:
:undoc-members:
:show-inheritance:
deepke.relation\_extraction.standard.tools.serializer module
------------------------------------------------------------
.. automodule:: deepke.relation_extraction.standard.tools.serializer
:members:
:undoc-members:
:show-inheritance:
deepke.relation\_extraction.standard.tools.trainer module
---------------------------------------------------------
.. automodule:: deepke.relation_extraction.standard.tools.trainer
:members:
:undoc-members:
:show-inheritance:
deepke.relation\_extraction.standard.tools.vocab module
-------------------------------------------------------
.. automodule:: deepke.relation_extraction.standard.tools.vocab
:members:
:undoc-members:
:show-inheritance:

20
docs/source/deepke.relation_extraction.standard.utils.rst
View File

@ -1,20 +0,0 @@
deepke.relation\_extraction.standard.utils package
==================================================
deepke.relation\_extraction.standard.utils.ioUtils module
---------------------------------------------------------
.. automodule:: deepke.relation_extraction.standard.utils.ioUtils
:members:
:undoc-members:
:show-inheritance:
deepke.relation\_extraction.standard.utils.nnUtils module
---------------------------------------------------------
.. automodule:: deepke.relation_extraction.standard.utils.nnUtils
:members:
:undoc-members:
:show-inheritance:

12
docs/source/deepke.rst
View File

@ -1,12 +0,0 @@
DeepKE
======
.. toctree::
:maxdepth: 4
deepke.attribution_extraction
deepke.name_entity_re
deepke.relation_extraction

104
docs/source/example.rst
View File

@ -1,104 +0,0 @@
Example
=======
standard_ner
------------
- The standard module is implemented by the pretrained model BERT.
- Enter ``DeepKE/example/ner/standard`` .
- The dataset and parameters can be customized in the ``data`` folder and ``conf`` folder respectively.
- **Train**: `python run.py`
- **Predict**: `python predict.py`
.. code-block:: bash
cd example/ner/standard
python run.py
python predict.py
few-shot_ner
------------
- This module is in the low-resouce scenario.
- Enter ``DeepKE/example/ner/few-shot`` .
- The directory where the model is loaded and saved and the configuration parameters can be cusomized in the ``conf`` folder.
- **Train with CoNLL-2003**: `python run.py`
- **Train in the few-shot scenario**: `python run.py +train=few_shot`. Users can modify `load_path` in ``conf/train/few_shot.yaml`` with the use of existing loaded model.
- **Predict**: add `- predict` to ``conf/config.yaml`` , modify `loda_path` as the model path and `write_path` as the path where the predicted results are saved in ``conf/predict.yaml`` , and then run `python predict.py`
.. code-block:: bash
cd example/ner/few-shot
python run.py
python predict.py
standard_re
-----------
- The standard module is implemented by common deep learning models, including CNN, RNN, Capsule, GCN, Transformer and the pretrained model.
- Enter the ``DeepKE/example/re/standard`` folder.
- The dataset and parameters can be customized in the ``data`` folder and ``conf`` folder respectively.
- **Train**: `python run.py`
- **Predict**: `python predict.py`
.. code-block:: bash
cd example/re/standard
python run.py
python predict.py
few-shot_re
-----------
- This module is in the low-resouce scenario.
- Enter ``DeepKE/example/re/few-shot`` .
- **Train**: `python run.py`
Start with the model trained last time: modify `train_from_saved_model` in ``conf/train.yaml`` as the path where the model trained last time was saved.
And the path saving logs generated in training can be customized by ``log_dir``.
- **Predict**: `python predict.py`
.. code-block:: bash
cd example/re/few-shot
python run.py
python predict.py
document_re
-----------
- Download the model `train_distant.json` from [*Google Drive*](https://drive.google.com/drive/folders/1c5-0YwnoJx8NS6CV2f-NoTHR__BdkNqw) to ``data/``.
- Enter ``DeepKE/example/re/document`` .
- **Train**: `python run.py`
Start with the model trained last time: modify `train_from_saved_model` in ``conf/train.yaml`` as the path where the model trained last time was saved.
And the path saving logs generated in training can be customized by ``log_dir``.
- **Predict**: `python predict.py`
.. code-block:: bash
cd example/re/document
python run.py
python predict.py
standard_ae
-----------
- The standard module is implemented by common deep learning models, including CNN, RNN, Capsule, GCN, Transformer and the pretrained model.
- Enter the ``DeepKE/example/ae/standard`` folder.
- The dataset and parameters can be customized in the ``data`` folder and ``conf`` folder respectively.
- **Train**: `python run.py`
- **Predict**: `python predict.py`
.. code-block:: bash
cd example/ae/regular
python run.py
python predict.py
More details , you can refer to https://www.bilibili.com/video/BV1n44y1x7iW?spm_id_from=333.999.0.0 .

118
docs/source/example_cn.rst
View File

@ -1,118 +0,0 @@
Example
=======
standard_ner
------------
进入 ``example/ner/standard`` 可使用全监督实体抽取模型。
在 ``data`` 文件夹下存放数据，训练等参数都在 ``conf`` 文件夹中，可修改使用。
运行 `run.py` 即可进行训练，运行 `predict.py` 即可进行预测。
.. code-block:: bash
cd example/ner/standard
python run.py
python predict.py
few-shot_ner
------------
进入 ``example/ner/few-shot`` 可使用少样本实体抽取模型。
在 ``data`` 文件夹下存放数据，包含 `conll2003` ， `mit-movie` ， `mit-restaurant` 和 `atis` 等数据集。
训练等参数都在 ``conf`` 文件夹中，可修改使用。
运行 `python run.py` 即可对conll2003数据集进行训练，`python run.py +train=few_shot` 可进行少样本训练。
在 `config.yaml` 中加入 `- predict` ， 再在 `predict.yaml` 中修改 `load_path` 为模型路径以及 `write_path` 为预测结果保存路径，再 `python predict.py` 可进行预测。
.. code-block:: bash
cd example/ner/few-shot
python run.py
python predict.py
standard_re
-----------
进入 ``example/re/standard`` 可使用全监督关系抽取模型。
在 ``data/origin`` 文件夹下存放数据，训练等参数都在 ``conf`` 文件夹中，可修改使用。
运行 `python run.py` 即可进行训练，运行 `python redict.py` 即可进行预测。
.. code-block:: bash
cd example/re/standard
python run.py
python predict.py
few-shot_re
-----------
进入 ``example/re/few-shot`` 可使用少样本关系抽取模型。
在 ``data`` 文件夹下存放数据，模型采用的数据集是SEMEVAL，SEMEVAL数据集来自于2010年的国际语义评测大会中 `Task 8："Multi-Way Classification of Semantic Relations Between Pairs of Nominals"` 。
训练等参数都在 ``conf`` 文件夹中，可修改使用。
运行 `python run.py` 即可进行训练,设置 ``conf`` 中 `train_from_saved_model` 为上次保存模型的路径即可从上次训练的模型开始训练
运行 `python predict.py` 即可进行预测。
.. code-block:: bash
cd example/re/few-shot
python run.py
python predict.py
document_re
-----------
进入 ``example/re/document`` 可使用全监督关系抽取模型。
在 ``data`` 文件夹下存放数据，模型采用的数据集是 `DocRED` ，其中包含的 `train_distant.json` 由于文件太大，可自行从 https://drive.google.com/drive/folders/1c5-0YwnoJx8NS6CV2f-NoTHR__BdkNqw 上下载到data/目录下
训练等参数都在 ``conf`` 文件夹中，可修改使用。
运行 `python run.py` 即可进行训练，设置 ``conf`` 中 `train_from_saved_model` 为上次保存模型的路径即可从上次训练的模型开始训练。
运行 `python redict.py` 即可进行预测。最终生成的 `result.json` 文件保存在根目录。
.. code-block:: bash
cd example/re/document
python run.py
python predict.py
standard_ae
-----------
进入 ``example/ae/standard`` 可使用全监督属性抽取模型。
在 ``data/origin`` 文件夹下存放数据，训练等参数都在 ``conf`` 文件夹中，可修改使用。
运行 `python run.py` 即可进行训练，运行 `python predict.py` 即可进行预测。
.. code-block:: bash
cd example/ae/standard
python run.py
python predict.py
具体流程，请参考 https://www.bilibili.com/video/BV1n44y1x7iW?spm_id_from=333.999.0.0

6
docs/source/faq.rst
View File

@ -1,6 +0,0 @@
FAQ
===
This page maintains frequently asked questions about DeepKE.

24
docs/source/index.rst
View File

@ -1,24 +0,0 @@
DeepKE Documentation
====================
.. toctree::
:glob:
:maxdepth: 1
:caption: Getting Started
start
install
example
faq
.. toctree::
:glob:
:maxdepth: 5
:caption: Package
deepke

31
docs/source/install.rst
View File

@ -1,31 +0,0 @@
Install
=======
create conda
------------
First , create a virtual environment (recommend anaconda)
.. code-block:: python
conda create -n deepke python=3.8
conda activate deepke
install by pypi
---------------
If use deepke directly
.. code-block:: python
pip install deepke
install by setup.py
-------------------
If modify source codes before usage
.. code-block:: python
python setup.py install

94
docs/source/start.rst
View File

@ -1,94 +0,0 @@
Start
=====
Introduction
------------
.. image:: ./_static/logo.png
DeepKE is a knowledge extraction toolkit supporting low-resource and document-level scenarios. It provides three functions based PyTorch, including Named Entity Recognition, Relation Extraciton and Attribute Extraction.
Model Framework
---------------
.. image:: ./_static/architectures.png
DeepKE contains three modules for named entity recognition, relation extraction and attribute extraction, the three tasks respectively.
Each module has its own submodules. For example, there are standard, document-level and few-shot submodules in the attribute extraction modular.
Each submodule compose of three parts: a collection of tools, which can function as tokenizer, dataloader, preprocessor and the like, a encoder and a part for training and prediction
Dataset
-------
We use the following datasets in our experiments:
+--------------------------+-----------+------------------+----------+------------+
| Task | Settings | Corpus | Language | Model |
+==========================+===========+==================+==========+============+
| | | CoNLL-2003 | English | |
| | Standard +------------------+----------+ BERT |
| | | People's Daily | Chinese | |
| +-----------+------------------+----------+------------+
| | | CoNLL-2003 | | |
| | +------------------+ | |
| Name Entity Recognition | | MIT Movie | | |
| | Few-shot +------------------+ English | LightNER |
| | | MIT Restaurant | | |
| | +------------------+ | |
| | | ATIS | | |
+--------------------------+-----------+------------------+----------+------------+
| | | | | CNN |
| | | | +------------+
| | | | | RNN |
| | | | +------------+
| | | | | Capsule |
| | Standard | DuIE | Chinese +------------+
| | | | | GCN |
| | | | +------------+
| | | | | Transformer|
| | | | +------------+
| | | | | BERT |
| +-----------+------------------+----------+------------+
| Relation Extraction | | SEMEVAL(8-shot) | | |
| | +------------------+ | |
| | | SEMEVAL(16-shot) | | |
| | Few-shot +------------------+ English | KnowPrompt |
| | | SEMEVAL(32-shot) | | |
| | +------------------+ | |
| | | SEMEVAL(Full) | | |
| +-----------+------------------+----------+------------+
| | | DocRED | | |
| | +------------------+ | |
| | Document | CDR | English | DocuNet |
| | +------------------+ | |
| | | GDA | | |
+--------------------------+-----------+------------------+----------+------------+
| | | | | CNN |
| | | | +------------+
| | | | | RNN |
| | | | +------------+
| | |Triplet Extraction| | Capsule |
| Attribute Extraction | Standard |Dataset 2 | Chinese +------------+
| | | | | GCN |
| | | | +------------+
| | | | | Transformer|
| | | | +------------+
| | | | | BERT |
+--------------------------+-----------+------------------+----------+------------+
Get Start
---------
If you want to use our code , you can do as follow:
.. code-block:: python
git clone https://github.com/zjunlp/DeepKE.git
cd DeepKE