修改文档中的中文名称

docs/source/fastNLP.component.bert_tokenizer.rst

@@ -1,7 +0,0 @@
-fastNLP.component.bert\_tokenizer module
-========================================
-
-.. automodule:: fastNLP.component.bert_tokenizer
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/fastNLP.component.rst

@@ -1,15 +0,0 @@
-fastNLP.component package
-=========================
-
-.. automodule:: fastNLP.component
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-Submodules
-----------
-
-.. toctree::
-
-   fastNLP.component.bert_tokenizer
-

docs/source/fastNLP.core.batch.rst

@@ -1,5 +1,5 @@
-fastNLP.core.batch module
-=========================
+fastNLP.core.batch
+==================
 
 .. automodule:: fastNLP.core.batch
     :members:

docs/source/fastNLP.core.callback.rst

@@ -1,5 +1,5 @@
-fastNLP.core.callback module
-============================
+fastNLP.core.callback
+=====================
 
 .. automodule:: fastNLP.core.callback
     :members:

docs/source/fastNLP.core.const.rst

@@ -1,5 +1,5 @@
-fastNLP.core.const module
-=========================
+fastNLP.core.const
+==================
 
 .. automodule:: fastNLP.core.const
     :members:

docs/source/fastNLP.core.dataset.rst

@@ -1,5 +1,5 @@
-fastNLP.core.dataset module
-===========================
+fastNLP.core.dataset
+====================
 
 .. automodule:: fastNLP.core.dataset
     :members:

docs/source/fastNLP.core.field.rst

@@ -1,5 +1,5 @@
-fastNLP.core.field module
-=========================
+fastNLP.core.field
+==================
 
 .. automodule:: fastNLP.core.field
     :members:

docs/source/fastNLP.core.instance.rst

@@ -1,5 +1,5 @@
-fastNLP.core.instance module
-============================
+fastNLP.core.instance
+=====================
 
 .. automodule:: fastNLP.core.instance
     :members:

docs/source/fastNLP.core.losses.rst

@@ -1,5 +1,5 @@
-fastNLP.core.losses module
-==========================
+fastNLP.core.losses
+===================
 
 .. automodule:: fastNLP.core.losses
     :members:

docs/source/fastNLP.core.metrics.rst

@@ -1,5 +1,5 @@
-fastNLP.core.metrics module
-===========================
+fastNLP.core.metrics
+====================
 
 .. automodule:: fastNLP.core.metrics
     :members:

docs/source/fastNLP.core.optimizer.rst

@@ -1,5 +1,5 @@
-fastNLP.core.optimizer module
-=============================
+fastNLP.core.optimizer
+======================
 
 .. automodule:: fastNLP.core.optimizer
     :members:

docs/source/fastNLP.core.rst

@@ -1,4 +1,4 @@
-fastNLP.core package
+fastNLP.core 模块
 ====================
 
 .. automodule:: fastNLP.core
@@ -6,7 +6,7 @@ fastNLP.core package
     :undoc-members:
     :show-inheritance:
 
-Submodules
+子模块
 ----------
 
 .. toctree::

docs/source/fastNLP.core.sampler.rst

@@ -1,5 +1,5 @@
-fastNLP.core.sampler module
-===========================
+fastNLP.core.sampler
+====================
 
 .. automodule:: fastNLP.core.sampler
     :members:

docs/source/fastNLP.core.tester.rst

@@ -1,5 +1,5 @@
-fastNLP.core.tester module
-==========================
+fastNLP.core.tester
+===================
 
 .. automodule:: fastNLP.core.tester
     :members:

docs/source/fastNLP.core.trainer.rst

@@ -1,5 +1,5 @@
-fastNLP.core.trainer module
-===========================
+fastNLP.core.trainer
+====================
 
 .. automodule:: fastNLP.core.trainer
     :members:

docs/source/fastNLP.core.utils.rst

@@ -1,5 +1,5 @@
-fastNLP.core.utils module
-=========================
+fastNLP.core.utils
+==================
 
 .. automodule:: fastNLP.core.utils
     :members:

docs/source/fastNLP.core.vocabulary.rst

@@ -1,5 +1,5 @@
-fastNLP.core.vocabulary module
-==============================
+fastNLP.core.vocabulary
+=======================
 
 .. automodule:: fastNLP.core.vocabulary
     :members:

docs/source/fastNLP.io.base_loader.rst

@@ -1,5 +1,5 @@
-fastNLP.io.base\_loader module
-==============================
+fastNLP.io.base\_loader
+=======================
 
 .. automodule:: fastNLP.io.base_loader
     :members:

docs/source/fastNLP.io.dataset_loader.rst

@@ -1,5 +1,5 @@
-fastNLP.io.dataset\_loader module
-=================================
+fastNLP.io.dataset\_loader
+==========================
 
 .. automodule:: fastNLP.io.dataset_loader
     :members:

docs/source/fastNLP.io.embed_loader.rst

@@ -1,5 +1,5 @@
-fastNLP.io.embed\_loader module
-===============================
+fastNLP.io.embed\_loader
+========================
 
 .. automodule:: fastNLP.io.embed_loader
     :members:

docs/source/fastNLP.io.model_io.rst

@@ -1,5 +1,5 @@
-fastNLP.io.model\_io module
-===========================
+fastNLP.io.model\_io
+====================
 
 .. automodule:: fastNLP.io.model_io
     :members:

docs/source/fastNLP.io.rst

@@ -1,4 +1,4 @@
-fastNLP.io package
+fastNLP.io 模块
 ==================
 
 .. automodule:: fastNLP.io
@@ -6,7 +6,7 @@ fastNLP.io package
     :undoc-members:
     :show-inheritance:
 
-Submodules
+子模块
 ----------
 
 .. toctree::

docs/source/fastNLP.models.base_model.rst

@@ -1,5 +1,5 @@
-fastNLP.models.base\_model module
-=================================
+fastNLP.models.base\_model
+==========================
 
 .. automodule:: fastNLP.models.base_model
     :members:

docs/source/fastNLP.models.bert.rst

@@ -1,5 +1,5 @@
-fastNLP.models.bert module
-==========================
+fastNLP.models.bert
+===================
 
 .. automodule:: fastNLP.models.bert
     :members:

docs/source/fastNLP.models.biaffine_parser.rst

@@ -1,5 +1,5 @@
-fastNLP.models.biaffine\_parser module
-======================================
+fastNLP.models.biaffine\_parser
+===============================
 
 .. automodule:: fastNLP.models.biaffine_parser
     :members:

docs/source/fastNLP.models.cnn_text_classification.rst

@@ -1,5 +1,5 @@
-fastNLP.models.cnn\_text\_classification module
-===============================================
+fastNLP.models.cnn\_text\_classification
+========================================
 
 .. automodule:: fastNLP.models.cnn_text_classification
     :members:

docs/source/fastNLP.models.enas_controller.rst

@@ -1,5 +1,5 @@
-fastNLP.models.enas\_controller module
-======================================
+fastNLP.models.enas\_controller
+===============================
 
 .. automodule:: fastNLP.models.enas_controller
     :members:

docs/source/fastNLP.models.enas_model.rst

@@ -1,5 +1,5 @@
-fastNLP.models.enas\_model module
-=================================
+fastNLP.models.enas\_model
+==========================
 
 .. automodule:: fastNLP.models.enas_model
     :members:

docs/source/fastNLP.models.enas_trainer.rst

@@ -1,5 +1,5 @@
-fastNLP.models.enas\_trainer module
-===================================
+fastNLP.models.enas\_trainer
+============================
 
 .. automodule:: fastNLP.models.enas_trainer
     :members:

docs/source/fastNLP.models.enas_utils.rst

@@ -1,5 +1,5 @@
-fastNLP.models.enas\_utils module
-=================================
+fastNLP.models.enas\_utils
+==========================
 
 .. automodule:: fastNLP.models.enas_utils
     :members:

docs/source/fastNLP.models.rst

@@ -1,4 +1,4 @@
-fastNLP.models package
+fastNLP.models 模块
 ======================
 
 .. automodule:: fastNLP.models
@@ -6,7 +6,7 @@ fastNLP.models package
     :undoc-members:
     :show-inheritance:
 
-Submodules
+子模块
 ----------
 
 .. toctree::

docs/source/fastNLP.models.sequence_labeling.rst

@@ -1,5 +1,5 @@
-fastNLP.models.sequence\_labeling module
-========================================
+fastNLP.models.sequence\_labeling
+=================================
 
 .. automodule:: fastNLP.models.sequence_labeling
     :members:

docs/source/fastNLP.models.snli.rst

@@ -1,5 +1,5 @@
-fastNLP.models.snli module
-==========================
+fastNLP.models.snli
+===================
 
 .. automodule:: fastNLP.models.snli
     :members:

docs/source/fastNLP.models.star_transformer.rst

@@ -1,5 +1,5 @@
-fastNLP.models.star\_transformer module
-=======================================
+fastNLP.models.star\_transformer
+================================
 
 .. automodule:: fastNLP.models.star_transformer
     :members:

docs/source/fastNLP.modules.aggregator.attention.rst

@@ -1,5 +1,5 @@
-fastNLP.modules.aggregator.attention module
-===========================================
+fastNLP.modules.aggregator.attention
+====================================
 
 .. automodule:: fastNLP.modules.aggregator.attention
     :members:

docs/source/fastNLP.modules.aggregator.pooling.rst

@@ -1,5 +1,5 @@
-fastNLP.modules.aggregator.pooling module
-=========================================
+fastNLP.modules.aggregator.pooling
+==================================
 
 .. automodule:: fastNLP.modules.aggregator.pooling
     :members:

docs/source/fastNLP.modules.aggregator.rst

@@ -1,12 +1,12 @@
-fastNLP.modules.aggregator package
-==================================
+fastNLP.modules.aggregator
+==========================
 
 .. automodule:: fastNLP.modules.aggregator
     :members:
     :undoc-members:
     :show-inheritance:
 
-Submodules
+子模块
 ----------
 
 .. toctree::

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

@@ -1,5 +1,5 @@
-fastNLP.modules.decoder.CRF module
-==================================
+fastNLP.modules.decoder.CRF
+===========================
 
 .. automodule:: fastNLP.modules.decoder.CRF
     :members:

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

@@ -1,5 +1,5 @@
-fastNLP.modules.decoder.MLP module
-==================================
+fastNLP.modules.decoder.MLP
+===========================
 
 .. automodule:: fastNLP.modules.decoder.MLP
     :members:

docs/source/fastNLP.modules.decoder.rst

@@ -1,12 +1,12 @@
-fastNLP.modules.decoder package
-===============================
+fastNLP.modules.decoder
+=======================
 
 .. automodule:: fastNLP.modules.decoder
     :members:
     :undoc-members:
     :show-inheritance:
 
-Submodules
+子模块
 ----------
 
 .. toctree::

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

@@ -1,5 +1,5 @@
-fastNLP.modules.decoder.utils module
-====================================
+fastNLP.modules.decoder.utils
+=============================
 
 .. automodule:: fastNLP.modules.decoder.utils
     :members:

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

@@ -1,5 +1,5 @@
-fastNLP.modules.encoder.bert module
-===================================
+fastNLP.modules.encoder.bert
+============================
 
 .. automodule:: fastNLP.modules.encoder.bert
     :members:

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

@@ -1,5 +1,5 @@
-fastNLP.modules.encoder.char\_encoder module
-============================================
+fastNLP.modules.encoder.char\_encoder
+=====================================
 
 .. automodule:: fastNLP.modules.encoder.char_encoder
     :members:

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

@@ -1,5 +1,5 @@
-fastNLP.modules.encoder.conv\_maxpool module
-============================================
+fastNLP.modules.encoder.conv\_maxpool
+=====================================
 
 .. automodule:: fastNLP.modules.encoder.conv_maxpool
     :members:

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

@@ -1,5 +1,5 @@
-fastNLP.modules.encoder.embedding module
-========================================
+fastNLP.modules.encoder.embedding
+=================================
 
 .. automodule:: fastNLP.modules.encoder.embedding
     :members:

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

@@ -1,5 +1,5 @@
-fastNLP.modules.encoder.lstm module
-===================================
+fastNLP.modules.encoder.lstm
+============================
 
 .. automodule:: fastNLP.modules.encoder.lstm
     :members:

docs/source/fastNLP.modules.encoder.rst

@@ -1,12 +1,12 @@
-fastNLP.modules.encoder package
-===============================
+fastNLP.modules.encoder
+=======================
 
 .. automodule:: fastNLP.modules.encoder
     :members:
     :undoc-members:
     :show-inheritance:
 
-Submodules
+子模块
 ----------
 
 .. toctree::

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

@@ -1,5 +1,5 @@
-fastNLP.modules.encoder.star\_transformer module
-================================================
+fastNLP.modules.encoder.star\_transformer
+=========================================
 
 .. automodule:: fastNLP.modules.encoder.star_transformer
     :members:

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

@@ -1,5 +1,5 @@
-fastNLP.modules.encoder.transformer module
-==========================================
+fastNLP.modules.encoder.transformer
+===================================
 
 .. automodule:: fastNLP.modules.encoder.transformer
     :members:

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

@@ -1,5 +1,5 @@
-fastNLP.modules.encoder.variational\_rnn module
-===============================================
+fastNLP.modules.encoder.variational\_rnn
+========================================
 
 .. automodule:: fastNLP.modules.encoder.variational_rnn
     :members:

docs/source/fastNLP.modules.rst

@@ -1,4 +1,4 @@
-fastNLP.modules package
+fastNLP.modules 模块
 =======================
 
 .. automodule:: fastNLP.modules
@@ -6,7 +6,7 @@ fastNLP.modules package
     :undoc-members:
     :show-inheritance:
 
-Subpackages
+子模块
 -----------
 
 .. toctree::

docs/source/fastNLP.rst

@@ -1,4 +1,4 @@
-fastNLP package
+用户 API
 ===============
 
 .. automodule:: fastNLP
@@ -6,14 +6,14 @@ fastNLP package
     :undoc-members:
     :show-inheritance:
 
-Subpackages
+内部模块
 -----------
 
 .. toctree::
+    :maxdepth: 3
 
-    fastNLP.component
     fastNLP.core
     fastNLP.io
-    fastNLP.models
     fastNLP.modules
+    fastNLP.models
 

docs/source/index.rst

@@ -46,11 +46,6 @@ For example:
 
 （TODO）
 
-快速入门
--------------
-
-TODO
-
 
 用户手册
 ---------------
@@ -60,7 +55,7 @@ TODO
 
     安装指南 <user/installation>
     快速入门 <user/quickstart>
-    详细指南 <user/tutorials>
+    详细指南 <user/tutorial_one>
     科研向导 <user/with_fitlog>