新增的rst文件

docs/source/fastNLP.core.callbacks.timer_callback.rst

@@ -0,0 +1,7 @@
+fastNLP.core.callbacks.timer\_callback module
+=============================================
+
+.. automodule:: fastNLP.core.callbacks.timer_callback
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.core.collators.padders.oneflow_padder.rst

@@ -0,0 +1,7 @@
+fastNLP.core.collators.padders.oneflow\_padder module
+=====================================================
+
+.. automodule:: fastNLP.core.collators.padders.oneflow_padder
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.core.dataloaders.oneflow_dataloader.fdl.rst

@@ -0,0 +1,7 @@
+fastNLP.core.dataloaders.oneflow\_dataloader.fdl module
+=======================================================
+
+.. automodule:: fastNLP.core.dataloaders.oneflow_dataloader.fdl
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.core.dataloaders.oneflow_dataloader.rst

@@ -0,0 +1,15 @@
+fastNLP.core.dataloaders.oneflow\_dataloader package
+====================================================
+
+.. automodule:: fastNLP.core.dataloaders.oneflow_dataloader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   fastNLP.core.dataloaders.oneflow_dataloader.fdl

docs/source/fastNLP.core.dataloaders.torch_dataloader.mix_dataloader.rst

@@ -0,0 +1,7 @@
+fastNLP.core.dataloaders.torch\_dataloader.mix\_dataloader module
+=================================================================
+
+.. automodule:: fastNLP.core.dataloaders.torch_dataloader.mix_dataloader
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.core.drivers.oneflow_driver.ddp.rst

@@ -0,0 +1,7 @@
+fastNLP.core.drivers.oneflow\_driver.ddp module
+===============================================
+
+.. automodule:: fastNLP.core.drivers.oneflow_driver.ddp
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.core.drivers.oneflow_driver.dist_utils.rst

@@ -0,0 +1,7 @@
+fastNLP.core.drivers.oneflow\_driver.dist\_utils module
+=======================================================
+
+.. automodule:: fastNLP.core.drivers.oneflow_driver.dist_utils
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.core.drivers.oneflow_driver.initialize_oneflow_driver.rst

@@ -0,0 +1,7 @@
+fastNLP.core.drivers.oneflow\_driver.initialize\_oneflow\_driver module
+=======================================================================
+
+.. automodule:: fastNLP.core.drivers.oneflow_driver.initialize_oneflow_driver
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.core.drivers.oneflow_driver.oneflow_driver.rst

@@ -0,0 +1,7 @@
+fastNLP.core.drivers.oneflow\_driver.oneflow\_driver module
+===========================================================
+
+.. automodule:: fastNLP.core.drivers.oneflow_driver.oneflow_driver
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.core.drivers.oneflow_driver.rst

@@ -0,0 +1,20 @@
+fastNLP.core.drivers.oneflow\_driver package
+============================================
+
+.. automodule:: fastNLP.core.drivers.oneflow_driver
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   fastNLP.core.drivers.oneflow_driver.ddp
+   fastNLP.core.drivers.oneflow_driver.dist_utils
+   fastNLP.core.drivers.oneflow_driver.initialize_oneflow_driver
+   fastNLP.core.drivers.oneflow_driver.oneflow_driver
+   fastNLP.core.drivers.oneflow_driver.single_device
+   fastNLP.core.drivers.oneflow_driver.utils

docs/source/fastNLP.core.drivers.oneflow_driver.single_device.rst

@@ -0,0 +1,7 @@
+fastNLP.core.drivers.oneflow\_driver.single\_device module
+==========================================================
+
+.. automodule:: fastNLP.core.drivers.oneflow_driver.single_device
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.core.drivers.oneflow_driver.utils.rst

@@ -0,0 +1,7 @@
+fastNLP.core.drivers.oneflow\_driver.utils module
+=================================================
+
+.. automodule:: fastNLP.core.drivers.oneflow_driver.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.core.drivers.torch_driver.deepspeed.rst

@@ -0,0 +1,7 @@
+fastNLP.core.drivers.torch\_driver.deepspeed module
+===================================================
+
+.. automodule:: fastNLP.core.drivers.torch_driver.deepspeed
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.core.drivers.torch_driver.fairscale.rst

@@ -0,0 +1,7 @@
+fastNLP.core.drivers.torch\_driver.fairscale module
+===================================================
+
+.. automodule:: fastNLP.core.drivers.torch_driver.fairscale
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.core.drivers.torch_driver.torch_fsdp.rst

@@ -0,0 +1,7 @@
+fastNLP.core.drivers.torch\_driver.torch\_fsdp module
+=====================================================
+
+.. automodule:: fastNLP.core.drivers.torch_driver.torch_fsdp
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.core.metrics.backend.oneflow_backend.backend.rst

@@ -0,0 +1,7 @@
+fastNLP.core.metrics.backend.oneflow\_backend.backend module
+============================================================
+
+.. automodule:: fastNLP.core.metrics.backend.oneflow_backend.backend
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.core.metrics.backend.oneflow_backend.rst

@@ -0,0 +1,15 @@
+fastNLP.core.metrics.backend.oneflow\_backend package
+=====================================================
+
+.. automodule:: fastNLP.core.metrics.backend.oneflow_backend
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   fastNLP.core.metrics.backend.oneflow_backend.backend

docs/source/fastNLP.core.utils.oneflow_utils.rst

@@ -0,0 +1,7 @@
+fastNLP.core.utils.oneflow\_utils module
+========================================
+
+.. automodule:: fastNLP.core.utils.oneflow_utils
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.core.utils.seq_len_to_mask.rst

@@ -0,0 +1,7 @@
+fastNLP.core.utils.seq\_len\_to\_mask module
+============================================
+
+.. automodule:: fastNLP.core.utils.seq_len_to_mask
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.core.utils.tqdm_progress.rst

@@ -0,0 +1,7 @@
+fastNLP.core.utils.tqdm\_progress module
+========================================
+
+.. automodule:: fastNLP.core.utils.tqdm_progress
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.embeddings.rst

@@ -0,0 +1,15 @@
+fastNLP.embeddings package
+==========================
+
+.. automodule:: fastNLP.embeddings
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   fastNLP.embeddings.torch

docs/source/fastNLP.embeddings.torch.char_embedding.rst

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

docs/source/fastNLP.embeddings.torch.embedding.rst

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

docs/source/fastNLP.embeddings.torch.rst

@@ -0,0 +1,19 @@
+fastNLP.embeddings.torch package
+================================
+
+.. automodule:: fastNLP.embeddings.torch
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   fastNLP.embeddings.torch.char_embedding
+   fastNLP.embeddings.torch.embedding
+   fastNLP.embeddings.torch.stack_embedding
+   fastNLP.embeddings.torch.static_embedding
+   fastNLP.embeddings.torch.utils

docs/source/fastNLP.embeddings.torch.stack_embedding.rst

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

docs/source/fastNLP.embeddings.torch.static_embedding.rst

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

docs/source/fastNLP.embeddings.torch.utils.rst

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

docs/source/fastNLP.models.rst

@@ -0,0 +1,15 @@
+fastNLP.models package
+======================
+
+.. automodule:: fastNLP.models
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   fastNLP.models.torch

docs/source/fastNLP.models.torch.biaffine_parser.rst

@@ -0,0 +1,7 @@
+fastNLP.models.torch.biaffine\_parser module
+============================================
+
+.. automodule:: fastNLP.models.torch.biaffine_parser
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.models.torch.cnn_text_classification.rst

@@ -0,0 +1,7 @@
+fastNLP.models.torch.cnn\_text\_classification module
+=====================================================
+
+.. automodule:: fastNLP.models.torch.cnn_text_classification
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.models.torch.rst

@@ -0,0 +1,19 @@
+fastNLP.models.torch package
+============================
+
+.. automodule:: fastNLP.models.torch
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   fastNLP.models.torch.biaffine_parser
+   fastNLP.models.torch.cnn_text_classification
+   fastNLP.models.torch.seq2seq_generator
+   fastNLP.models.torch.seq2seq_model
+   fastNLP.models.torch.sequence_labeling

docs/source/fastNLP.models.torch.seq2seq_generator.rst

@@ -0,0 +1,7 @@
+fastNLP.models.torch.seq2seq\_generator module
+==============================================
+
+.. automodule:: fastNLP.models.torch.seq2seq_generator
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.models.torch.seq2seq_model.rst

@@ -0,0 +1,7 @@
+fastNLP.models.torch.seq2seq\_model module
+==========================================
+
+.. automodule:: fastNLP.models.torch.seq2seq_model
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.models.torch.sequence_labeling.rst

@@ -0,0 +1,7 @@
+fastNLP.models.torch.sequence\_labeling module
+==============================================
+
+.. automodule:: fastNLP.models.torch.sequence_labeling
+   :members:
+   :undoc-members:
+   :show-inheritance:

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

@@ -0,0 +1,7 @@
+fastNLP.modules.torch.attention module
+======================================
+
+.. automodule:: fastNLP.modules.torch.attention
+   :members:
+   :undoc-members:
+   :show-inheritance:

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

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

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

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

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

@@ -0,0 +1,18 @@
+fastNLP.modules.torch.decoder package
+=====================================
+
+.. automodule:: fastNLP.modules.torch.decoder
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   fastNLP.modules.torch.decoder.crf
+   fastNLP.modules.torch.decoder.mlp
+   fastNLP.modules.torch.decoder.seq2seq_decoder
+   fastNLP.modules.torch.decoder.seq2seq_state

docs/source/fastNLP.modules.torch.decoder.seq2seq_decoder.rst

@@ -0,0 +1,7 @@
+fastNLP.modules.torch.decoder.seq2seq\_decoder module
+=====================================================
+
+.. automodule:: fastNLP.modules.torch.decoder.seq2seq_decoder
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.modules.torch.decoder.seq2seq_state.rst

@@ -0,0 +1,7 @@
+fastNLP.modules.torch.decoder.seq2seq\_state module
+===================================================
+
+.. automodule:: fastNLP.modules.torch.decoder.seq2seq_state
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.modules.torch.dropout.rst

@@ -0,0 +1,7 @@
+fastNLP.modules.torch.dropout module
+====================================
+
+.. automodule:: fastNLP.modules.torch.dropout
+   :members:
+   :undoc-members:
+   :show-inheritance:

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

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

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

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

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

@@ -0,0 +1,20 @@
+fastNLP.modules.torch.encoder package
+=====================================
+
+.. automodule:: fastNLP.modules.torch.encoder
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   fastNLP.modules.torch.encoder.conv_maxpool
+   fastNLP.modules.torch.encoder.lstm
+   fastNLP.modules.torch.encoder.seq2seq_encoder
+   fastNLP.modules.torch.encoder.star_transformer
+   fastNLP.modules.torch.encoder.transformer
+   fastNLP.modules.torch.encoder.variational_rnn

docs/source/fastNLP.modules.torch.encoder.seq2seq_encoder.rst

@@ -0,0 +1,7 @@
+fastNLP.modules.torch.encoder.seq2seq\_encoder module
+=====================================================
+
+.. automodule:: fastNLP.modules.torch.encoder.seq2seq_encoder
+   :members:
+   :undoc-members:
+   :show-inheritance:

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

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

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

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

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

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

docs/source/fastNLP.modules.torch.generator.rst

@@ -0,0 +1,15 @@
+fastNLP.modules.torch.generator package
+=======================================
+
+.. automodule:: fastNLP.modules.torch.generator
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   fastNLP.modules.torch.generator.seq2seq_generator

docs/source/fastNLP.modules.torch.generator.seq2seq_generator.rst

@@ -0,0 +1,7 @@
+fastNLP.modules.torch.generator.seq2seq\_generator module
+=========================================================
+
+.. automodule:: fastNLP.modules.torch.generator.seq2seq_generator
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/fastNLP.modules.torch.rst

@@ -0,0 +1,26 @@
+fastNLP.modules.torch package
+=============================
+
+.. automodule:: fastNLP.modules.torch
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   fastNLP.modules.torch.decoder
+   fastNLP.modules.torch.encoder
+   fastNLP.modules.torch.generator
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   fastNLP.modules.torch.attention
+   fastNLP.modules.torch.dropout

docs/source/fastNLP.transformers.rst

@@ -0,0 +1,15 @@
+fastNLP.transformers package
+=======================
+
+.. automodule:: fastNLP.transformers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   fastNLP.transformers.torch

docs/source/fastNLP.transformers.torch.rst

@@ -0,0 +1,7 @@
+fastNLP.transformers.torch package
+=======================
+
+.. automodule:: fastNLP.transformers.torch
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/index.rst

@@ -2,18 +2,18 @@ fastNLP 中文文档
 =====================
 
 
-用户手册
+快速上手
 ----------------
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
 
-    语法样例 </user/example>
+   tutorials
 
 API 文档
 -------------
 
-除了用户手册之外，你还可以通过查阅 API 文档来找到你所需要的工具。
+您可以通过查阅 API 文档来找到你所需要的工具。
 
 .. toctree::
    :titlesonly:

docs/source/tutorials.rst

@@ -0,0 +1,8 @@
+fastNLP 教程系列
+================
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   tutorials/*