Browse Source

update docs

tags/v0.2.0
lyhuang 6 years ago
parent
commit
36a7a980ca
6 changed files with 55 additions and 49 deletions
  1. +12
    -6
      docs/source/fastNLP.core.rst
  2. +0
    -36
      docs/source/fastNLP.modules.aggregation.rst
  3. +36
    -0
      docs/source/fastNLP.modules.aggregator.rst
  4. +0
    -5
      docs/source/fastNLP.modules.interaction.rst
  5. +5
    -0
      docs/source/fastNLP.modules.interactor.rst
  6. +2
    -2
      docs/source/fastNLP.modules.rst

+ 12
- 6
docs/source/fastNLP.core.rst View File

@@ -1,12 +1,6 @@
fastNLP.core
=============

fastNLP.core.action
--------------------

.. automodule:: fastNLP.core.action
:members:

fastNLP.core.batch
-------------------

@@ -61,6 +55,12 @@ fastNLP.core.preprocess
.. automodule:: fastNLP.core.preprocess
:members:

fastNLP.core.sampler
---------------------

.. automodule:: fastNLP.core.sampler
:members:

fastNLP.core.tester
--------------------

@@ -73,6 +73,12 @@ fastNLP.core.trainer
.. automodule:: fastNLP.core.trainer
:members:

fastNLP.core.vocabulary
------------------------

.. automodule:: fastNLP.core.vocabulary
:members:


.. automodule:: fastNLP.core
:members:

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

@@ -1,36 +0,0 @@
fastNLP.modules.aggregation
============================

fastNLP.modules.aggregation.attention
--------------------------------------

.. automodule:: fastNLP.modules.aggregation.attention
:members:

fastNLP.modules.aggregation.avg\_pool
--------------------------------------

.. automodule:: fastNLP.modules.aggregation.avg_pool
:members:

fastNLP.modules.aggregation.kmax\_pool
---------------------------------------

.. automodule:: fastNLP.modules.aggregation.kmax_pool
:members:

fastNLP.modules.aggregation.max\_pool
--------------------------------------

.. automodule:: fastNLP.modules.aggregation.max_pool
:members:

fastNLP.modules.aggregation.self\_attention
--------------------------------------------

.. automodule:: fastNLP.modules.aggregation.self_attention
:members:


.. automodule:: fastNLP.modules.aggregation
:members:

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

@@ -0,0 +1,36 @@
fastNLP.modules.aggregator
===========================

fastNLP.modules.aggregator.attention
-------------------------------------

.. automodule:: fastNLP.modules.aggregator.attention
:members:

fastNLP.modules.aggregator.avg\_pool
-------------------------------------

.. automodule:: fastNLP.modules.aggregator.avg_pool
:members:

fastNLP.modules.aggregator.kmax\_pool
--------------------------------------

.. automodule:: fastNLP.modules.aggregator.kmax_pool
:members:

fastNLP.modules.aggregator.max\_pool
-------------------------------------

.. automodule:: fastNLP.modules.aggregator.max_pool
:members:

fastNLP.modules.aggregator.self\_attention
-------------------------------------------

.. automodule:: fastNLP.modules.aggregator.self_attention
:members:


.. automodule:: fastNLP.modules.aggregator
:members:

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

@@ -1,5 +0,0 @@
fastNLP.modules.interaction
============================

.. automodule:: fastNLP.modules.interaction
:members:

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

@@ -0,0 +1,5 @@
fastNLP.modules.interactor
===========================

.. automodule:: fastNLP.modules.interactor
:members:

+ 2
- 2
docs/source/fastNLP.modules.rst View File

@@ -3,10 +3,10 @@ fastNLP.modules

.. toctree::

fastNLP.modules.aggregation
fastNLP.modules.aggregator
fastNLP.modules.decoder
fastNLP.modules.encoder
fastNLP.modules.interaction
fastNLP.modules.interactor

fastNLP.modules.other\_modules
-------------------------------


Loading…
Cancel
Save