From 36a7a980ca53f2510cadc040a7056c7ef6c7b2ef Mon Sep 17 00:00:00 2001 From: lyhuang Date: Fri, 5 Oct 2018 05:34:26 +0800 Subject: [PATCH] update docs --- docs/source/fastNLP.core.rst | 18 +++++++---- docs/source/fastNLP.modules.aggregation.rst | 36 --------------------- docs/source/fastNLP.modules.aggregator.rst | 36 +++++++++++++++++++++ docs/source/fastNLP.modules.interaction.rst | 5 --- docs/source/fastNLP.modules.interactor.rst | 5 +++ docs/source/fastNLP.modules.rst | 4 +-- 6 files changed, 55 insertions(+), 49 deletions(-) delete mode 100644 docs/source/fastNLP.modules.aggregation.rst create mode 100644 docs/source/fastNLP.modules.aggregator.rst delete mode 100644 docs/source/fastNLP.modules.interaction.rst create mode 100644 docs/source/fastNLP.modules.interactor.rst diff --git a/docs/source/fastNLP.core.rst b/docs/source/fastNLP.core.rst index 86793e5d..5c941e55 100644 --- a/docs/source/fastNLP.core.rst +++ b/docs/source/fastNLP.core.rst @@ -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: diff --git a/docs/source/fastNLP.modules.aggregation.rst b/docs/source/fastNLP.modules.aggregation.rst deleted file mode 100644 index bfaf8646..00000000 --- a/docs/source/fastNLP.modules.aggregation.rst +++ /dev/null @@ -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: diff --git a/docs/source/fastNLP.modules.aggregator.rst b/docs/source/fastNLP.modules.aggregator.rst new file mode 100644 index 00000000..073da4a5 --- /dev/null +++ b/docs/source/fastNLP.modules.aggregator.rst @@ -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: diff --git a/docs/source/fastNLP.modules.interaction.rst b/docs/source/fastNLP.modules.interaction.rst deleted file mode 100644 index 91a34268..00000000 --- a/docs/source/fastNLP.modules.interaction.rst +++ /dev/null @@ -1,5 +0,0 @@ -fastNLP.modules.interaction -============================ - -.. automodule:: fastNLP.modules.interaction - :members: diff --git a/docs/source/fastNLP.modules.interactor.rst b/docs/source/fastNLP.modules.interactor.rst new file mode 100644 index 00000000..5eb3bdef --- /dev/null +++ b/docs/source/fastNLP.modules.interactor.rst @@ -0,0 +1,5 @@ +fastNLP.modules.interactor +=========================== + +.. automodule:: fastNLP.modules.interactor + :members: diff --git a/docs/source/fastNLP.modules.rst b/docs/source/fastNLP.modules.rst index 6ccdc21a..eda85aa7 100644 --- a/docs/source/fastNLP.modules.rst +++ b/docs/source/fastNLP.modules.rst @@ -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 -------------------------------