From 269e28cc795eb22ba4414a37c916b7a8c174e5d8 Mon Sep 17 00:00:00 2001 From: ChenXin Date: Mon, 13 May 2019 00:23:55 +0800 Subject: [PATCH] =?UTF-8?q?=E5=8A=A0=E4=B8=8A=E4=BA=86=20titlesonly=20?= =?UTF-8?q?=E8=BF=99=E4=B8=AA=E8=AE=BE=E7=BD=AE?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/source/fastNLP.core.rst | 1 + docs/source/fastNLP.io.rst | 1 + docs/source/fastNLP.models.rst | 1 + docs/source/fastNLP.modules.aggregator.rst | 1 + docs/source/fastNLP.modules.decoder.rst | 1 + docs/source/fastNLP.modules.encoder.rst | 1 + docs/source/fastNLP.modules.rst | 1 + docs/source/fastNLP.rst | 1 + docs/source/index.rst | 9 ++++----- docs/source/modules.rst | 1 + 10 files changed, 13 insertions(+), 5 deletions(-) diff --git a/docs/source/fastNLP.core.rst b/docs/source/fastNLP.core.rst index 932c6b21..ba784a59 100644 --- a/docs/source/fastNLP.core.rst +++ b/docs/source/fastNLP.core.rst @@ -10,6 +10,7 @@ fastNLP.core 模块 ---------- .. toctree:: + :titlesonly: fastNLP.core.batch fastNLP.core.callback diff --git a/docs/source/fastNLP.io.rst b/docs/source/fastNLP.io.rst index ae28573d..88498d9a 100644 --- a/docs/source/fastNLP.io.rst +++ b/docs/source/fastNLP.io.rst @@ -10,6 +10,7 @@ fastNLP.io 模块 ---------- .. toctree:: + :titlesonly: fastNLP.io.base_loader fastNLP.io.dataset_loader diff --git a/docs/source/fastNLP.models.rst b/docs/source/fastNLP.models.rst index c1be3a4c..2c243295 100644 --- a/docs/source/fastNLP.models.rst +++ b/docs/source/fastNLP.models.rst @@ -10,6 +10,7 @@ fastNLP.models 模块 ---------- .. toctree:: + :titlesonly: fastNLP.models.base_model fastNLP.models.bert diff --git a/docs/source/fastNLP.modules.aggregator.rst b/docs/source/fastNLP.modules.aggregator.rst index 4f8baabd..44398325 100644 --- a/docs/source/fastNLP.modules.aggregator.rst +++ b/docs/source/fastNLP.modules.aggregator.rst @@ -10,6 +10,7 @@ fastNLP.modules.aggregator ---------- .. toctree:: + :titlesonly: fastNLP.modules.aggregator.attention fastNLP.modules.aggregator.pooling diff --git a/docs/source/fastNLP.modules.decoder.rst b/docs/source/fastNLP.modules.decoder.rst index fbda11d9..1c28740b 100644 --- a/docs/source/fastNLP.modules.decoder.rst +++ b/docs/source/fastNLP.modules.decoder.rst @@ -10,6 +10,7 @@ fastNLP.modules.decoder ---------- .. toctree:: + :titlesonly: fastNLP.modules.decoder.CRF fastNLP.modules.decoder.MLP diff --git a/docs/source/fastNLP.modules.encoder.rst b/docs/source/fastNLP.modules.encoder.rst index 9a11fe74..b15232fa 100644 --- a/docs/source/fastNLP.modules.encoder.rst +++ b/docs/source/fastNLP.modules.encoder.rst @@ -10,6 +10,7 @@ fastNLP.modules.encoder ---------- .. toctree:: + :titlesonly: fastNLP.modules.encoder.bert fastNLP.modules.encoder.char_encoder diff --git a/docs/source/fastNLP.modules.rst b/docs/source/fastNLP.modules.rst index 263005f0..4f05ae7b 100644 --- a/docs/source/fastNLP.modules.rst +++ b/docs/source/fastNLP.modules.rst @@ -10,6 +10,7 @@ fastNLP.modules 模块 ----------- .. toctree:: + :titlesonly: fastNLP.modules.aggregator fastNLP.modules.decoder diff --git a/docs/source/fastNLP.rst b/docs/source/fastNLP.rst index eaa06ea8..a795045a 100644 --- a/docs/source/fastNLP.rst +++ b/docs/source/fastNLP.rst @@ -10,6 +10,7 @@ ----------- .. toctree:: + :titlesonly: :maxdepth: 3 fastNLP.core diff --git a/docs/source/index.rst b/docs/source/index.rst index 687b1c33..d77ae1c8 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -15,11 +15,12 @@ fastNLP 是一款轻量级的 NLP 处理套件。你既可以使用它快速地 内置组件 ------------ -大部分用于的 NLP 任务神经网络都可以看做由编码（encoder）、聚合（aggregator）、解码（decoder）三个阶段组成。 +大部分用于的 NLP 任务神经网络都可以看做由编码（encoder）、聚合（aggregator）、解码（decoder）三中模块组成。 .. image:: figures/text_classification.png -三大模块功能和例子如下: +fastNLP 在 :mod:`~fastNLP.modules` 模块中内置了三个模块的诸多组件，可以帮助用户快速搭建自己所需的网络。 +三个模块的功能和常见组件如下: +-----------------------+-----------------------+-----------------------+ | module type | functionality | example | @@ -35,8 +36,6 @@ fastNLP 是一款轻量级的 NLP 处理套件。你既可以使用它快速地 | | 形式 | | +-----------------------+-----------------------+-----------------------+ -fastNLP 在 :mod:`~fastNLP.module` 模块中内置了大量的组件，可以帮助用户快速搭建自己所需的网络 - 内置模型 ---------------- @@ -65,7 +64,7 @@ API 文档 除了用户手册之外，你还可以通过查阅 API 文档来找到你所需要的工具。 .. toctree:: - :maxdepth: 2 + :titlesonly: fastNLP diff --git a/docs/source/modules.rst b/docs/source/modules.rst index e9a92cb7..9ca3c7f3 100644 --- a/docs/source/modules.rst +++ b/docs/source/modules.rst @@ -2,6 +2,7 @@ fastNLP ======= .. toctree:: + :titlesonly: :maxdepth: 4 fastNLP