Browse Source

updated docs

tags/v0.4.10
ChenXin 5 years ago
parent
commit
cdf8406ec1
14 changed files with 69 additions and 21 deletions
  1. +1
    -2
      docs/source/fastNLP.core.rst
  2. +1
    -2
      docs/source/fastNLP.embeddings.rst
  3. +3
    -2
      docs/source/fastNLP.io.data_loader.rst
  4. +7
    -0
      docs/source/fastNLP.io.file_utils.rst
  5. +8
    -0
      docs/source/fastNLP.io.loader.rst
  6. +8
    -0
      docs/source/fastNLP.io.pipe.rst
  7. +13
    -4
      docs/source/fastNLP.io.rst
  8. +7
    -0
      docs/source/fastNLP.io.utils.rst
  9. +1
    -2
      docs/source/fastNLP.models.rst
  10. +1
    -0
      docs/source/fastNLP.modules.encoder.rst
  11. +9
    -4
      docs/source/fastNLP.modules.rst
  12. +7
    -0
      docs/source/fastNLP.modules.utils.rst
  13. +3
    -4
      docs/source/fastNLP.rst
  14. +0
    -1
      docs/source/modules.rst

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

@@ -6,11 +6,10 @@ fastNLP.core
:undoc-members:
:show-inheritance:

子模块
Submodules
----------

.. toctree::
:maxdepth: 1

fastNLP.core.batch
fastNLP.core.callback


+ 1
- 2
docs/source/fastNLP.embeddings.rst View File

@@ -6,11 +6,10 @@ fastNLP.embeddings
:undoc-members:
:show-inheritance:

子模块
Submodules
----------

.. toctree::
:maxdepth: 1

fastNLP.embeddings.bert_embedding
fastNLP.embeddings.char_embedding


+ 3
- 2
docs/source/fastNLP.io.data_loader.rst View File

@@ -1,7 +1,8 @@
fastNLP.io.data\_loader
==========================
=======================

.. automodule:: fastNLP.io.data_loader
:members:
:undoc-members:
:show-inheritance:
:show-inheritance:


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

@@ -0,0 +1,7 @@
fastNLP.io.file\_utils
======================

.. automodule:: fastNLP.io.file_utils
:members:
:undoc-members:
:show-inheritance:

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

@@ -0,0 +1,8 @@
fastNLP.io.loader
=================

.. automodule:: fastNLP.io.loader
:members:
:undoc-members:
:show-inheritance:


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

@@ -0,0 +1,8 @@
fastNLP.io.pipe
===============

.. automodule:: fastNLP.io.pipe
:members:
:undoc-members:
:show-inheritance:


+ 13
- 4
docs/source/fastNLP.io.rst View File

@@ -6,14 +6,23 @@ fastNLP.io
:undoc-members:
:show-inheritance:

子模块
Subpackages
-----------

.. toctree::

fastNLP.io.data_loader
fastNLP.io.loader
fastNLP.io.pipe

Submodules
----------

.. toctree::
:maxdepth: 1

fastNLP.io.base_loader
fastNLP.io.embed_loader
fastNLP.io.dataset_loader
fastNLP.io.data_loader
fastNLP.io.embed_loader
fastNLP.io.file_utils
fastNLP.io.model_io
fastNLP.io.utils

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

@@ -0,0 +1,7 @@
fastNLP.io.utils
================

.. automodule:: fastNLP.io.utils
:members:
:undoc-members:
:show-inheritance:

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

@@ -6,11 +6,10 @@ fastNLP.models
:undoc-members:
:show-inheritance:

子模块
Submodules
----------

.. toctree::
:maxdepth: 1

fastNLP.models.biaffine_parser
fastNLP.models.cnn_text_classification


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

@@ -5,3 +5,4 @@ fastNLP.modules.encoder
:members:
:undoc-members:
:show-inheritance:


+ 9
- 4
docs/source/fastNLP.modules.rst View File

@@ -6,12 +6,17 @@ fastNLP.modules
:undoc-members:
:show-inheritance:

子模块
Subpackages
-----------

.. toctree::
:titlesonly:
:maxdepth: 1

fastNLP.modules.decoder
fastNLP.modules.encoder
fastNLP.modules.encoder

Submodules
----------

.. toctree::

fastNLP.modules.utils

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

@@ -0,0 +1,7 @@
fastNLP.modules.utils
=====================

.. automodule:: fastNLP.modules.utils
:members:
:undoc-members:
:show-inheritance:

+ 3
- 4
docs/source/fastNLP.rst View File

@@ -1,16 +1,15 @@
API 文档
===============
fastNLP
=======

.. automodule:: fastNLP
:members:
:undoc-members:
:show-inheritance:

内部模块
Subpackages
-----------

.. toctree::
:maxdepth: 1

fastNLP.core
fastNLP.embeddings


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

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

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

fastNLP

Loading…
Cancel
Save