@@ -42,6 +42,8 @@ release = '1.0' | |||
extensions = [ | |||
'sphinx.ext.autodoc', | |||
'sphinx.ext.viewcode', | |||
'sphinx.ext.autosummary', | |||
] | |||
# Add any paths that contain templates here, relative to this directory. | |||
@@ -1,62 +1,48 @@ | |||
fastNLP.core package | |||
==================== | |||
fastNLP.core | |||
============= | |||
Submodules | |||
---------- | |||
fastNLP.core.action module | |||
-------------------------- | |||
fastNLP.core.action | |||
-------------------- | |||
.. automodule:: fastNLP.core.action | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
fastNLP.core.metrics module | |||
--------------------------- | |||
fastNLP.core.metrics | |||
--------------------- | |||
.. automodule:: fastNLP.core.metrics | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
fastNLP.core.optimizer module | |||
----------------------------- | |||
fastNLP.core.optimizer | |||
----------------------- | |||
.. automodule:: fastNLP.core.optimizer | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
fastNLP.core.predictor module | |||
----------------------------- | |||
fastNLP.core.predictor | |||
----------------------- | |||
.. automodule:: fastNLP.core.predictor | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
fastNLP.core.tester module | |||
-------------------------- | |||
fastNLP.core.preprocess | |||
------------------------ | |||
.. automodule:: fastNLP.core.preprocess | |||
:members: | |||
fastNLP.core.tester | |||
-------------------- | |||
.. automodule:: fastNLP.core.tester | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
fastNLP.core.trainer module | |||
--------------------------- | |||
fastNLP.core.trainer | |||
--------------------- | |||
.. automodule:: fastNLP.core.trainer | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
Module contents | |||
--------------- | |||
.. automodule:: fastNLP.core | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: |
@@ -1,62 +1,36 @@ | |||
fastNLP.loader package | |||
====================== | |||
fastNLP.loader | |||
=============== | |||
Submodules | |||
---------- | |||
fastNLP.loader.base\_loader module | |||
---------------------------------- | |||
fastNLP.loader.base\_loader | |||
---------------------------- | |||
.. automodule:: fastNLP.loader.base_loader | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
fastNLP.loader.config\_loader module | |||
------------------------------------ | |||
fastNLP.loader.config\_loader | |||
------------------------------ | |||
.. automodule:: fastNLP.loader.config_loader | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
fastNLP.loader.dataset\_loader module | |||
------------------------------------- | |||
fastNLP.loader.dataset\_loader | |||
------------------------------- | |||
.. automodule:: fastNLP.loader.dataset_loader | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
fastNLP.loader.embed\_loader module | |||
----------------------------------- | |||
fastNLP.loader.embed\_loader | |||
----------------------------- | |||
.. automodule:: fastNLP.loader.embed_loader | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
fastNLP.loader.model\_loader module | |||
----------------------------------- | |||
fastNLP.loader.model\_loader | |||
----------------------------- | |||
.. automodule:: fastNLP.loader.model_loader | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
fastNLP.loader.preprocess module | |||
-------------------------------- | |||
.. automodule:: fastNLP.loader.preprocess | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
Module contents | |||
--------------- | |||
.. automodule:: fastNLP.loader | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: |
@@ -1,46 +1,30 @@ | |||
fastNLP.models package | |||
====================== | |||
fastNLP.models | |||
=============== | |||
Submodules | |||
---------- | |||
fastNLP.models.base\_model module | |||
--------------------------------- | |||
fastNLP.models.base\_model | |||
--------------------------- | |||
.. automodule:: fastNLP.models.base_model | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
fastNLP.models.char\_language\_model module | |||
------------------------------------------- | |||
fastNLP.models.char\_language\_model | |||
------------------------------------- | |||
.. automodule:: fastNLP.models.char_language_model | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
fastNLP.models.cnn\_text\_classification module | |||
----------------------------------------------- | |||
fastNLP.models.cnn\_text\_classification | |||
----------------------------------------- | |||
.. automodule:: fastNLP.models.cnn_text_classification | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
fastNLP.models.sequence\_modeling module | |||
---------------------------------------- | |||
fastNLP.models.sequence\_modeling | |||
---------------------------------- | |||
.. automodule:: fastNLP.models.sequence_modeling | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
Module contents | |||
--------------- | |||
.. automodule:: fastNLP.models | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: |
@@ -1,54 +1,36 @@ | |||
fastNLP.modules.aggregation package | |||
=================================== | |||
fastNLP.modules.aggregation | |||
============================ | |||
Submodules | |||
---------- | |||
fastNLP.modules.aggregation.attention module | |||
-------------------------------------------- | |||
fastNLP.modules.aggregation.attention | |||
-------------------------------------- | |||
.. automodule:: fastNLP.modules.aggregation.attention | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
fastNLP.modules.aggregation.avg\_pool module | |||
-------------------------------------------- | |||
fastNLP.modules.aggregation.avg\_pool | |||
-------------------------------------- | |||
.. automodule:: fastNLP.modules.aggregation.avg_pool | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
fastNLP.modules.aggregation.kmax\_pool module | |||
--------------------------------------------- | |||
fastNLP.modules.aggregation.kmax\_pool | |||
--------------------------------------- | |||
.. automodule:: fastNLP.modules.aggregation.kmax_pool | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
fastNLP.modules.aggregation.max\_pool module | |||
-------------------------------------------- | |||
fastNLP.modules.aggregation.max\_pool | |||
-------------------------------------- | |||
.. automodule:: fastNLP.modules.aggregation.max_pool | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
fastNLP.modules.aggregation.self\_attention module | |||
-------------------------------------------------- | |||
fastNLP.modules.aggregation.self\_attention | |||
-------------------------------------------- | |||
.. automodule:: fastNLP.modules.aggregation.self_attention | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
Module contents | |||
--------------- | |||
.. automodule:: fastNLP.modules.aggregation | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: |
@@ -1,22 +1,12 @@ | |||
fastNLP.modules.decoder package | |||
=============================== | |||
fastNLP.modules.decoder | |||
======================== | |||
Submodules | |||
---------- | |||
fastNLP.modules.decoder.CRF module | |||
---------------------------------- | |||
fastNLP.modules.decoder.CRF | |||
---------------------------- | |||
.. automodule:: fastNLP.modules.decoder.CRF | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
Module contents | |||
--------------- | |||
.. automodule:: fastNLP.modules.decoder | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: |
@@ -1,78 +1,54 @@ | |||
fastNLP.modules.encoder package | |||
=============================== | |||
fastNLP.modules.encoder | |||
======================== | |||
Submodules | |||
---------- | |||
fastNLP.modules.encoder.char\_embedding module | |||
---------------------------------------------- | |||
fastNLP.modules.encoder.char\_embedding | |||
---------------------------------------- | |||
.. automodule:: fastNLP.modules.encoder.char_embedding | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
fastNLP.modules.encoder.conv module | |||
----------------------------------- | |||
fastNLP.modules.encoder.conv | |||
----------------------------- | |||
.. automodule:: fastNLP.modules.encoder.conv | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
fastNLP.modules.encoder.conv\_maxpool module | |||
-------------------------------------------- | |||
fastNLP.modules.encoder.conv\_maxpool | |||
-------------------------------------- | |||
.. automodule:: fastNLP.modules.encoder.conv_maxpool | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
fastNLP.modules.encoder.embedding module | |||
---------------------------------------- | |||
fastNLP.modules.encoder.embedding | |||
---------------------------------- | |||
.. automodule:: fastNLP.modules.encoder.embedding | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
fastNLP.modules.encoder.linear module | |||
------------------------------------- | |||
fastNLP.modules.encoder.linear | |||
------------------------------- | |||
.. automodule:: fastNLP.modules.encoder.linear | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
fastNLP.modules.encoder.lstm module | |||
----------------------------------- | |||
fastNLP.modules.encoder.lstm | |||
----------------------------- | |||
.. automodule:: fastNLP.modules.encoder.lstm | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
fastNLP.modules.encoder.masked\_rnn module | |||
------------------------------------------ | |||
fastNLP.modules.encoder.masked\_rnn | |||
------------------------------------ | |||
.. automodule:: fastNLP.modules.encoder.masked_rnn | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
fastNLP.modules.encoder.variational\_rnn module | |||
----------------------------------------------- | |||
fastNLP.modules.encoder.variational\_rnn | |||
----------------------------------------- | |||
.. automodule:: fastNLP.modules.encoder.variational_rnn | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
Module contents | |||
--------------- | |||
.. automodule:: fastNLP.modules.encoder | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: |
@@ -1,10 +1,5 @@ | |||
fastNLP.modules.interaction package | |||
=================================== | |||
Module contents | |||
--------------- | |||
fastNLP.modules.interaction | |||
============================ | |||
.. automodule:: fastNLP.modules.interaction | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: |
@@ -1,8 +1,5 @@ | |||
fastNLP.modules package | |||
======================= | |||
Subpackages | |||
----------- | |||
fastNLP.modules | |||
================ | |||
.. toctree:: | |||
@@ -11,30 +8,18 @@ Subpackages | |||
fastNLP.modules.encoder | |||
fastNLP.modules.interaction | |||
Submodules | |||
---------- | |||
fastNLP.modules.other\_modules module | |||
------------------------------------- | |||
fastNLP.modules.other\_modules | |||
------------------------------- | |||
.. automodule:: fastNLP.modules.other_modules | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
fastNLP.modules.utils module | |||
---------------------------- | |||
fastNLP.modules.utils | |||
---------------------- | |||
.. automodule:: fastNLP.modules.utils | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
Module contents | |||
--------------- | |||
.. automodule:: fastNLP.modules | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: |
@@ -1,8 +1,5 @@ | |||
fastNLP package | |||
=============== | |||
Subpackages | |||
----------- | |||
fastNLP | |||
======== | |||
.. toctree:: | |||
@@ -12,22 +9,12 @@ Subpackages | |||
fastNLP.modules | |||
fastNLP.saver | |||
Submodules | |||
---------- | |||
fastNLP.fastnlp module | |||
---------------------- | |||
fastNLP.fastnlp | |||
---------------- | |||
.. automodule:: fastNLP.fastnlp | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
Module contents | |||
--------------- | |||
.. automodule:: fastNLP | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: |
@@ -1,30 +1,18 @@ | |||
fastNLP.saver package | |||
===================== | |||
fastNLP.saver | |||
============== | |||
Submodules | |||
---------- | |||
fastNLP.saver.logger module | |||
--------------------------- | |||
fastNLP.saver.logger | |||
--------------------- | |||
.. automodule:: fastNLP.saver.logger | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
fastNLP.saver.model\_saver module | |||
--------------------------------- | |||
fastNLP.saver.model\_saver | |||
--------------------------- | |||
.. automodule:: fastNLP.saver.model_saver | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: | |||
Module contents | |||
--------------- | |||
.. automodule:: fastNLP.saver | |||
:members: | |||
:undoc-members: | |||
:show-inheritance: |
@@ -3,14 +3,24 @@ | |||
You can adapt this file completely to your liking, but it should at least | |||
contain the root `toctree` directive. | |||
Welcome to fastNLP's documentation! | |||
=================================== | |||
fastNLP documentation | |||
===================== | |||
Introduction | |||
------------ | |||
API Reference | |||
------------- | |||
If you are looking for information on a specific function, class or | |||
method, this part of the documentation is for you. | |||
.. toctree:: | |||
:maxdepth: 4 | |||
:caption: Contents: | |||
:maxdepth: 2 | |||
fastNLP | |||
fastNLP API <fastNLP> | |||
@@ -1,7 +0,0 @@ | |||
fastNLP | |||
======= | |||
.. toctree:: | |||
:maxdepth: 4 | |||
fastNLP |