Browse Source

加上了 titlesonly 这个设置

tags/v0.4.10
ChenXin 5 years ago
parent
commit
269e28cc79
10 changed files with 13 additions and 5 deletions
  1. +1
    -0
      docs/source/fastNLP.core.rst
  2. +1
    -0
      docs/source/fastNLP.io.rst
  3. +1
    -0
      docs/source/fastNLP.models.rst
  4. +1
    -0
      docs/source/fastNLP.modules.aggregator.rst
  5. +1
    -0
      docs/source/fastNLP.modules.decoder.rst
  6. +1
    -0
      docs/source/fastNLP.modules.encoder.rst
  7. +1
    -0
      docs/source/fastNLP.modules.rst
  8. +1
    -0
      docs/source/fastNLP.rst
  9. +4
    -5
      docs/source/index.rst
  10. +1
    -0
      docs/source/modules.rst

+ 1
- 0
docs/source/fastNLP.core.rst View File

@@ -10,6 +10,7 @@ fastNLP.core 模块
---------- ----------


.. toctree:: .. toctree::
:titlesonly:


fastNLP.core.batch fastNLP.core.batch
fastNLP.core.callback fastNLP.core.callback


+ 1
- 0
docs/source/fastNLP.io.rst View File

@@ -10,6 +10,7 @@ fastNLP.io 模块
---------- ----------


.. toctree:: .. toctree::
:titlesonly:


fastNLP.io.base_loader fastNLP.io.base_loader
fastNLP.io.dataset_loader fastNLP.io.dataset_loader


+ 1
- 0
docs/source/fastNLP.models.rst View File

@@ -10,6 +10,7 @@ fastNLP.models 模块
---------- ----------


.. toctree:: .. toctree::
:titlesonly:


fastNLP.models.base_model fastNLP.models.base_model
fastNLP.models.bert fastNLP.models.bert


+ 1
- 0
docs/source/fastNLP.modules.aggregator.rst View File

@@ -10,6 +10,7 @@ fastNLP.modules.aggregator
---------- ----------


.. toctree:: .. toctree::
:titlesonly:


fastNLP.modules.aggregator.attention fastNLP.modules.aggregator.attention
fastNLP.modules.aggregator.pooling fastNLP.modules.aggregator.pooling


+ 1
- 0
docs/source/fastNLP.modules.decoder.rst View File

@@ -10,6 +10,7 @@ fastNLP.modules.decoder
---------- ----------


.. toctree:: .. toctree::
:titlesonly:


fastNLP.modules.decoder.CRF fastNLP.modules.decoder.CRF
fastNLP.modules.decoder.MLP fastNLP.modules.decoder.MLP


+ 1
- 0
docs/source/fastNLP.modules.encoder.rst View File

@@ -10,6 +10,7 @@ fastNLP.modules.encoder
---------- ----------


.. toctree:: .. toctree::
:titlesonly:


fastNLP.modules.encoder.bert fastNLP.modules.encoder.bert
fastNLP.modules.encoder.char_encoder fastNLP.modules.encoder.char_encoder


+ 1
- 0
docs/source/fastNLP.modules.rst View File

@@ -10,6 +10,7 @@ fastNLP.modules 模块
----------- -----------


.. toctree:: .. toctree::
:titlesonly:


fastNLP.modules.aggregator fastNLP.modules.aggregator
fastNLP.modules.decoder fastNLP.modules.decoder

+ 1
- 0
docs/source/fastNLP.rst View File

@@ -10,6 +10,7 @@
----------- -----------


.. toctree:: .. toctree::
:titlesonly:
:maxdepth: 3 :maxdepth: 3


fastNLP.core fastNLP.core


+ 4
- 5
docs/source/index.rst View File

@@ -15,11 +15,12 @@ fastNLP 是一款轻量级的 NLP 处理套件。你既可以使用它快速地
内置组件 内置组件
------------ ------------


大部分用于的 NLP 任务神经网络都可以看做由编码(encoder)、聚合(aggregator)、解码(decoder)三个阶段组成。
大部分用于的 NLP 任务神经网络都可以看做由编码(encoder)、聚合(aggregator)、解码(decoder)三中模块组成。


.. image:: figures/text_classification.png .. image:: figures/text_classification.png


三大模块功能和例子如下:
fastNLP 在 :mod:`~fastNLP.modules` 模块中内置了三个模块的诸多组件,可以帮助用户快速搭建自己所需的网络。
三个模块的功能和常见组件如下:


+-----------------------+-----------------------+-----------------------+ +-----------------------+-----------------------+-----------------------+
| module type | functionality | example | | module type | functionality | example |
@@ -35,8 +36,6 @@ fastNLP 是一款轻量级的 NLP 处理套件。你既可以使用它快速地
| | 形式 | | | | 形式 | |
+-----------------------+-----------------------+-----------------------+ +-----------------------+-----------------------+-----------------------+


fastNLP 在 :mod:`~fastNLP.module` 模块中内置了大量的组件,可以帮助用户快速搭建自己所需的网络



内置模型 内置模型
---------------- ----------------
@@ -65,7 +64,7 @@ API 文档
除了用户手册之外,你还可以通过查阅 API 文档来找到你所需要的工具。 除了用户手册之外,你还可以通过查阅 API 文档来找到你所需要的工具。


.. toctree:: .. toctree::
:maxdepth: 2
:titlesonly:
fastNLP fastNLP




+ 1
- 0
docs/source/modules.rst View File

@@ -2,6 +2,7 @@ fastNLP
======= =======


.. toctree:: .. toctree::
:titlesonly:
:maxdepth: 4 :maxdepth: 4


fastNLP fastNLP

Loading…
Cancel
Save