最新的docs结构

docs/source/fastNLP.core.batch.rst

@@ -2,6 +2,6 @@ fastNLP.core.batch
 ==================
 
 .. automodule:: fastNLP.core.batch
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.core.callback.rst

@@ -2,6 +2,6 @@ fastNLP.core.callback
 =====================
 
 .. automodule:: fastNLP.core.callback
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.core.const.rst

@@ -2,6 +2,6 @@ fastNLP.core.const
 ==================
 
 .. automodule:: fastNLP.core.const
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.core.dataset.rst

@@ -2,6 +2,6 @@ fastNLP.core.dataset
 ====================
 
 .. automodule:: fastNLP.core.dataset
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.core.field.rst

@@ -2,6 +2,6 @@ fastNLP.core.field
 ==================
 
 .. automodule:: fastNLP.core.field
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.core.instance.rst

@@ -2,6 +2,6 @@ fastNLP.core.instance
 =====================
 
 .. automodule:: fastNLP.core.instance
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.core.losses.rst

@@ -2,6 +2,6 @@ fastNLP.core.losses
 ===================
 
 .. automodule:: fastNLP.core.losses
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.core.metrics.rst

@@ -2,6 +2,6 @@ fastNLP.core.metrics
 ====================
 
 .. automodule:: fastNLP.core.metrics
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.core.optimizer.rst

@@ -2,6 +2,6 @@ fastNLP.core.optimizer
 ======================
 
 .. automodule:: fastNLP.core.optimizer
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.core.rst

@@ -2,15 +2,15 @@ fastNLP.core
 ============
 
 .. automodule:: fastNLP.core
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 子模块
 ----------
 
 .. toctree::
-   :titlesonly:
+   :maxdepth: 1
 
    fastNLP.core.batch
    fastNLP.core.callback
@@ -26,4 +26,3 @@ fastNLP.core
    fastNLP.core.trainer
    fastNLP.core.utils
    fastNLP.core.vocabulary
-

docs/source/fastNLP.core.sampler.rst

@@ -2,6 +2,6 @@ fastNLP.core.sampler
 ====================
 
 .. automodule:: fastNLP.core.sampler
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.core.tester.rst

@@ -2,6 +2,6 @@ fastNLP.core.tester
 ===================
 
 .. automodule:: fastNLP.core.tester
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.core.trainer.rst

@@ -2,6 +2,6 @@ fastNLP.core.trainer
 ====================
 
 .. automodule:: fastNLP.core.trainer
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.core.utils.rst

@@ -2,6 +2,6 @@ fastNLP.core.utils
 ==================
 
 .. automodule:: fastNLP.core.utils
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.core.vocabulary.rst

@@ -2,6 +2,6 @@ fastNLP.core.vocabulary
 =======================
 
 .. automodule:: fastNLP.core.vocabulary
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.embeddings.bert_embedding.rst

@@ -0,0 +1,7 @@
+fastNLP.embeddings.bert\_embedding
+==================================
+
+.. automodule:: fastNLP.embeddings.bert_embedding
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.embeddings.char_embedding.rst

@@ -0,0 +1,7 @@
+fastNLP.embeddings.char\_embedding
+==================================
+
+.. automodule:: fastNLP.embeddings.char_embedding
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.embeddings.contextual_embedding.rst

@@ -0,0 +1,7 @@
+fastNLP.embeddings.contextual\_embedding
+========================================
+
+.. automodule:: fastNLP.embeddings.contextual_embedding
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.embeddings.elmo_embedding.rst

@@ -0,0 +1,7 @@
+fastNLP.embeddings.elmo\_embedding
+==================================
+
+.. automodule:: fastNLP.embeddings.elmo_embedding
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.embeddings.embedding.rst

@@ -0,0 +1,7 @@
+fastNLP.embeddings.embedding
+============================
+
+.. automodule:: fastNLP.embeddings.embedding
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.embeddings.rst

@@ -0,0 +1,21 @@
+fastNLP.embeddings
+==================
+
+.. automodule:: fastNLP.embeddings
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+子模块
+----------
+
+.. toctree::
+
+   fastNLP.embeddings.bert_embedding
+   fastNLP.embeddings.char_embedding
+   fastNLP.embeddings.contextual_embedding
+   fastNLP.embeddings.elmo_embedding
+   fastNLP.embeddings.embedding
+   fastNLP.embeddings.stack_embedding
+   fastNLP.embeddings.static_embedding
+   fastNLP.embeddings.utils

docs/source/fastNLP.embeddings.stack_embedding.rst

@@ -0,0 +1,7 @@
+fastNLP.embeddings.stack\_embedding
+===================================
+
+.. automodule:: fastNLP.embeddings.stack_embedding
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.embeddings.static_embedding.rst

@@ -0,0 +1,7 @@
+fastNLP.embeddings.static\_embedding
+====================================
+
+.. automodule:: fastNLP.embeddings.static_embedding
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.embeddings.utils.rst

@@ -0,0 +1,7 @@
+fastNLP.embeddings.utils
+========================
+
+.. automodule:: fastNLP.embeddings.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.io.base_loader.rst

@@ -2,6 +2,6 @@ fastNLP.io.base\_loader
 =======================
 
 .. automodule:: fastNLP.io.base_loader
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.io.config_io.rst

@@ -0,0 +1,7 @@
+fastNLP.io.config\_io
+=====================
+
+.. automodule:: fastNLP.io.config_io
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.io.data_loader.rst

@@ -2,6 +2,6 @@ fastNLP.io.data\_loader
 ==========================
 
 .. automodule:: fastNLP.io.data_loader
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.io.dataset_loader.rst

@@ -2,6 +2,6 @@ fastNLP.io.dataset\_loader
 ==========================
 
 .. automodule:: fastNLP.io.dataset_loader
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.io.embed_loader.rst

@@ -2,6 +2,6 @@ fastNLP.io.embed\_loader
 ========================
 
 .. automodule:: fastNLP.io.embed_loader
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.io.file_utils.rst

@@ -0,0 +1,7 @@
+fastNLP.io.file_utils
+=====================
+
+.. automodule:: fastNLP.io.file_utils
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.io.model_io.rst

@@ -2,6 +2,6 @@ fastNLP.io.model\_io
 ====================
 
 .. automodule:: fastNLP.io.model_io
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.io.rst

@@ -2,19 +2,26 @@ fastNLP.io
 ==========
 
 .. automodule:: fastNLP.io
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 子模块
 ----------
 
 .. toctree::
-   :titlesonly:
 
    fastNLP.io.data_loader
+
+Submodules
+----------
+
+.. toctree::
+
    fastNLP.io.base_loader
+   fastNLP.io.config_io
    fastNLP.io.dataset_loader
    fastNLP.io.embed_loader
+   fastNLP.io.file_utils
    fastNLP.io.model_io
-
+   fastNLP.io.utils

docs/source/fastNLP.io.utils.rst

@@ -0,0 +1,7 @@
+fastNLP.io.utils
+================
+
+.. automodule:: fastNLP.io.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.models.base_model.rst

@@ -0,0 +1,7 @@
+fastNLP.models.base\_model
+==========================
+
+.. automodule:: fastNLP.models.base_model
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.models.bert.rst

@@ -0,0 +1,7 @@
+fastNLP.models.bert
+===================
+
+.. automodule:: fastNLP.models.bert
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.models.biaffine_parser.rst

@@ -2,6 +2,6 @@ fastNLP.models.biaffine\_parser
 ===============================
 
 .. automodule:: fastNLP.models.biaffine_parser
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.models.cnn_text_classification.rst

@@ -2,6 +2,6 @@ fastNLP.models.cnn\_text\_classification
 ========================================
 
 .. automodule:: fastNLP.models.cnn_text_classification
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.models.enas_controller.rst

@@ -0,0 +1,7 @@
+fastNLP.models.enas\_controller module
+======================================
+
+.. automodule:: fastNLP.models.enas_controller
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.models.enas_model.rst

@@ -0,0 +1,7 @@
+fastNLP.models.enas\_model
+==========================
+
+.. automodule:: fastNLP.models.enas_model
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.models.enas_trainer.rst

@@ -0,0 +1,7 @@
+fastNLP.models.enas\_trainer
+============================
+
+.. automodule:: fastNLP.models.enas_trainer
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.models.enas_utils.rst

@@ -0,0 +1,7 @@
+fastNLP.models.enas\_utils
+==========================
+
+.. automodule:: fastNLP.models.enas_utils
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.models.rst

@@ -2,19 +2,23 @@ fastNLP.models
 ==============
 
 .. automodule:: fastNLP.models
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 子模块
 ----------
 
 .. toctree::
-   :titlesonly:
 
+   fastNLP.models.base_model
+   fastNLP.models.bert
    fastNLP.models.biaffine_parser
    fastNLP.models.cnn_text_classification
+   fastNLP.models.enas_controller
+   fastNLP.models.enas_model
+   fastNLP.models.enas_trainer
+   fastNLP.models.enas_utils
    fastNLP.models.sequence_labeling
    fastNLP.models.snli
    fastNLP.models.star_transformer
-

docs/source/fastNLP.models.sequence_labeling.rst

@@ -2,6 +2,6 @@ fastNLP.models.sequence\_labeling
 =================================
 
 .. automodule:: fastNLP.models.sequence_labeling
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.models.snli.rst

@@ -2,6 +2,6 @@ fastNLP.models.snli
 ===================
 
 .. automodule:: fastNLP.models.snli
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.models.star_transformer.rst

@@ -2,6 +2,6 @@ fastNLP.models.star\_transformer
 ================================
 
 .. automodule:: fastNLP.models.star_transformer
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.modules.decoder.crf.rst

@@ -1,7 +0,0 @@
-fastNLP.modules.decoder.CRF
-===========================
-
-.. automodule:: fastNLP.modules.decoder.crf
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/fastNLP.modules.decoder.mlp.rst

@@ -1,7 +0,0 @@
-fastNLP.modules.decoder.MLP
-===========================
-
-.. automodule:: fastNLP.modules.decoder.mlp
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/fastNLP.modules.decoder.rst

@@ -2,17 +2,7 @@ fastNLP.modules.decoder
 =======================
 
 .. automodule:: fastNLP.modules.decoder
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-子模块
-----------
-
-.. toctree::
-   :titlesonly:
-
-   fastNLP.modules.decoder.crf
-   fastNLP.modules.decoder.mlp
-   fastNLP.modules.decoder.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
 

docs/source/fastNLP.modules.decoder.utils.rst

@@ -1,7 +0,0 @@
-fastNLP.modules.decoder.utils
-=============================
-
-.. automodule:: fastNLP.modules.decoder.utils
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/fastNLP.modules.encoder.bert.rst

@@ -1,7 +0,0 @@
-fastNLP.modules.encoder.bert
-============================
-
-.. automodule:: fastNLP.modules.encoder.bert
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/fastNLP.modules.encoder.char_encoder.rst

@@ -1,7 +0,0 @@
-fastNLP.modules.encoder.char\_encoder
-=====================================
-
-.. automodule:: fastNLP.modules.encoder.char_encoder
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/fastNLP.modules.encoder.conv_maxpool.rst

@@ -1,7 +0,0 @@
-fastNLP.modules.encoder.conv\_maxpool
-=====================================
-
-.. automodule:: fastNLP.modules.encoder.conv_maxpool
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/fastNLP.modules.encoder.embedding.rst

@@ -1,7 +0,0 @@
-fastNLP.modules.encoder.embedding
-=================================
-
-.. automodule:: fastNLP.modules.encoder.embedding
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/fastNLP.modules.encoder.lstm.rst

@@ -1,7 +0,0 @@
-fastNLP.modules.encoder.lstm
-============================
-
-.. automodule:: fastNLP.modules.encoder.lstm
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/fastNLP.modules.encoder.rst

@@ -2,22 +2,6 @@ fastNLP.modules.encoder
 =======================
 
 .. automodule:: fastNLP.modules.encoder
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-子模块
-----------
-
-.. toctree::
-   :titlesonly:
-
-   fastNLP.modules.encoder.bert
-   fastNLP.modules.encoder.char_encoder
-   fastNLP.modules.encoder.conv_maxpool
-   fastNLP.modules.encoder.embedding
-   fastNLP.modules.encoder.lstm
-   fastNLP.modules.encoder.star_transformer
-   fastNLP.modules.encoder.transformer
-   fastNLP.modules.encoder.variational_rnn
-
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.modules.encoder.star_transformer.rst

@@ -1,7 +0,0 @@
-fastNLP.modules.encoder.star\_transformer
-=========================================
-
-.. automodule:: fastNLP.modules.encoder.star_transformer
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/fastNLP.modules.encoder.transformer.rst

@@ -1,7 +0,0 @@
-fastNLP.modules.encoder.transformer
-===================================
-
-.. automodule:: fastNLP.modules.encoder.transformer
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/fastNLP.modules.encoder.variational_rnn.rst

@@ -1,7 +0,0 @@
-fastNLP.modules.encoder.variational\_rnn
-========================================
-
-.. automodule:: fastNLP.modules.encoder.variational_rnn
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/fastNLP.modules.rst

@@ -2,9 +2,9 @@ fastNLP.modules
 ===============
 
 .. automodule:: fastNLP.modules
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 子模块
 -----------

docs/source/fastNLP.rst

@@ -2,19 +2,17 @@ API 文档
 ===============
 
 .. automodule:: fastNLP
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 内部模块
 -----------
 
 .. toctree::
-    :titlesonly:
-    :maxdepth: 3
-
-    fastNLP.core
-    fastNLP.io
-    fastNLP.modules
-    fastNLP.models
 
+   fastNLP.core
+   fastNLP.embeddings
+   fastNLP.io
+   fastNLP.models
+   fastNLP.modules