From 819897a4f6a5375eb8c749a44f30a6aecf93ad79 Mon Sep 17 00:00:00 2001 From: x54-729 <17307130121@fudan.edu.cn> Date: Thu, 7 Jul 2022 11:23:02 +0000 Subject: [PATCH] =?UTF-8?q?=E6=96=B0=E5=A2=9E=E7=9A=84rst=E6=96=87?= =?UTF-8?q?=E4=BB=B6?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../fastNLP.core.callbacks.timer_callback.rst | 7 +++++ ....core.collators.padders.oneflow_padder.rst | 7 +++++ ...ore.dataloaders.oneflow_dataloader.fdl.rst | 7 +++++ ...LP.core.dataloaders.oneflow_dataloader.rst | 15 +++++++++++ ...oaders.torch_dataloader.mix_dataloader.rst | 7 +++++ ...astNLP.core.drivers.oneflow_driver.ddp.rst | 7 +++++ ...core.drivers.oneflow_driver.dist_utils.rst | 7 +++++ ...eflow_driver.initialize_oneflow_driver.rst | 7 +++++ ....drivers.oneflow_driver.oneflow_driver.rst | 7 +++++ .../fastNLP.core.drivers.oneflow_driver.rst | 20 ++++++++++++++ ...e.drivers.oneflow_driver.single_device.rst | 7 +++++ ...tNLP.core.drivers.oneflow_driver.utils.rst | 7 +++++ ...LP.core.drivers.torch_driver.deepspeed.rst | 7 +++++ ...LP.core.drivers.torch_driver.fairscale.rst | 7 +++++ ...P.core.drivers.torch_driver.torch_fsdp.rst | 7 +++++ ...etrics.backend.oneflow_backend.backend.rst | 7 +++++ ...P.core.metrics.backend.oneflow_backend.rst | 15 +++++++++++ .../fastNLP.core.utils.oneflow_utils.rst | 7 +++++ .../fastNLP.core.utils.seq_len_to_mask.rst | 7 +++++ .../fastNLP.core.utils.tqdm_progress.rst | 7 +++++ docs/source/fastNLP.embeddings.rst | 15 +++++++++++ ...astNLP.embeddings.torch.char_embedding.rst | 7 +++++ .../fastNLP.embeddings.torch.embedding.rst | 7 +++++ docs/source/fastNLP.embeddings.torch.rst | 19 ++++++++++++++ ...stNLP.embeddings.torch.stack_embedding.rst | 7 +++++ ...tNLP.embeddings.torch.static_embedding.rst | 7 +++++ .../source/fastNLP.embeddings.torch.utils.rst | 7 +++++ docs/source/fastNLP.models.rst | 15 +++++++++++ .../fastNLP.models.torch.biaffine_parser.rst | 7 +++++ ...P.models.torch.cnn_text_classification.rst | 7 +++++ docs/source/fastNLP.models.torch.rst | 19 ++++++++++++++ ...fastNLP.models.torch.seq2seq_generator.rst | 7 +++++ .../fastNLP.models.torch.seq2seq_model.rst | 7 +++++ ...fastNLP.models.torch.sequence_labeling.rst | 7 +++++ .../fastNLP.modules.torch.attention.rst | 7 +++++ .../fastNLP.modules.torch.decoder.crf.rst | 7 +++++ .../fastNLP.modules.torch.decoder.mlp.rst | 7 +++++ docs/source/fastNLP.modules.torch.decoder.rst | 18 +++++++++++++ ....modules.torch.decoder.seq2seq_decoder.rst | 7 +++++ ...LP.modules.torch.decoder.seq2seq_state.rst | 7 +++++ docs/source/fastNLP.modules.torch.dropout.rst | 7 +++++ ...NLP.modules.torch.encoder.conv_maxpool.rst | 7 +++++ .../fastNLP.modules.torch.encoder.lstm.rst | 7 +++++ docs/source/fastNLP.modules.torch.encoder.rst | 20 ++++++++++++++ ....modules.torch.encoder.seq2seq_encoder.rst | 7 +++++ ...modules.torch.encoder.star_transformer.rst | 7 +++++ ...tNLP.modules.torch.encoder.transformer.rst | 7 +++++ ....modules.torch.encoder.variational_rnn.rst | 7 +++++ .../fastNLP.modules.torch.generator.rst | 15 +++++++++++ ...ules.torch.generator.seq2seq_generator.rst | 7 +++++ docs/source/fastNLP.modules.torch.rst | 26 +++++++++++++++++++ docs/source/fastNLP.transformers.rst | 15 +++++++++++ docs/source/fastNLP.transformers.torch.rst | 7 +++++ docs/source/index.rst | 8 +++--- docs/source/tutorials.rst | 8 ++++++ 55 files changed, 511 insertions(+), 4 deletions(-) create mode 100644 docs/source/fastNLP.core.callbacks.timer_callback.rst create mode 100644 docs/source/fastNLP.core.collators.padders.oneflow_padder.rst create mode 100644 docs/source/fastNLP.core.dataloaders.oneflow_dataloader.fdl.rst create mode 100644 docs/source/fastNLP.core.dataloaders.oneflow_dataloader.rst create mode 100644 docs/source/fastNLP.core.dataloaders.torch_dataloader.mix_dataloader.rst create mode 100644 docs/source/fastNLP.core.drivers.oneflow_driver.ddp.rst create mode 100644 docs/source/fastNLP.core.drivers.oneflow_driver.dist_utils.rst create mode 100644 docs/source/fastNLP.core.drivers.oneflow_driver.initialize_oneflow_driver.rst create mode 100644 docs/source/fastNLP.core.drivers.oneflow_driver.oneflow_driver.rst create mode 100644 docs/source/fastNLP.core.drivers.oneflow_driver.rst create mode 100644 docs/source/fastNLP.core.drivers.oneflow_driver.single_device.rst create mode 100644 docs/source/fastNLP.core.drivers.oneflow_driver.utils.rst create mode 100644 docs/source/fastNLP.core.drivers.torch_driver.deepspeed.rst create mode 100644 docs/source/fastNLP.core.drivers.torch_driver.fairscale.rst create mode 100644 docs/source/fastNLP.core.drivers.torch_driver.torch_fsdp.rst create mode 100644 docs/source/fastNLP.core.metrics.backend.oneflow_backend.backend.rst create mode 100644 docs/source/fastNLP.core.metrics.backend.oneflow_backend.rst create mode 100644 docs/source/fastNLP.core.utils.oneflow_utils.rst create mode 100644 docs/source/fastNLP.core.utils.seq_len_to_mask.rst create mode 100644 docs/source/fastNLP.core.utils.tqdm_progress.rst create mode 100644 docs/source/fastNLP.embeddings.rst create mode 100644 docs/source/fastNLP.embeddings.torch.char_embedding.rst create mode 100644 docs/source/fastNLP.embeddings.torch.embedding.rst create mode 100644 docs/source/fastNLP.embeddings.torch.rst create mode 100644 docs/source/fastNLP.embeddings.torch.stack_embedding.rst create mode 100644 docs/source/fastNLP.embeddings.torch.static_embedding.rst create mode 100644 docs/source/fastNLP.embeddings.torch.utils.rst create mode 100644 docs/source/fastNLP.models.rst create mode 100644 docs/source/fastNLP.models.torch.biaffine_parser.rst create mode 100644 docs/source/fastNLP.models.torch.cnn_text_classification.rst create mode 100644 docs/source/fastNLP.models.torch.rst create mode 100644 docs/source/fastNLP.models.torch.seq2seq_generator.rst create mode 100644 docs/source/fastNLP.models.torch.seq2seq_model.rst create mode 100644 docs/source/fastNLP.models.torch.sequence_labeling.rst create mode 100644 docs/source/fastNLP.modules.torch.attention.rst create mode 100644 docs/source/fastNLP.modules.torch.decoder.crf.rst create mode 100644 docs/source/fastNLP.modules.torch.decoder.mlp.rst create mode 100644 docs/source/fastNLP.modules.torch.decoder.rst create mode 100644 docs/source/fastNLP.modules.torch.decoder.seq2seq_decoder.rst create mode 100644 docs/source/fastNLP.modules.torch.decoder.seq2seq_state.rst create mode 100644 docs/source/fastNLP.modules.torch.dropout.rst create mode 100644 docs/source/fastNLP.modules.torch.encoder.conv_maxpool.rst create mode 100644 docs/source/fastNLP.modules.torch.encoder.lstm.rst create mode 100644 docs/source/fastNLP.modules.torch.encoder.rst create mode 100644 docs/source/fastNLP.modules.torch.encoder.seq2seq_encoder.rst create mode 100644 docs/source/fastNLP.modules.torch.encoder.star_transformer.rst create mode 100644 docs/source/fastNLP.modules.torch.encoder.transformer.rst create mode 100644 docs/source/fastNLP.modules.torch.encoder.variational_rnn.rst create mode 100644 docs/source/fastNLP.modules.torch.generator.rst create mode 100644 docs/source/fastNLP.modules.torch.generator.seq2seq_generator.rst create mode 100644 docs/source/fastNLP.modules.torch.rst create mode 100644 docs/source/fastNLP.transformers.rst create mode 100644 docs/source/fastNLP.transformers.torch.rst create mode 100644 docs/source/tutorials.rst diff --git a/docs/source/fastNLP.core.callbacks.timer_callback.rst b/docs/source/fastNLP.core.callbacks.timer_callback.rst new file mode 100644 index 00000000..884fa604 --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.core.collators.padders.oneflow_padder.rst b/docs/source/fastNLP.core.collators.padders.oneflow_padder.rst new file mode 100644 index 00000000..ced75ccb --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.core.dataloaders.oneflow_dataloader.fdl.rst b/docs/source/fastNLP.core.dataloaders.oneflow_dataloader.fdl.rst new file mode 100644 index 00000000..5a8939b0 --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.core.dataloaders.oneflow_dataloader.rst b/docs/source/fastNLP.core.dataloaders.oneflow_dataloader.rst new file mode 100644 index 00000000..2b2081e5 --- /dev/null +++ b/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 diff --git a/docs/source/fastNLP.core.dataloaders.torch_dataloader.mix_dataloader.rst b/docs/source/fastNLP.core.dataloaders.torch_dataloader.mix_dataloader.rst new file mode 100644 index 00000000..cd8bd865 --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.core.drivers.oneflow_driver.ddp.rst b/docs/source/fastNLP.core.drivers.oneflow_driver.ddp.rst new file mode 100644 index 00000000..c7618619 --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.core.drivers.oneflow_driver.dist_utils.rst b/docs/source/fastNLP.core.drivers.oneflow_driver.dist_utils.rst new file mode 100644 index 00000000..9eae5d19 --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.core.drivers.oneflow_driver.initialize_oneflow_driver.rst b/docs/source/fastNLP.core.drivers.oneflow_driver.initialize_oneflow_driver.rst new file mode 100644 index 00000000..d7272c8e --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.core.drivers.oneflow_driver.oneflow_driver.rst b/docs/source/fastNLP.core.drivers.oneflow_driver.oneflow_driver.rst new file mode 100644 index 00000000..1f5d159e --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.core.drivers.oneflow_driver.rst b/docs/source/fastNLP.core.drivers.oneflow_driver.rst new file mode 100644 index 00000000..213dd24b --- /dev/null +++ b/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 diff --git a/docs/source/fastNLP.core.drivers.oneflow_driver.single_device.rst b/docs/source/fastNLP.core.drivers.oneflow_driver.single_device.rst new file mode 100644 index 00000000..a54e74ec --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.core.drivers.oneflow_driver.utils.rst b/docs/source/fastNLP.core.drivers.oneflow_driver.utils.rst new file mode 100644 index 00000000..1eda7794 --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.core.drivers.torch_driver.deepspeed.rst b/docs/source/fastNLP.core.drivers.torch_driver.deepspeed.rst new file mode 100644 index 00000000..2944ffec --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.core.drivers.torch_driver.fairscale.rst b/docs/source/fastNLP.core.drivers.torch_driver.fairscale.rst new file mode 100644 index 00000000..e68972a7 --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.core.drivers.torch_driver.torch_fsdp.rst b/docs/source/fastNLP.core.drivers.torch_driver.torch_fsdp.rst new file mode 100644 index 00000000..a799b7fc --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.core.metrics.backend.oneflow_backend.backend.rst b/docs/source/fastNLP.core.metrics.backend.oneflow_backend.backend.rst new file mode 100644 index 00000000..2389250b --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.core.metrics.backend.oneflow_backend.rst b/docs/source/fastNLP.core.metrics.backend.oneflow_backend.rst new file mode 100644 index 00000000..cb9e9653 --- /dev/null +++ b/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 diff --git a/docs/source/fastNLP.core.utils.oneflow_utils.rst b/docs/source/fastNLP.core.utils.oneflow_utils.rst new file mode 100644 index 00000000..f9d11510 --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.core.utils.seq_len_to_mask.rst b/docs/source/fastNLP.core.utils.seq_len_to_mask.rst new file mode 100644 index 00000000..55188a65 --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.core.utils.tqdm_progress.rst b/docs/source/fastNLP.core.utils.tqdm_progress.rst new file mode 100644 index 00000000..cfcdc655 --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.embeddings.rst b/docs/source/fastNLP.embeddings.rst new file mode 100644 index 00000000..1b220f59 --- /dev/null +++ b/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 diff --git a/docs/source/fastNLP.embeddings.torch.char_embedding.rst b/docs/source/fastNLP.embeddings.torch.char_embedding.rst new file mode 100644 index 00000000..f0d1dad7 --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.embeddings.torch.embedding.rst b/docs/source/fastNLP.embeddings.torch.embedding.rst new file mode 100644 index 00000000..1804a70e --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.embeddings.torch.rst b/docs/source/fastNLP.embeddings.torch.rst new file mode 100644 index 00000000..6294e8a2 --- /dev/null +++ b/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 diff --git a/docs/source/fastNLP.embeddings.torch.stack_embedding.rst b/docs/source/fastNLP.embeddings.torch.stack_embedding.rst new file mode 100644 index 00000000..dab50088 --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.embeddings.torch.static_embedding.rst b/docs/source/fastNLP.embeddings.torch.static_embedding.rst new file mode 100644 index 00000000..fc1a2bb9 --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.embeddings.torch.utils.rst b/docs/source/fastNLP.embeddings.torch.utils.rst new file mode 100644 index 00000000..9d1fc5b5 --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.models.rst b/docs/source/fastNLP.models.rst new file mode 100644 index 00000000..eaef5a5e --- /dev/null +++ b/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 diff --git a/docs/source/fastNLP.models.torch.biaffine_parser.rst b/docs/source/fastNLP.models.torch.biaffine_parser.rst new file mode 100644 index 00000000..c75d7079 --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.models.torch.cnn_text_classification.rst b/docs/source/fastNLP.models.torch.cnn_text_classification.rst new file mode 100644 index 00000000..a0b4e1bd --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.models.torch.rst b/docs/source/fastNLP.models.torch.rst new file mode 100644 index 00000000..7196f3f7 --- /dev/null +++ b/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 diff --git a/docs/source/fastNLP.models.torch.seq2seq_generator.rst b/docs/source/fastNLP.models.torch.seq2seq_generator.rst new file mode 100644 index 00000000..bc1e4ca0 --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.models.torch.seq2seq_model.rst b/docs/source/fastNLP.models.torch.seq2seq_model.rst new file mode 100644 index 00000000..802b8793 --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.models.torch.sequence_labeling.rst b/docs/source/fastNLP.models.torch.sequence_labeling.rst new file mode 100644 index 00000000..af834f53 --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.modules.torch.attention.rst b/docs/source/fastNLP.modules.torch.attention.rst new file mode 100644 index 00000000..52b7bf8c --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.modules.torch.decoder.crf.rst b/docs/source/fastNLP.modules.torch.decoder.crf.rst new file mode 100644 index 00000000..2d9e3460 --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.modules.torch.decoder.mlp.rst b/docs/source/fastNLP.modules.torch.decoder.mlp.rst new file mode 100644 index 00000000..6bb9cc5c --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.modules.torch.decoder.rst b/docs/source/fastNLP.modules.torch.decoder.rst new file mode 100644 index 00000000..999ab01d --- /dev/null +++ b/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 diff --git a/docs/source/fastNLP.modules.torch.decoder.seq2seq_decoder.rst b/docs/source/fastNLP.modules.torch.decoder.seq2seq_decoder.rst new file mode 100644 index 00000000..43c77fea --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.modules.torch.decoder.seq2seq_state.rst b/docs/source/fastNLP.modules.torch.decoder.seq2seq_state.rst new file mode 100644 index 00000000..05f730e4 --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.modules.torch.dropout.rst b/docs/source/fastNLP.modules.torch.dropout.rst new file mode 100644 index 00000000..8e4b591b --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.modules.torch.encoder.conv_maxpool.rst b/docs/source/fastNLP.modules.torch.encoder.conv_maxpool.rst new file mode 100644 index 00000000..438ec076 --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.modules.torch.encoder.lstm.rst b/docs/source/fastNLP.modules.torch.encoder.lstm.rst new file mode 100644 index 00000000..918e13cb --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.modules.torch.encoder.rst b/docs/source/fastNLP.modules.torch.encoder.rst new file mode 100644 index 00000000..14120ed1 --- /dev/null +++ b/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 diff --git a/docs/source/fastNLP.modules.torch.encoder.seq2seq_encoder.rst b/docs/source/fastNLP.modules.torch.encoder.seq2seq_encoder.rst new file mode 100644 index 00000000..152fc091 --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.modules.torch.encoder.star_transformer.rst b/docs/source/fastNLP.modules.torch.encoder.star_transformer.rst new file mode 100644 index 00000000..3257cf13 --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.modules.torch.encoder.transformer.rst b/docs/source/fastNLP.modules.torch.encoder.transformer.rst new file mode 100644 index 00000000..0a3c893f --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.modules.torch.encoder.variational_rnn.rst b/docs/source/fastNLP.modules.torch.encoder.variational_rnn.rst new file mode 100644 index 00000000..71a70c3a --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.modules.torch.generator.rst b/docs/source/fastNLP.modules.torch.generator.rst new file mode 100644 index 00000000..783db61d --- /dev/null +++ b/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 diff --git a/docs/source/fastNLP.modules.torch.generator.seq2seq_generator.rst b/docs/source/fastNLP.modules.torch.generator.seq2seq_generator.rst new file mode 100644 index 00000000..4abc102f --- /dev/null +++ b/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: diff --git a/docs/source/fastNLP.modules.torch.rst b/docs/source/fastNLP.modules.torch.rst new file mode 100644 index 00000000..8e1fb0f5 --- /dev/null +++ b/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 diff --git a/docs/source/fastNLP.transformers.rst b/docs/source/fastNLP.transformers.rst new file mode 100644 index 00000000..c681acca --- /dev/null +++ b/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 diff --git a/docs/source/fastNLP.transformers.torch.rst b/docs/source/fastNLP.transformers.torch.rst new file mode 100644 index 00000000..ab6ef210 --- /dev/null +++ b/docs/source/fastNLP.transformers.torch.rst @@ -0,0 +1,7 @@ +fastNLP.transformers.torch package +======================= + +.. automodule:: fastNLP.transformers.torch + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/index.rst b/docs/source/index.rst index 10b0d74c..abe73d8a 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -2,18 +2,18 @@ fastNLP 中文文档 ===================== -用户手册 +快速上手 ---------------- .. toctree:: - :maxdepth: 1 + :maxdepth: 2 - 语法样例 + tutorials API 文档 ------------- -除了用户手册之外，你还可以通过查阅 API 文档来找到你所需要的工具。 +您可以通过查阅 API 文档来找到你所需要的工具。 .. toctree:: :titlesonly: diff --git a/docs/source/tutorials.rst b/docs/source/tutorials.rst new file mode 100644 index 00000000..bc32d10f --- /dev/null +++ b/docs/source/tutorials.rst @@ -0,0 +1,8 @@ +fastNLP 教程系列 +================ + +.. toctree:: + :maxdepth: 1 + :glob: + + tutorials/*