From b13c086750f26cd577cd5f3e9a4e6b0ec2a23b6b Mon Sep 17 00:00:00 2001 From: x54-729 <17307130121@fudan.edu.cn> Date: Sat, 7 May 2022 15:48:58 +0000 Subject: [PATCH] =?UTF-8?q?=E6=96=87=E6=A1=A3=E7=9A=84=E5=88=9D=E6=AD=A5?= =?UTF-8?q?=E8=AE=BE=E7=BD=AE?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/Makefile | 38 ++++ docs/source/conf.py | 181 ++++++++++++++++++ .../fastNLP.core.callbacks.callback.rst | 7 + .../fastNLP.core.callbacks.callback_event.rst | 7 + ...astNLP.core.callbacks.callback_manager.rst | 7 + ...NLP.core.callbacks.checkpoint_callback.rst | 7 + ...NLP.core.callbacks.early_stop_callback.rst | 7 + ...LP.core.callbacks.has_monitor_callback.rst | 7 + ...ore.callbacks.load_best_model_callback.rst | 7 + ...P.core.callbacks.lr_scheduler_callback.rst | 7 + ....core.callbacks.more_evaluate_callback.rst | 7 + ...stNLP.core.callbacks.progress_callback.rst | 7 + docs/source/fastNLP.core.callbacks.rst | 34 ++++ .../fastNLP.core.callbacks.topk_saver.rst | 7 + ...fastNLP.core.callbacks.torch_callbacks.rst | 16 ++ ...rch_callbacks.torch_grad_clip_callback.rst | 7 + ...orch_callbacks.torch_lr_sched_callback.rst | 7 + docs/source/fastNLP.core.callbacks.utils.rst | 7 + .../fastNLP.core.collators.collator.rst | 7 + ...fastNLP.core.collators.packer_unpacker.rst | 7 + ...tNLP.core.collators.padders.exceptions.rst | 7 + ...tNLP.core.collators.padders.get_padder.rst | 7 + ...P.core.collators.padders.jittor_padder.rst | 7 + ...LP.core.collators.padders.numpy_padder.rst | 7 + .../fastNLP.core.collators.padders.padder.rst | 7 + ...P.core.collators.padders.paddle_padder.rst | 7 + ...tNLP.core.collators.padders.raw_padder.rst | 7 + .../source/fastNLP.core.collators.padders.rst | 24 +++ ...LP.core.collators.padders.torch_padder.rst | 7 + ...NLP.core.collators.padders.torch_utils.rst | 7 + .../fastNLP.core.collators.padders.utils.rst | 7 + docs/source/fastNLP.core.collators.rst | 24 +++ .../fastNLP.core.controllers.evaluator.rst | 7 + ....controllers.loops.evaluate_batch_loop.rst | 7 + .../fastNLP.core.controllers.loops.loop.rst | 7 + .../source/fastNLP.core.controllers.loops.rst | 17 ++ ...ore.controllers.loops.train_batch_loop.rst | 7 + docs/source/fastNLP.core.controllers.rst | 25 +++ .../fastNLP.core.controllers.trainer.rst | 7 + .../source/fastNLP.core.controllers.utils.rst | 16 ++ .../fastNLP.core.controllers.utils.state.rst | 7 + .../fastNLP.core.controllers.utils.utils.rst | 7 + ...core.dataloaders.jittor_dataloader.fdl.rst | 7 + ...NLP.core.dataloaders.jittor_dataloader.rst | 15 ++ ...astNLP.core.dataloaders.mix_dataloader.rst | 7 + ...core.dataloaders.paddle_dataloader.fdl.rst | 7 + ...NLP.core.dataloaders.paddle_dataloader.rst | 15 ++ docs/source/fastNLP.core.dataloaders.rst | 26 +++ ....core.dataloaders.torch_dataloader.fdl.rst | 7 + ...tNLP.core.dataloaders.torch_dataloader.rst | 15 ++ .../source/fastNLP.core.dataloaders.utils.rst | 7 + docs/source/fastNLP.core.dataset.dataset.rst | 7 + docs/source/fastNLP.core.dataset.field.rst | 7 + docs/source/fastNLP.core.dataset.instance.rst | 7 + docs/source/fastNLP.core.dataset.rst | 17 ++ .../fastNLP.core.drivers.choose_driver.rst | 7 + docs/source/fastNLP.core.drivers.driver.rst | 7 + ...jittor_driver.initialize_jittor_driver.rst | 7 + ...re.drivers.jittor_driver.jittor_driver.rst | 7 + ...fastNLP.core.drivers.jittor_driver.mpi.rst | 7 + .../fastNLP.core.drivers.jittor_driver.rst | 19 ++ ...re.drivers.jittor_driver.single_device.rst | 7 + ...stNLP.core.drivers.jittor_driver.utils.rst | 7 + ....core.drivers.paddle_driver.dist_utils.rst | 7 + ...stNLP.core.drivers.paddle_driver.fleet.rst | 7 + ...e.drivers.paddle_driver.fleet_launcher.rst | 7 + ...paddle_driver.initialize_paddle_driver.rst | 7 + ...re.drivers.paddle_driver.paddle_driver.rst | 7 + .../fastNLP.core.drivers.paddle_driver.rst | 21 ++ ...re.drivers.paddle_driver.single_device.rst | 7 + ...stNLP.core.drivers.paddle_driver.utils.rst | 7 + docs/source/fastNLP.core.drivers.rst | 27 +++ .../fastNLP.core.drivers.torch_driver.ddp.rst | 7 + ...P.core.drivers.torch_driver.dist_utils.rst | 7 + ...drivers.torch_driver.fairscale_sharded.rst | 7 + ...s.torch_driver.initialize_torch_driver.rst | 7 + .../fastNLP.core.drivers.torch_driver.rst | 21 ++ ...ore.drivers.torch_driver.single_device.rst | 7 + ...core.drivers.torch_driver.torch_driver.rst | 7 + ...astNLP.core.drivers.torch_driver.utils.rst | 7 + docs/source/fastNLP.core.drivers.utils.rst | 7 + docs/source/fastNLP.core.log.handler.rst | 7 + docs/source/fastNLP.core.log.highlighter.rst | 7 + docs/source/fastNLP.core.log.logger.rst | 7 + docs/source/fastNLP.core.log.print.rst | 7 + docs/source/fastNLP.core.log.rst | 18 ++ docs/source/fastNLP.core.metrics.accuracy.rst | 7 + ...tNLP.core.metrics.backend.auto_backend.rst | 7 + .../fastNLP.core.metrics.backend.backend.rst | 7 + ...metrics.backend.jittor_backend.backend.rst | 7 + ...LP.core.metrics.backend.jittor_backend.rst | 15 ++ ...metrics.backend.paddle_backend.backend.rst | 7 + ...LP.core.metrics.backend.paddle_backend.rst | 15 ++ docs/source/fastNLP.core.metrics.backend.rst | 26 +++ ....metrics.backend.torch_backend.backend.rst | 7 + ...NLP.core.metrics.backend.torch_backend.rst | 15 ++ ...ore.metrics.classify_f1_pre_rec_metric.rst | 7 + docs/source/fastNLP.core.metrics.element.rst | 7 + docs/source/fastNLP.core.metrics.metric.rst | 7 + docs/source/fastNLP.core.metrics.rst | 28 +++ ...LP.core.metrics.span_f1_pre_rec_metric.rst | 7 + docs/source/fastNLP.core.metrics.utils.rst | 7 + docs/source/fastNLP.core.rst | 32 ++++ ...fastNLP.core.samplers.conversion_utils.rst | 7 + .../fastNLP.core.samplers.mix_sampler.rst | 7 + ...re.samplers.reproducible_batch_sampler.rst | 7 + ...NLP.core.samplers.reproducible_sampler.rst | 7 + docs/source/fastNLP.core.samplers.rst | 20 ++ ...stNLP.core.samplers.unrepeated_sampler.rst | 7 + docs/source/fastNLP.core.samplers.utils.rst | 7 + .../fastNLP.core.utils.cache_results.rst | 7 + .../source/fastNLP.core.utils.dummy_class.rst | 7 + docs/source/fastNLP.core.utils.exceptions.rst | 7 + .../fastNLP.core.utils.jittor_utils.rst | 7 + .../fastNLP.core.utils.paddle_utils.rst | 7 + .../fastNLP.core.utils.rich_progress.rst | 7 + docs/source/fastNLP.core.utils.rst | 22 +++ .../source/fastNLP.core.utils.torch_utils.rst | 7 + docs/source/fastNLP.core.utils.utils.rst | 7 + docs/source/fastNLP.core.vocabulary.rst | 7 + docs/source/fastNLP.envs.distributed.rst | 7 + docs/source/fastNLP.envs.env.rst | 7 + docs/source/fastNLP.envs.imports.rst | 7 + docs/source/fastNLP.envs.rst | 20 ++ docs/source/fastNLP.envs.set_backend.rst | 7 + .../source/fastNLP.envs.set_env_on_import.rst | 7 + docs/source/fastNLP.envs.utils.rst | 7 + docs/source/fastNLP.io.data_bundle.rst | 7 + docs/source/fastNLP.io.embed_loader.rst | 7 + docs/source/fastNLP.io.file_reader.rst | 7 + docs/source/fastNLP.io.file_utils.rst | 7 + .../fastNLP.io.loader.classification.rst | 7 + docs/source/fastNLP.io.loader.conll.rst | 7 + docs/source/fastNLP.io.loader.coreference.rst | 7 + docs/source/fastNLP.io.loader.csv.rst | 7 + docs/source/fastNLP.io.loader.cws.rst | 7 + docs/source/fastNLP.io.loader.json.rst | 7 + docs/source/fastNLP.io.loader.loader.rst | 7 + docs/source/fastNLP.io.loader.matching.rst | 7 + docs/source/fastNLP.io.loader.qa.rst | 7 + docs/source/fastNLP.io.loader.rst | 24 +++ .../fastNLP.io.loader.summarization.rst | 7 + docs/source/fastNLP.io.model_io.rst | 7 + .../source/fastNLP.io.pipe.classification.rst | 7 + docs/source/fastNLP.io.pipe.conll.rst | 7 + .../fastNLP.io.pipe.construct_graph.rst | 7 + docs/source/fastNLP.io.pipe.coreference.rst | 7 + docs/source/fastNLP.io.pipe.cws.rst | 7 + docs/source/fastNLP.io.pipe.matching.rst | 7 + docs/source/fastNLP.io.pipe.pipe.rst | 7 + docs/source/fastNLP.io.pipe.qa.rst | 7 + docs/source/fastNLP.io.pipe.rst | 24 +++ docs/source/fastNLP.io.pipe.summarization.rst | 7 + docs/source/fastNLP.io.pipe.utils.rst | 7 + docs/source/fastNLP.io.rst | 29 +++ docs/source/fastNLP.io.utils.rst | 7 + docs/source/fastNLP.rst | 17 ++ docs/source/figures/procedures.PNG | Bin 0 -> 14083 bytes docs/source/index.rst | 30 +++ docs/source/modules.rst | 7 + docs/source/user/example.rst | 162 ++++++++++++++++ docs/transfer.ipynb | 101 ++++++++++ 162 files changed, 2031 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/source/conf.py create mode 100644 docs/source/fastNLP.core.callbacks.callback.rst create mode 100644 docs/source/fastNLP.core.callbacks.callback_event.rst create mode 100644 docs/source/fastNLP.core.callbacks.callback_manager.rst create mode 100644 docs/source/fastNLP.core.callbacks.checkpoint_callback.rst create mode 100644 docs/source/fastNLP.core.callbacks.early_stop_callback.rst create mode 100644 docs/source/fastNLP.core.callbacks.has_monitor_callback.rst create mode 100644 docs/source/fastNLP.core.callbacks.load_best_model_callback.rst create mode 100644 docs/source/fastNLP.core.callbacks.lr_scheduler_callback.rst create mode 100644 docs/source/fastNLP.core.callbacks.more_evaluate_callback.rst create mode 100644 docs/source/fastNLP.core.callbacks.progress_callback.rst create mode 100644 docs/source/fastNLP.core.callbacks.rst create mode 100644 docs/source/fastNLP.core.callbacks.topk_saver.rst create mode 100644 docs/source/fastNLP.core.callbacks.torch_callbacks.rst create mode 100644 docs/source/fastNLP.core.callbacks.torch_callbacks.torch_grad_clip_callback.rst create mode 100644 docs/source/fastNLP.core.callbacks.torch_callbacks.torch_lr_sched_callback.rst create mode 100644 docs/source/fastNLP.core.callbacks.utils.rst create mode 100644 docs/source/fastNLP.core.collators.collator.rst create mode 100644 docs/source/fastNLP.core.collators.packer_unpacker.rst create mode 100644 docs/source/fastNLP.core.collators.padders.exceptions.rst create mode 100644 docs/source/fastNLP.core.collators.padders.get_padder.rst create mode 100644 docs/source/fastNLP.core.collators.padders.jittor_padder.rst create mode 100644 docs/source/fastNLP.core.collators.padders.numpy_padder.rst create mode 100644 docs/source/fastNLP.core.collators.padders.padder.rst create mode 100644 docs/source/fastNLP.core.collators.padders.paddle_padder.rst create mode 100644 docs/source/fastNLP.core.collators.padders.raw_padder.rst create mode 100644 docs/source/fastNLP.core.collators.padders.rst create mode 100644 docs/source/fastNLP.core.collators.padders.torch_padder.rst create mode 100644 docs/source/fastNLP.core.collators.padders.torch_utils.rst create mode 100644 docs/source/fastNLP.core.collators.padders.utils.rst create mode 100644 docs/source/fastNLP.core.collators.rst create mode 100644 docs/source/fastNLP.core.controllers.evaluator.rst create mode 100644 docs/source/fastNLP.core.controllers.loops.evaluate_batch_loop.rst create mode 100644 docs/source/fastNLP.core.controllers.loops.loop.rst create mode 100644 docs/source/fastNLP.core.controllers.loops.rst create mode 100644 docs/source/fastNLP.core.controllers.loops.train_batch_loop.rst create mode 100644 docs/source/fastNLP.core.controllers.rst create mode 100644 docs/source/fastNLP.core.controllers.trainer.rst create mode 100644 docs/source/fastNLP.core.controllers.utils.rst create mode 100644 docs/source/fastNLP.core.controllers.utils.state.rst create mode 100644 docs/source/fastNLP.core.controllers.utils.utils.rst create mode 100644 docs/source/fastNLP.core.dataloaders.jittor_dataloader.fdl.rst create mode 100644 docs/source/fastNLP.core.dataloaders.jittor_dataloader.rst create mode 100644 docs/source/fastNLP.core.dataloaders.mix_dataloader.rst create mode 100644 docs/source/fastNLP.core.dataloaders.paddle_dataloader.fdl.rst create mode 100644 docs/source/fastNLP.core.dataloaders.paddle_dataloader.rst create mode 100644 docs/source/fastNLP.core.dataloaders.rst create mode 100644 docs/source/fastNLP.core.dataloaders.torch_dataloader.fdl.rst create mode 100644 docs/source/fastNLP.core.dataloaders.torch_dataloader.rst create mode 100644 docs/source/fastNLP.core.dataloaders.utils.rst create mode 100644 docs/source/fastNLP.core.dataset.dataset.rst create mode 100644 docs/source/fastNLP.core.dataset.field.rst create mode 100644 docs/source/fastNLP.core.dataset.instance.rst create mode 100644 docs/source/fastNLP.core.dataset.rst create mode 100644 docs/source/fastNLP.core.drivers.choose_driver.rst create mode 100644 docs/source/fastNLP.core.drivers.driver.rst create mode 100644 docs/source/fastNLP.core.drivers.jittor_driver.initialize_jittor_driver.rst create mode 100644 docs/source/fastNLP.core.drivers.jittor_driver.jittor_driver.rst create mode 100644 docs/source/fastNLP.core.drivers.jittor_driver.mpi.rst create mode 100644 docs/source/fastNLP.core.drivers.jittor_driver.rst create mode 100644 docs/source/fastNLP.core.drivers.jittor_driver.single_device.rst create mode 100644 docs/source/fastNLP.core.drivers.jittor_driver.utils.rst create mode 100644 docs/source/fastNLP.core.drivers.paddle_driver.dist_utils.rst create mode 100644 docs/source/fastNLP.core.drivers.paddle_driver.fleet.rst create mode 100644 docs/source/fastNLP.core.drivers.paddle_driver.fleet_launcher.rst create mode 100644 docs/source/fastNLP.core.drivers.paddle_driver.initialize_paddle_driver.rst create mode 100644 docs/source/fastNLP.core.drivers.paddle_driver.paddle_driver.rst create mode 100644 docs/source/fastNLP.core.drivers.paddle_driver.rst create mode 100644 docs/source/fastNLP.core.drivers.paddle_driver.single_device.rst create mode 100644 docs/source/fastNLP.core.drivers.paddle_driver.utils.rst create mode 100644 docs/source/fastNLP.core.drivers.rst create mode 100644 docs/source/fastNLP.core.drivers.torch_driver.ddp.rst create mode 100644 docs/source/fastNLP.core.drivers.torch_driver.dist_utils.rst create mode 100644 docs/source/fastNLP.core.drivers.torch_driver.fairscale_sharded.rst create mode 100644 docs/source/fastNLP.core.drivers.torch_driver.initialize_torch_driver.rst create mode 100644 docs/source/fastNLP.core.drivers.torch_driver.rst create mode 100644 docs/source/fastNLP.core.drivers.torch_driver.single_device.rst create mode 100644 docs/source/fastNLP.core.drivers.torch_driver.torch_driver.rst create mode 100644 docs/source/fastNLP.core.drivers.torch_driver.utils.rst create mode 100644 docs/source/fastNLP.core.drivers.utils.rst create mode 100644 docs/source/fastNLP.core.log.handler.rst create mode 100644 docs/source/fastNLP.core.log.highlighter.rst create mode 100644 docs/source/fastNLP.core.log.logger.rst create mode 100644 docs/source/fastNLP.core.log.print.rst create mode 100644 docs/source/fastNLP.core.log.rst create mode 100644 docs/source/fastNLP.core.metrics.accuracy.rst create mode 100644 docs/source/fastNLP.core.metrics.backend.auto_backend.rst create mode 100644 docs/source/fastNLP.core.metrics.backend.backend.rst create mode 100644 docs/source/fastNLP.core.metrics.backend.jittor_backend.backend.rst create mode 100644 docs/source/fastNLP.core.metrics.backend.jittor_backend.rst create mode 100644 docs/source/fastNLP.core.metrics.backend.paddle_backend.backend.rst create mode 100644 docs/source/fastNLP.core.metrics.backend.paddle_backend.rst create mode 100644 docs/source/fastNLP.core.metrics.backend.rst create mode 100644 docs/source/fastNLP.core.metrics.backend.torch_backend.backend.rst create mode 100644 docs/source/fastNLP.core.metrics.backend.torch_backend.rst create mode 100644 docs/source/fastNLP.core.metrics.classify_f1_pre_rec_metric.rst create mode 100644 docs/source/fastNLP.core.metrics.element.rst create mode 100644 docs/source/fastNLP.core.metrics.metric.rst create mode 100644 docs/source/fastNLP.core.metrics.rst create mode 100644 docs/source/fastNLP.core.metrics.span_f1_pre_rec_metric.rst create mode 100644 docs/source/fastNLP.core.metrics.utils.rst create mode 100644 docs/source/fastNLP.core.rst create mode 100644 docs/source/fastNLP.core.samplers.conversion_utils.rst create mode 100644 docs/source/fastNLP.core.samplers.mix_sampler.rst create mode 100644 docs/source/fastNLP.core.samplers.reproducible_batch_sampler.rst create mode 100644 docs/source/fastNLP.core.samplers.reproducible_sampler.rst create mode 100644 docs/source/fastNLP.core.samplers.rst create mode 100644 docs/source/fastNLP.core.samplers.unrepeated_sampler.rst create mode 100644 docs/source/fastNLP.core.samplers.utils.rst create mode 100644 docs/source/fastNLP.core.utils.cache_results.rst create mode 100644 docs/source/fastNLP.core.utils.dummy_class.rst create mode 100644 docs/source/fastNLP.core.utils.exceptions.rst create mode 100644 docs/source/fastNLP.core.utils.jittor_utils.rst create mode 100644 docs/source/fastNLP.core.utils.paddle_utils.rst create mode 100644 docs/source/fastNLP.core.utils.rich_progress.rst create mode 100644 docs/source/fastNLP.core.utils.rst create mode 100644 docs/source/fastNLP.core.utils.torch_utils.rst create mode 100644 docs/source/fastNLP.core.utils.utils.rst create mode 100644 docs/source/fastNLP.core.vocabulary.rst create mode 100644 docs/source/fastNLP.envs.distributed.rst create mode 100644 docs/source/fastNLP.envs.env.rst create mode 100644 docs/source/fastNLP.envs.imports.rst create mode 100644 docs/source/fastNLP.envs.rst create mode 100644 docs/source/fastNLP.envs.set_backend.rst create mode 100644 docs/source/fastNLP.envs.set_env_on_import.rst create mode 100644 docs/source/fastNLP.envs.utils.rst create mode 100644 docs/source/fastNLP.io.data_bundle.rst create mode 100644 docs/source/fastNLP.io.embed_loader.rst create mode 100644 docs/source/fastNLP.io.file_reader.rst create mode 100644 docs/source/fastNLP.io.file_utils.rst create mode 100644 docs/source/fastNLP.io.loader.classification.rst create mode 100644 docs/source/fastNLP.io.loader.conll.rst create mode 100644 docs/source/fastNLP.io.loader.coreference.rst create mode 100644 docs/source/fastNLP.io.loader.csv.rst create mode 100644 docs/source/fastNLP.io.loader.cws.rst create mode 100644 docs/source/fastNLP.io.loader.json.rst create mode 100644 docs/source/fastNLP.io.loader.loader.rst create mode 100644 docs/source/fastNLP.io.loader.matching.rst create mode 100644 docs/source/fastNLP.io.loader.qa.rst create mode 100644 docs/source/fastNLP.io.loader.rst create mode 100644 docs/source/fastNLP.io.loader.summarization.rst create mode 100644 docs/source/fastNLP.io.model_io.rst create mode 100644 docs/source/fastNLP.io.pipe.classification.rst create mode 100644 docs/source/fastNLP.io.pipe.conll.rst create mode 100644 docs/source/fastNLP.io.pipe.construct_graph.rst create mode 100644 docs/source/fastNLP.io.pipe.coreference.rst create mode 100644 docs/source/fastNLP.io.pipe.cws.rst create mode 100644 docs/source/fastNLP.io.pipe.matching.rst create mode 100644 docs/source/fastNLP.io.pipe.pipe.rst create mode 100644 docs/source/fastNLP.io.pipe.qa.rst create mode 100644 docs/source/fastNLP.io.pipe.rst create mode 100644 docs/source/fastNLP.io.pipe.summarization.rst create mode 100644 docs/source/fastNLP.io.pipe.utils.rst create mode 100644 docs/source/fastNLP.io.rst create mode 100644 docs/source/fastNLP.io.utils.rst create mode 100644 docs/source/fastNLP.rst create mode 100644 docs/source/figures/procedures.PNG create mode 100644 docs/source/index.rst create mode 100644 docs/source/modules.rst create mode 100644 docs/source/user/example.rst create mode 100644 docs/transfer.ipynb diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 00000000..a3710195 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,38 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXAPIDOC = sphinx-apidoc +SPHINXBUILD = sphinx-build +SPHINXPROJ = fastNLP +SPHINXEXCLUDE = ../fastNLP/transformers/* ../fastNLP/modules/* ../fastNLP/core/drivers/torch_paddle_driver/* ../fastNLP/core/utils/torch_paddle_utils.py +SOURCEDIR = source +BUILDDIR = build +PORT = 9000 + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) + +apidoc: + $(SPHINXAPIDOC) -efM -d 6 -o source ../$(SPHINXPROJ) $(SPHINXEXCLUDE) + +server: + cd build/html && python -m http.server $(PORT) + +delete: + rm -f source/$(SPHINXPROJ).* source/modules.rst && rm -rf build + +dev: + make delete && make apidoc && make html && make server + +prod: + make apidoc && make html + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 00000000..115448ed --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,181 @@ +# -*- coding: utf-8 -*- +# +# Configuration file for the Sphinx documentation builder. +# +# This file does only contain a selection of the most common options. For a +# full list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys + +sys.path.insert(0, os.path.abspath('../../')) + +# -- Project information ----------------------------------------------------- + +project = 'fastNLP' +copyright = '2022, fastNLP' +author = 'fastNLP' + +# The short X.Y version +version = '0.8' +# The full version, including alpha/beta/rc tags +release = '0.8.0' + +# -- General configuration --------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.viewcode', + 'sphinx.ext.autosummary', + 'sphinx.ext.mathjax', + 'sphinx.ext.todo' +] + +autodoc_default_options = { + 'member-order': 'bysource', + 'special-members': '__init__', + 'undoc-members': False, +} + +add_module_names = False +autosummary_ignore_module_all = False +autodoc_typehints = "description" +autoclass_content = "class" + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] +# template_bridge +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = "zh_CN" + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path . +exclude_patterns = ['modules.rst'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +html_theme_options = { + 'collapse_navigation': False, + 'titles_only': True +} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# The default sidebars (for documents that don't match any pattern) are +# defined by theme itself. Builtin themes are using these templates by +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', +# 'searchbox.html']``. +# +# html_sidebars = {} + + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = 'fastNLP' + +# -- Options for LaTeX output ------------------------------------------------ + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [] + +# -- Options for manual page output ------------------------------------------ + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'fastNLP', 'fastNLP Documentation', + [author], 1) +] + +# -- Options for Texinfo output ---------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'fastNLP', 'fastNLP Documentation', + author, 'fastNLP', 'One line description of project.', + 'Miscellaneous'), +] + + +# -- Extension configuration ------------------------------------------------- +def maybe_skip_member(app, what, name, obj, skip, options): + # if obj.__doc__ is None: + # return True + if name == "__init__": + return False + if name.startswith("_"): + return True + return skip + + +def setup(app): + app.connect('autodoc-skip-member', maybe_skip_member) diff --git a/docs/source/fastNLP.core.callbacks.callback.rst b/docs/source/fastNLP.core.callbacks.callback.rst new file mode 100644 index 00000000..15a31183 --- /dev/null +++ b/docs/source/fastNLP.core.callbacks.callback.rst @@ -0,0 +1,7 @@ +fastNLP.core.callbacks.callback module +====================================== + +.. automodule:: fastNLP.core.callbacks.callback + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.callbacks.callback_event.rst b/docs/source/fastNLP.core.callbacks.callback_event.rst new file mode 100644 index 00000000..1945b597 --- /dev/null +++ b/docs/source/fastNLP.core.callbacks.callback_event.rst @@ -0,0 +1,7 @@ +fastNLP.core.callbacks.callback\_event module +============================================= + +.. automodule:: fastNLP.core.callbacks.callback_event + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.callbacks.callback_manager.rst b/docs/source/fastNLP.core.callbacks.callback_manager.rst new file mode 100644 index 00000000..3f22d46f --- /dev/null +++ b/docs/source/fastNLP.core.callbacks.callback_manager.rst @@ -0,0 +1,7 @@ +fastNLP.core.callbacks.callback\_manager module +=============================================== + +.. automodule:: fastNLP.core.callbacks.callback_manager + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.callbacks.checkpoint_callback.rst b/docs/source/fastNLP.core.callbacks.checkpoint_callback.rst new file mode 100644 index 00000000..297879df --- /dev/null +++ b/docs/source/fastNLP.core.callbacks.checkpoint_callback.rst @@ -0,0 +1,7 @@ +fastNLP.core.callbacks.checkpoint\_callback module +================================================== + +.. automodule:: fastNLP.core.callbacks.checkpoint_callback + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.callbacks.early_stop_callback.rst b/docs/source/fastNLP.core.callbacks.early_stop_callback.rst new file mode 100644 index 00000000..81356ed4 --- /dev/null +++ b/docs/source/fastNLP.core.callbacks.early_stop_callback.rst @@ -0,0 +1,7 @@ +fastNLP.core.callbacks.early\_stop\_callback module +=================================================== + +.. automodule:: fastNLP.core.callbacks.early_stop_callback + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.callbacks.has_monitor_callback.rst b/docs/source/fastNLP.core.callbacks.has_monitor_callback.rst new file mode 100644 index 00000000..c1c6f93c --- /dev/null +++ b/docs/source/fastNLP.core.callbacks.has_monitor_callback.rst @@ -0,0 +1,7 @@ +fastNLP.core.callbacks.has\_monitor\_callback module +==================================================== + +.. automodule:: fastNLP.core.callbacks.has_monitor_callback + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.callbacks.load_best_model_callback.rst b/docs/source/fastNLP.core.callbacks.load_best_model_callback.rst new file mode 100644 index 00000000..9d9b4b78 --- /dev/null +++ b/docs/source/fastNLP.core.callbacks.load_best_model_callback.rst @@ -0,0 +1,7 @@ +fastNLP.core.callbacks.load\_best\_model\_callback module +========================================================= + +.. automodule:: fastNLP.core.callbacks.load_best_model_callback + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.callbacks.lr_scheduler_callback.rst b/docs/source/fastNLP.core.callbacks.lr_scheduler_callback.rst new file mode 100644 index 00000000..30abe617 --- /dev/null +++ b/docs/source/fastNLP.core.callbacks.lr_scheduler_callback.rst @@ -0,0 +1,7 @@ +fastNLP.core.callbacks.lr\_scheduler\_callback module +===================================================== + +.. automodule:: fastNLP.core.callbacks.lr_scheduler_callback + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.callbacks.more_evaluate_callback.rst b/docs/source/fastNLP.core.callbacks.more_evaluate_callback.rst new file mode 100644 index 00000000..a44071e9 --- /dev/null +++ b/docs/source/fastNLP.core.callbacks.more_evaluate_callback.rst @@ -0,0 +1,7 @@ +fastNLP.core.callbacks.more\_evaluate\_callback module +====================================================== + +.. automodule:: fastNLP.core.callbacks.more_evaluate_callback + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.callbacks.progress_callback.rst b/docs/source/fastNLP.core.callbacks.progress_callback.rst new file mode 100644 index 00000000..b7cc7801 --- /dev/null +++ b/docs/source/fastNLP.core.callbacks.progress_callback.rst @@ -0,0 +1,7 @@ +fastNLP.core.callbacks.progress\_callback module +================================================ + +.. automodule:: fastNLP.core.callbacks.progress_callback + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.callbacks.rst b/docs/source/fastNLP.core.callbacks.rst new file mode 100644 index 00000000..a3450110 --- /dev/null +++ b/docs/source/fastNLP.core.callbacks.rst @@ -0,0 +1,34 @@ +fastNLP.core.callbacks package +============================== + +.. automodule:: fastNLP.core.callbacks + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.callbacks.torch_callbacks + +Submodules +---------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.callbacks.callback + fastNLP.core.callbacks.callback_event + fastNLP.core.callbacks.callback_manager + fastNLP.core.callbacks.checkpoint_callback + fastNLP.core.callbacks.early_stop_callback + fastNLP.core.callbacks.has_monitor_callback + fastNLP.core.callbacks.load_best_model_callback + fastNLP.core.callbacks.lr_scheduler_callback + fastNLP.core.callbacks.more_evaluate_callback + fastNLP.core.callbacks.progress_callback + fastNLP.core.callbacks.topk_saver + fastNLP.core.callbacks.utils diff --git a/docs/source/fastNLP.core.callbacks.topk_saver.rst b/docs/source/fastNLP.core.callbacks.topk_saver.rst new file mode 100644 index 00000000..20a311ef --- /dev/null +++ b/docs/source/fastNLP.core.callbacks.topk_saver.rst @@ -0,0 +1,7 @@ +fastNLP.core.callbacks.topk\_saver module +========================================= + +.. automodule:: fastNLP.core.callbacks.topk_saver + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.callbacks.torch_callbacks.rst b/docs/source/fastNLP.core.callbacks.torch_callbacks.rst new file mode 100644 index 00000000..193f46d3 --- /dev/null +++ b/docs/source/fastNLP.core.callbacks.torch_callbacks.rst @@ -0,0 +1,16 @@ +fastNLP.core.callbacks.torch\_callbacks package +=============================================== + +.. automodule:: fastNLP.core.callbacks.torch_callbacks + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.callbacks.torch_callbacks.torch_grad_clip_callback + fastNLP.core.callbacks.torch_callbacks.torch_lr_sched_callback diff --git a/docs/source/fastNLP.core.callbacks.torch_callbacks.torch_grad_clip_callback.rst b/docs/source/fastNLP.core.callbacks.torch_callbacks.torch_grad_clip_callback.rst new file mode 100644 index 00000000..a4ef03b4 --- /dev/null +++ b/docs/source/fastNLP.core.callbacks.torch_callbacks.torch_grad_clip_callback.rst @@ -0,0 +1,7 @@ +fastNLP.core.callbacks.torch\_callbacks.torch\_grad\_clip\_callback module +========================================================================== + +.. automodule:: fastNLP.core.callbacks.torch_callbacks.torch_grad_clip_callback + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.callbacks.torch_callbacks.torch_lr_sched_callback.rst b/docs/source/fastNLP.core.callbacks.torch_callbacks.torch_lr_sched_callback.rst new file mode 100644 index 00000000..72c3e2bf --- /dev/null +++ b/docs/source/fastNLP.core.callbacks.torch_callbacks.torch_lr_sched_callback.rst @@ -0,0 +1,7 @@ +fastNLP.core.callbacks.torch\_callbacks.torch\_lr\_sched\_callback module +========================================================================= + +.. automodule:: fastNLP.core.callbacks.torch_callbacks.torch_lr_sched_callback + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.callbacks.utils.rst b/docs/source/fastNLP.core.callbacks.utils.rst new file mode 100644 index 00000000..09e23a1e --- /dev/null +++ b/docs/source/fastNLP.core.callbacks.utils.rst @@ -0,0 +1,7 @@ +fastNLP.core.callbacks.utils module +=================================== + +.. automodule:: fastNLP.core.callbacks.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.collators.collator.rst b/docs/source/fastNLP.core.collators.collator.rst new file mode 100644 index 00000000..f620fd8b --- /dev/null +++ b/docs/source/fastNLP.core.collators.collator.rst @@ -0,0 +1,7 @@ +fastNLP.core.collators.collator module +====================================== + +.. automodule:: fastNLP.core.collators.collator + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.collators.packer_unpacker.rst b/docs/source/fastNLP.core.collators.packer_unpacker.rst new file mode 100644 index 00000000..9a207d07 --- /dev/null +++ b/docs/source/fastNLP.core.collators.packer_unpacker.rst @@ -0,0 +1,7 @@ +fastNLP.core.collators.packer\_unpacker module +============================================== + +.. automodule:: fastNLP.core.collators.packer_unpacker + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.collators.padders.exceptions.rst b/docs/source/fastNLP.core.collators.padders.exceptions.rst new file mode 100644 index 00000000..c2822970 --- /dev/null +++ b/docs/source/fastNLP.core.collators.padders.exceptions.rst @@ -0,0 +1,7 @@ +fastNLP.core.collators.padders.exceptions module +================================================ + +.. automodule:: fastNLP.core.collators.padders.exceptions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.collators.padders.get_padder.rst b/docs/source/fastNLP.core.collators.padders.get_padder.rst new file mode 100644 index 00000000..5ae56bef --- /dev/null +++ b/docs/source/fastNLP.core.collators.padders.get_padder.rst @@ -0,0 +1,7 @@ +fastNLP.core.collators.padders.get\_padder module +================================================= + +.. automodule:: fastNLP.core.collators.padders.get_padder + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.collators.padders.jittor_padder.rst b/docs/source/fastNLP.core.collators.padders.jittor_padder.rst new file mode 100644 index 00000000..7e908090 --- /dev/null +++ b/docs/source/fastNLP.core.collators.padders.jittor_padder.rst @@ -0,0 +1,7 @@ +fastNLP.core.collators.padders.jittor\_padder module +==================================================== + +.. automodule:: fastNLP.core.collators.padders.jittor_padder + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.collators.padders.numpy_padder.rst b/docs/source/fastNLP.core.collators.padders.numpy_padder.rst new file mode 100644 index 00000000..506473ea --- /dev/null +++ b/docs/source/fastNLP.core.collators.padders.numpy_padder.rst @@ -0,0 +1,7 @@ +fastNLP.core.collators.padders.numpy\_padder module +=================================================== + +.. automodule:: fastNLP.core.collators.padders.numpy_padder + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.collators.padders.padder.rst b/docs/source/fastNLP.core.collators.padders.padder.rst new file mode 100644 index 00000000..f56b6556 --- /dev/null +++ b/docs/source/fastNLP.core.collators.padders.padder.rst @@ -0,0 +1,7 @@ +fastNLP.core.collators.padders.padder module +============================================ + +.. automodule:: fastNLP.core.collators.padders.padder + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.collators.padders.paddle_padder.rst b/docs/source/fastNLP.core.collators.padders.paddle_padder.rst new file mode 100644 index 00000000..93aac85a --- /dev/null +++ b/docs/source/fastNLP.core.collators.padders.paddle_padder.rst @@ -0,0 +1,7 @@ +fastNLP.core.collators.padders.paddle\_padder module +==================================================== + +.. automodule:: fastNLP.core.collators.padders.paddle_padder + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.collators.padders.raw_padder.rst b/docs/source/fastNLP.core.collators.padders.raw_padder.rst new file mode 100644 index 00000000..e8505480 --- /dev/null +++ b/docs/source/fastNLP.core.collators.padders.raw_padder.rst @@ -0,0 +1,7 @@ +fastNLP.core.collators.padders.raw\_padder module +================================================= + +.. automodule:: fastNLP.core.collators.padders.raw_padder + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.collators.padders.rst b/docs/source/fastNLP.core.collators.padders.rst new file mode 100644 index 00000000..0ee61a26 --- /dev/null +++ b/docs/source/fastNLP.core.collators.padders.rst @@ -0,0 +1,24 @@ +fastNLP.core.collators.padders package +====================================== + +.. automodule:: fastNLP.core.collators.padders + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.collators.padders.exceptions + fastNLP.core.collators.padders.get_padder + fastNLP.core.collators.padders.jittor_padder + fastNLP.core.collators.padders.numpy_padder + fastNLP.core.collators.padders.padder + fastNLP.core.collators.padders.paddle_padder + fastNLP.core.collators.padders.raw_padder + fastNLP.core.collators.padders.torch_padder + fastNLP.core.collators.padders.torch_utils + fastNLP.core.collators.padders.utils diff --git a/docs/source/fastNLP.core.collators.padders.torch_padder.rst b/docs/source/fastNLP.core.collators.padders.torch_padder.rst new file mode 100644 index 00000000..a3dfd1a3 --- /dev/null +++ b/docs/source/fastNLP.core.collators.padders.torch_padder.rst @@ -0,0 +1,7 @@ +fastNLP.core.collators.padders.torch\_padder module +=================================================== + +.. automodule:: fastNLP.core.collators.padders.torch_padder + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.collators.padders.torch_utils.rst b/docs/source/fastNLP.core.collators.padders.torch_utils.rst new file mode 100644 index 00000000..ac972b89 --- /dev/null +++ b/docs/source/fastNLP.core.collators.padders.torch_utils.rst @@ -0,0 +1,7 @@ +fastNLP.core.collators.padders.torch\_utils module +================================================== + +.. automodule:: fastNLP.core.collators.padders.torch_utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.collators.padders.utils.rst b/docs/source/fastNLP.core.collators.padders.utils.rst new file mode 100644 index 00000000..e71e2dfc --- /dev/null +++ b/docs/source/fastNLP.core.collators.padders.utils.rst @@ -0,0 +1,7 @@ +fastNLP.core.collators.padders.utils module +=========================================== + +.. automodule:: fastNLP.core.collators.padders.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.collators.rst b/docs/source/fastNLP.core.collators.rst new file mode 100644 index 00000000..1210e8b3 --- /dev/null +++ b/docs/source/fastNLP.core.collators.rst @@ -0,0 +1,24 @@ +fastNLP.core.collators package +============================== + +.. automodule:: fastNLP.core.collators + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.collators.padders + +Submodules +---------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.collators.collator + fastNLP.core.collators.packer_unpacker diff --git a/docs/source/fastNLP.core.controllers.evaluator.rst b/docs/source/fastNLP.core.controllers.evaluator.rst new file mode 100644 index 00000000..d1b2aec3 --- /dev/null +++ b/docs/source/fastNLP.core.controllers.evaluator.rst @@ -0,0 +1,7 @@ +fastNLP.core.controllers.evaluator module +========================================= + +.. automodule:: fastNLP.core.controllers.evaluator + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.controllers.loops.evaluate_batch_loop.rst b/docs/source/fastNLP.core.controllers.loops.evaluate_batch_loop.rst new file mode 100644 index 00000000..a015313d --- /dev/null +++ b/docs/source/fastNLP.core.controllers.loops.evaluate_batch_loop.rst @@ -0,0 +1,7 @@ +fastNLP.core.controllers.loops.evaluate\_batch\_loop module +=========================================================== + +.. automodule:: fastNLP.core.controllers.loops.evaluate_batch_loop + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.controllers.loops.loop.rst b/docs/source/fastNLP.core.controllers.loops.loop.rst new file mode 100644 index 00000000..25351fe3 --- /dev/null +++ b/docs/source/fastNLP.core.controllers.loops.loop.rst @@ -0,0 +1,7 @@ +fastNLP.core.controllers.loops.loop module +========================================== + +.. automodule:: fastNLP.core.controllers.loops.loop + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.controllers.loops.rst b/docs/source/fastNLP.core.controllers.loops.rst new file mode 100644 index 00000000..8db384f7 --- /dev/null +++ b/docs/source/fastNLP.core.controllers.loops.rst @@ -0,0 +1,17 @@ +fastNLP.core.controllers.loops package +====================================== + +.. automodule:: fastNLP.core.controllers.loops + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.controllers.loops.evaluate_batch_loop + fastNLP.core.controllers.loops.loop + fastNLP.core.controllers.loops.train_batch_loop diff --git a/docs/source/fastNLP.core.controllers.loops.train_batch_loop.rst b/docs/source/fastNLP.core.controllers.loops.train_batch_loop.rst new file mode 100644 index 00000000..8b04da05 --- /dev/null +++ b/docs/source/fastNLP.core.controllers.loops.train_batch_loop.rst @@ -0,0 +1,7 @@ +fastNLP.core.controllers.loops.train\_batch\_loop module +======================================================== + +.. automodule:: fastNLP.core.controllers.loops.train_batch_loop + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.controllers.rst b/docs/source/fastNLP.core.controllers.rst new file mode 100644 index 00000000..daef5f3b --- /dev/null +++ b/docs/source/fastNLP.core.controllers.rst @@ -0,0 +1,25 @@ +fastNLP.core.controllers package +================================ + +.. automodule:: fastNLP.core.controllers + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.controllers.loops + fastNLP.core.controllers.utils + +Submodules +---------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.controllers.evaluator + fastNLP.core.controllers.trainer diff --git a/docs/source/fastNLP.core.controllers.trainer.rst b/docs/source/fastNLP.core.controllers.trainer.rst new file mode 100644 index 00000000..209a3a43 --- /dev/null +++ b/docs/source/fastNLP.core.controllers.trainer.rst @@ -0,0 +1,7 @@ +fastNLP.core.controllers.trainer module +======================================= + +.. automodule:: fastNLP.core.controllers.trainer + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.controllers.utils.rst b/docs/source/fastNLP.core.controllers.utils.rst new file mode 100644 index 00000000..ca8a7307 --- /dev/null +++ b/docs/source/fastNLP.core.controllers.utils.rst @@ -0,0 +1,16 @@ +fastNLP.core.controllers.utils package +====================================== + +.. automodule:: fastNLP.core.controllers.utils + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.controllers.utils.state + fastNLP.core.controllers.utils.utils diff --git a/docs/source/fastNLP.core.controllers.utils.state.rst b/docs/source/fastNLP.core.controllers.utils.state.rst new file mode 100644 index 00000000..5adcd921 --- /dev/null +++ b/docs/source/fastNLP.core.controllers.utils.state.rst @@ -0,0 +1,7 @@ +fastNLP.core.controllers.utils.state module +=========================================== + +.. automodule:: fastNLP.core.controllers.utils.state + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.controllers.utils.utils.rst b/docs/source/fastNLP.core.controllers.utils.utils.rst new file mode 100644 index 00000000..ba864ab0 --- /dev/null +++ b/docs/source/fastNLP.core.controllers.utils.utils.rst @@ -0,0 +1,7 @@ +fastNLP.core.controllers.utils.utils module +=========================================== + +.. automodule:: fastNLP.core.controllers.utils.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.dataloaders.jittor_dataloader.fdl.rst b/docs/source/fastNLP.core.dataloaders.jittor_dataloader.fdl.rst new file mode 100644 index 00000000..08df6096 --- /dev/null +++ b/docs/source/fastNLP.core.dataloaders.jittor_dataloader.fdl.rst @@ -0,0 +1,7 @@ +fastNLP.core.dataloaders.jittor\_dataloader.fdl module +====================================================== + +.. automodule:: fastNLP.core.dataloaders.jittor_dataloader.fdl + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.dataloaders.jittor_dataloader.rst b/docs/source/fastNLP.core.dataloaders.jittor_dataloader.rst new file mode 100644 index 00000000..d7a7a8dc --- /dev/null +++ b/docs/source/fastNLP.core.dataloaders.jittor_dataloader.rst @@ -0,0 +1,15 @@ +fastNLP.core.dataloaders.jittor\_dataloader package +=================================================== + +.. automodule:: fastNLP.core.dataloaders.jittor_dataloader + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.dataloaders.jittor_dataloader.fdl diff --git a/docs/source/fastNLP.core.dataloaders.mix_dataloader.rst b/docs/source/fastNLP.core.dataloaders.mix_dataloader.rst new file mode 100644 index 00000000..d2ffa234 --- /dev/null +++ b/docs/source/fastNLP.core.dataloaders.mix_dataloader.rst @@ -0,0 +1,7 @@ +fastNLP.core.dataloaders.mix\_dataloader module +=============================================== + +.. automodule:: fastNLP.core.dataloaders.mix_dataloader + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.dataloaders.paddle_dataloader.fdl.rst b/docs/source/fastNLP.core.dataloaders.paddle_dataloader.fdl.rst new file mode 100644 index 00000000..5b40bec0 --- /dev/null +++ b/docs/source/fastNLP.core.dataloaders.paddle_dataloader.fdl.rst @@ -0,0 +1,7 @@ +fastNLP.core.dataloaders.paddle\_dataloader.fdl module +====================================================== + +.. automodule:: fastNLP.core.dataloaders.paddle_dataloader.fdl + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.dataloaders.paddle_dataloader.rst b/docs/source/fastNLP.core.dataloaders.paddle_dataloader.rst new file mode 100644 index 00000000..428a339e --- /dev/null +++ b/docs/source/fastNLP.core.dataloaders.paddle_dataloader.rst @@ -0,0 +1,15 @@ +fastNLP.core.dataloaders.paddle\_dataloader package +=================================================== + +.. automodule:: fastNLP.core.dataloaders.paddle_dataloader + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.dataloaders.paddle_dataloader.fdl diff --git a/docs/source/fastNLP.core.dataloaders.rst b/docs/source/fastNLP.core.dataloaders.rst new file mode 100644 index 00000000..a9bd51fa --- /dev/null +++ b/docs/source/fastNLP.core.dataloaders.rst @@ -0,0 +1,26 @@ +fastNLP.core.dataloaders package +================================ + +.. automodule:: fastNLP.core.dataloaders + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.dataloaders.jittor_dataloader + fastNLP.core.dataloaders.paddle_dataloader + fastNLP.core.dataloaders.torch_dataloader + +Submodules +---------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.dataloaders.mix_dataloader + fastNLP.core.dataloaders.utils diff --git a/docs/source/fastNLP.core.dataloaders.torch_dataloader.fdl.rst b/docs/source/fastNLP.core.dataloaders.torch_dataloader.fdl.rst new file mode 100644 index 00000000..33db5bf9 --- /dev/null +++ b/docs/source/fastNLP.core.dataloaders.torch_dataloader.fdl.rst @@ -0,0 +1,7 @@ +fastNLP.core.dataloaders.torch\_dataloader.fdl module +===================================================== + +.. automodule:: fastNLP.core.dataloaders.torch_dataloader.fdl + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.dataloaders.torch_dataloader.rst b/docs/source/fastNLP.core.dataloaders.torch_dataloader.rst new file mode 100644 index 00000000..f631571e --- /dev/null +++ b/docs/source/fastNLP.core.dataloaders.torch_dataloader.rst @@ -0,0 +1,15 @@ +fastNLP.core.dataloaders.torch\_dataloader package +================================================== + +.. automodule:: fastNLP.core.dataloaders.torch_dataloader + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.dataloaders.torch_dataloader.fdl diff --git a/docs/source/fastNLP.core.dataloaders.utils.rst b/docs/source/fastNLP.core.dataloaders.utils.rst new file mode 100644 index 00000000..0b28dfe1 --- /dev/null +++ b/docs/source/fastNLP.core.dataloaders.utils.rst @@ -0,0 +1,7 @@ +fastNLP.core.dataloaders.utils module +===================================== + +.. automodule:: fastNLP.core.dataloaders.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.dataset.dataset.rst b/docs/source/fastNLP.core.dataset.dataset.rst new file mode 100644 index 00000000..7bae1726 --- /dev/null +++ b/docs/source/fastNLP.core.dataset.dataset.rst @@ -0,0 +1,7 @@ +fastNLP.core.dataset.dataset module +=================================== + +.. automodule:: fastNLP.core.dataset.dataset + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.dataset.field.rst b/docs/source/fastNLP.core.dataset.field.rst new file mode 100644 index 00000000..6d85fd71 --- /dev/null +++ b/docs/source/fastNLP.core.dataset.field.rst @@ -0,0 +1,7 @@ +fastNLP.core.dataset.field module +================================= + +.. automodule:: fastNLP.core.dataset.field + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.dataset.instance.rst b/docs/source/fastNLP.core.dataset.instance.rst new file mode 100644 index 00000000..f3382a9d --- /dev/null +++ b/docs/source/fastNLP.core.dataset.instance.rst @@ -0,0 +1,7 @@ +fastNLP.core.dataset.instance module +==================================== + +.. automodule:: fastNLP.core.dataset.instance + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.dataset.rst b/docs/source/fastNLP.core.dataset.rst new file mode 100644 index 00000000..e3ceff77 --- /dev/null +++ b/docs/source/fastNLP.core.dataset.rst @@ -0,0 +1,17 @@ +fastNLP.core.dataset package +============================ + +.. automodule:: fastNLP.core.dataset + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.dataset.dataset + fastNLP.core.dataset.field + fastNLP.core.dataset.instance diff --git a/docs/source/fastNLP.core.drivers.choose_driver.rst b/docs/source/fastNLP.core.drivers.choose_driver.rst new file mode 100644 index 00000000..68912754 --- /dev/null +++ b/docs/source/fastNLP.core.drivers.choose_driver.rst @@ -0,0 +1,7 @@ +fastNLP.core.drivers.choose\_driver module +========================================== + +.. automodule:: fastNLP.core.drivers.choose_driver + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.drivers.driver.rst b/docs/source/fastNLP.core.drivers.driver.rst new file mode 100644 index 00000000..c5b6be38 --- /dev/null +++ b/docs/source/fastNLP.core.drivers.driver.rst @@ -0,0 +1,7 @@ +fastNLP.core.drivers.driver module +================================== + +.. automodule:: fastNLP.core.drivers.driver + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.drivers.jittor_driver.initialize_jittor_driver.rst b/docs/source/fastNLP.core.drivers.jittor_driver.initialize_jittor_driver.rst new file mode 100644 index 00000000..56057f75 --- /dev/null +++ b/docs/source/fastNLP.core.drivers.jittor_driver.initialize_jittor_driver.rst @@ -0,0 +1,7 @@ +fastNLP.core.drivers.jittor\_driver.initialize\_jittor\_driver module +===================================================================== + +.. automodule:: fastNLP.core.drivers.jittor_driver.initialize_jittor_driver + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.drivers.jittor_driver.jittor_driver.rst b/docs/source/fastNLP.core.drivers.jittor_driver.jittor_driver.rst new file mode 100644 index 00000000..c68f8bf5 --- /dev/null +++ b/docs/source/fastNLP.core.drivers.jittor_driver.jittor_driver.rst @@ -0,0 +1,7 @@ +fastNLP.core.drivers.jittor\_driver.jittor\_driver module +========================================================= + +.. automodule:: fastNLP.core.drivers.jittor_driver.jittor_driver + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.drivers.jittor_driver.mpi.rst b/docs/source/fastNLP.core.drivers.jittor_driver.mpi.rst new file mode 100644 index 00000000..7bcb2fd5 --- /dev/null +++ b/docs/source/fastNLP.core.drivers.jittor_driver.mpi.rst @@ -0,0 +1,7 @@ +fastNLP.core.drivers.jittor\_driver.mpi module +============================================== + +.. automodule:: fastNLP.core.drivers.jittor_driver.mpi + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.drivers.jittor_driver.rst b/docs/source/fastNLP.core.drivers.jittor_driver.rst new file mode 100644 index 00000000..df32665b --- /dev/null +++ b/docs/source/fastNLP.core.drivers.jittor_driver.rst @@ -0,0 +1,19 @@ +fastNLP.core.drivers.jittor\_driver package +=========================================== + +.. automodule:: fastNLP.core.drivers.jittor_driver + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.drivers.jittor_driver.initialize_jittor_driver + fastNLP.core.drivers.jittor_driver.jittor_driver + fastNLP.core.drivers.jittor_driver.mpi + fastNLP.core.drivers.jittor_driver.single_device + fastNLP.core.drivers.jittor_driver.utils diff --git a/docs/source/fastNLP.core.drivers.jittor_driver.single_device.rst b/docs/source/fastNLP.core.drivers.jittor_driver.single_device.rst new file mode 100644 index 00000000..d9dcd051 --- /dev/null +++ b/docs/source/fastNLP.core.drivers.jittor_driver.single_device.rst @@ -0,0 +1,7 @@ +fastNLP.core.drivers.jittor\_driver.single\_device module +========================================================= + +.. automodule:: fastNLP.core.drivers.jittor_driver.single_device + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.drivers.jittor_driver.utils.rst b/docs/source/fastNLP.core.drivers.jittor_driver.utils.rst new file mode 100644 index 00000000..92a75e85 --- /dev/null +++ b/docs/source/fastNLP.core.drivers.jittor_driver.utils.rst @@ -0,0 +1,7 @@ +fastNLP.core.drivers.jittor\_driver.utils module +================================================ + +.. automodule:: fastNLP.core.drivers.jittor_driver.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.drivers.paddle_driver.dist_utils.rst b/docs/source/fastNLP.core.drivers.paddle_driver.dist_utils.rst new file mode 100644 index 00000000..c7314d32 --- /dev/null +++ b/docs/source/fastNLP.core.drivers.paddle_driver.dist_utils.rst @@ -0,0 +1,7 @@ +fastNLP.core.drivers.paddle\_driver.dist\_utils module +====================================================== + +.. automodule:: fastNLP.core.drivers.paddle_driver.dist_utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.drivers.paddle_driver.fleet.rst b/docs/source/fastNLP.core.drivers.paddle_driver.fleet.rst new file mode 100644 index 00000000..ba6c34d4 --- /dev/null +++ b/docs/source/fastNLP.core.drivers.paddle_driver.fleet.rst @@ -0,0 +1,7 @@ +fastNLP.core.drivers.paddle\_driver.fleet module +================================================ + +.. automodule:: fastNLP.core.drivers.paddle_driver.fleet + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.drivers.paddle_driver.fleet_launcher.rst b/docs/source/fastNLP.core.drivers.paddle_driver.fleet_launcher.rst new file mode 100644 index 00000000..f20d29fa --- /dev/null +++ b/docs/source/fastNLP.core.drivers.paddle_driver.fleet_launcher.rst @@ -0,0 +1,7 @@ +fastNLP.core.drivers.paddle\_driver.fleet\_launcher module +========================================================== + +.. automodule:: fastNLP.core.drivers.paddle_driver.fleet_launcher + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.drivers.paddle_driver.initialize_paddle_driver.rst b/docs/source/fastNLP.core.drivers.paddle_driver.initialize_paddle_driver.rst new file mode 100644 index 00000000..248b6cb6 --- /dev/null +++ b/docs/source/fastNLP.core.drivers.paddle_driver.initialize_paddle_driver.rst @@ -0,0 +1,7 @@ +fastNLP.core.drivers.paddle\_driver.initialize\_paddle\_driver module +===================================================================== + +.. automodule:: fastNLP.core.drivers.paddle_driver.initialize_paddle_driver + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.drivers.paddle_driver.paddle_driver.rst b/docs/source/fastNLP.core.drivers.paddle_driver.paddle_driver.rst new file mode 100644 index 00000000..16603bb1 --- /dev/null +++ b/docs/source/fastNLP.core.drivers.paddle_driver.paddle_driver.rst @@ -0,0 +1,7 @@ +fastNLP.core.drivers.paddle\_driver.paddle\_driver module +========================================================= + +.. automodule:: fastNLP.core.drivers.paddle_driver.paddle_driver + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.drivers.paddle_driver.rst b/docs/source/fastNLP.core.drivers.paddle_driver.rst new file mode 100644 index 00000000..91038646 --- /dev/null +++ b/docs/source/fastNLP.core.drivers.paddle_driver.rst @@ -0,0 +1,21 @@ +fastNLP.core.drivers.paddle\_driver package +=========================================== + +.. automodule:: fastNLP.core.drivers.paddle_driver + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.drivers.paddle_driver.dist_utils + fastNLP.core.drivers.paddle_driver.fleet + fastNLP.core.drivers.paddle_driver.fleet_launcher + fastNLP.core.drivers.paddle_driver.initialize_paddle_driver + fastNLP.core.drivers.paddle_driver.paddle_driver + fastNLP.core.drivers.paddle_driver.single_device + fastNLP.core.drivers.paddle_driver.utils diff --git a/docs/source/fastNLP.core.drivers.paddle_driver.single_device.rst b/docs/source/fastNLP.core.drivers.paddle_driver.single_device.rst new file mode 100644 index 00000000..b87c836d --- /dev/null +++ b/docs/source/fastNLP.core.drivers.paddle_driver.single_device.rst @@ -0,0 +1,7 @@ +fastNLP.core.drivers.paddle\_driver.single\_device module +========================================================= + +.. automodule:: fastNLP.core.drivers.paddle_driver.single_device + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.drivers.paddle_driver.utils.rst b/docs/source/fastNLP.core.drivers.paddle_driver.utils.rst new file mode 100644 index 00000000..8b9bd501 --- /dev/null +++ b/docs/source/fastNLP.core.drivers.paddle_driver.utils.rst @@ -0,0 +1,7 @@ +fastNLP.core.drivers.paddle\_driver.utils module +================================================ + +.. automodule:: fastNLP.core.drivers.paddle_driver.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.drivers.rst b/docs/source/fastNLP.core.drivers.rst new file mode 100644 index 00000000..3ac36f71 --- /dev/null +++ b/docs/source/fastNLP.core.drivers.rst @@ -0,0 +1,27 @@ +fastNLP.core.drivers package +============================ + +.. automodule:: fastNLP.core.drivers + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.drivers.jittor_driver + fastNLP.core.drivers.paddle_driver + fastNLP.core.drivers.torch_driver + +Submodules +---------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.drivers.choose_driver + fastNLP.core.drivers.driver + fastNLP.core.drivers.utils diff --git a/docs/source/fastNLP.core.drivers.torch_driver.ddp.rst b/docs/source/fastNLP.core.drivers.torch_driver.ddp.rst new file mode 100644 index 00000000..4d6cafff --- /dev/null +++ b/docs/source/fastNLP.core.drivers.torch_driver.ddp.rst @@ -0,0 +1,7 @@ +fastNLP.core.drivers.torch\_driver.ddp module +============================================= + +.. automodule:: fastNLP.core.drivers.torch_driver.ddp + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.drivers.torch_driver.dist_utils.rst b/docs/source/fastNLP.core.drivers.torch_driver.dist_utils.rst new file mode 100644 index 00000000..30ba5381 --- /dev/null +++ b/docs/source/fastNLP.core.drivers.torch_driver.dist_utils.rst @@ -0,0 +1,7 @@ +fastNLP.core.drivers.torch\_driver.dist\_utils module +===================================================== + +.. automodule:: fastNLP.core.drivers.torch_driver.dist_utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.drivers.torch_driver.fairscale_sharded.rst b/docs/source/fastNLP.core.drivers.torch_driver.fairscale_sharded.rst new file mode 100644 index 00000000..765ac4ae --- /dev/null +++ b/docs/source/fastNLP.core.drivers.torch_driver.fairscale_sharded.rst @@ -0,0 +1,7 @@ +fastNLP.core.drivers.torch\_driver.fairscale\_sharded module +============================================================ + +.. automodule:: fastNLP.core.drivers.torch_driver.fairscale_sharded + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.drivers.torch_driver.initialize_torch_driver.rst b/docs/source/fastNLP.core.drivers.torch_driver.initialize_torch_driver.rst new file mode 100644 index 00000000..989050ac --- /dev/null +++ b/docs/source/fastNLP.core.drivers.torch_driver.initialize_torch_driver.rst @@ -0,0 +1,7 @@ +fastNLP.core.drivers.torch\_driver.initialize\_torch\_driver module +=================================================================== + +.. automodule:: fastNLP.core.drivers.torch_driver.initialize_torch_driver + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.drivers.torch_driver.rst b/docs/source/fastNLP.core.drivers.torch_driver.rst new file mode 100644 index 00000000..65f4ca1a --- /dev/null +++ b/docs/source/fastNLP.core.drivers.torch_driver.rst @@ -0,0 +1,21 @@ +fastNLP.core.drivers.torch\_driver package +========================================== + +.. automodule:: fastNLP.core.drivers.torch_driver + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.drivers.torch_driver.ddp + fastNLP.core.drivers.torch_driver.dist_utils + fastNLP.core.drivers.torch_driver.fairscale_sharded + fastNLP.core.drivers.torch_driver.initialize_torch_driver + fastNLP.core.drivers.torch_driver.single_device + fastNLP.core.drivers.torch_driver.torch_driver + fastNLP.core.drivers.torch_driver.utils diff --git a/docs/source/fastNLP.core.drivers.torch_driver.single_device.rst b/docs/source/fastNLP.core.drivers.torch_driver.single_device.rst new file mode 100644 index 00000000..c8f8a2d9 --- /dev/null +++ b/docs/source/fastNLP.core.drivers.torch_driver.single_device.rst @@ -0,0 +1,7 @@ +fastNLP.core.drivers.torch\_driver.single\_device module +======================================================== + +.. automodule:: fastNLP.core.drivers.torch_driver.single_device + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.drivers.torch_driver.torch_driver.rst b/docs/source/fastNLP.core.drivers.torch_driver.torch_driver.rst new file mode 100644 index 00000000..da58a329 --- /dev/null +++ b/docs/source/fastNLP.core.drivers.torch_driver.torch_driver.rst @@ -0,0 +1,7 @@ +fastNLP.core.drivers.torch\_driver.torch\_driver module +======================================================= + +.. automodule:: fastNLP.core.drivers.torch_driver.torch_driver + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.drivers.torch_driver.utils.rst b/docs/source/fastNLP.core.drivers.torch_driver.utils.rst new file mode 100644 index 00000000..2481377d --- /dev/null +++ b/docs/source/fastNLP.core.drivers.torch_driver.utils.rst @@ -0,0 +1,7 @@ +fastNLP.core.drivers.torch\_driver.utils module +=============================================== + +.. automodule:: fastNLP.core.drivers.torch_driver.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.drivers.utils.rst b/docs/source/fastNLP.core.drivers.utils.rst new file mode 100644 index 00000000..7acb2588 --- /dev/null +++ b/docs/source/fastNLP.core.drivers.utils.rst @@ -0,0 +1,7 @@ +fastNLP.core.drivers.utils module +================================= + +.. automodule:: fastNLP.core.drivers.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.log.handler.rst b/docs/source/fastNLP.core.log.handler.rst new file mode 100644 index 00000000..1e124987 --- /dev/null +++ b/docs/source/fastNLP.core.log.handler.rst @@ -0,0 +1,7 @@ +fastNLP.core.log.handler module +=============================== + +.. automodule:: fastNLP.core.log.handler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.log.highlighter.rst b/docs/source/fastNLP.core.log.highlighter.rst new file mode 100644 index 00000000..e62336d4 --- /dev/null +++ b/docs/source/fastNLP.core.log.highlighter.rst @@ -0,0 +1,7 @@ +fastNLP.core.log.highlighter module +=================================== + +.. automodule:: fastNLP.core.log.highlighter + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.log.logger.rst b/docs/source/fastNLP.core.log.logger.rst new file mode 100644 index 00000000..caf78c02 --- /dev/null +++ b/docs/source/fastNLP.core.log.logger.rst @@ -0,0 +1,7 @@ +fastNLP.core.log.logger module +============================== + +.. automodule:: fastNLP.core.log.logger + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.log.print.rst b/docs/source/fastNLP.core.log.print.rst new file mode 100644 index 00000000..700ac5b1 --- /dev/null +++ b/docs/source/fastNLP.core.log.print.rst @@ -0,0 +1,7 @@ +fastNLP.core.log.print module +============================= + +.. automodule:: fastNLP.core.log.print + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.log.rst b/docs/source/fastNLP.core.log.rst new file mode 100644 index 00000000..e52f9eb7 --- /dev/null +++ b/docs/source/fastNLP.core.log.rst @@ -0,0 +1,18 @@ +fastNLP.core.log package +======================== + +.. automodule:: fastNLP.core.log + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.log.handler + fastNLP.core.log.highlighter + fastNLP.core.log.logger + fastNLP.core.log.print diff --git a/docs/source/fastNLP.core.metrics.accuracy.rst b/docs/source/fastNLP.core.metrics.accuracy.rst new file mode 100644 index 00000000..76d7bfa5 --- /dev/null +++ b/docs/source/fastNLP.core.metrics.accuracy.rst @@ -0,0 +1,7 @@ +fastNLP.core.metrics.accuracy module +==================================== + +.. automodule:: fastNLP.core.metrics.accuracy + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.metrics.backend.auto_backend.rst b/docs/source/fastNLP.core.metrics.backend.auto_backend.rst new file mode 100644 index 00000000..9275a5e7 --- /dev/null +++ b/docs/source/fastNLP.core.metrics.backend.auto_backend.rst @@ -0,0 +1,7 @@ +fastNLP.core.metrics.backend.auto\_backend module +================================================= + +.. automodule:: fastNLP.core.metrics.backend.auto_backend + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.metrics.backend.backend.rst b/docs/source/fastNLP.core.metrics.backend.backend.rst new file mode 100644 index 00000000..df29d243 --- /dev/null +++ b/docs/source/fastNLP.core.metrics.backend.backend.rst @@ -0,0 +1,7 @@ +fastNLP.core.metrics.backend.backend module +=========================================== + +.. automodule:: fastNLP.core.metrics.backend.backend + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.metrics.backend.jittor_backend.backend.rst b/docs/source/fastNLP.core.metrics.backend.jittor_backend.backend.rst new file mode 100644 index 00000000..d5ad28e5 --- /dev/null +++ b/docs/source/fastNLP.core.metrics.backend.jittor_backend.backend.rst @@ -0,0 +1,7 @@ +fastNLP.core.metrics.backend.jittor\_backend.backend module +=========================================================== + +.. automodule:: fastNLP.core.metrics.backend.jittor_backend.backend + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.metrics.backend.jittor_backend.rst b/docs/source/fastNLP.core.metrics.backend.jittor_backend.rst new file mode 100644 index 00000000..9b76aee3 --- /dev/null +++ b/docs/source/fastNLP.core.metrics.backend.jittor_backend.rst @@ -0,0 +1,15 @@ +fastNLP.core.metrics.backend.jittor\_backend package +==================================================== + +.. automodule:: fastNLP.core.metrics.backend.jittor_backend + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.metrics.backend.jittor_backend.backend diff --git a/docs/source/fastNLP.core.metrics.backend.paddle_backend.backend.rst b/docs/source/fastNLP.core.metrics.backend.paddle_backend.backend.rst new file mode 100644 index 00000000..fa0aef4d --- /dev/null +++ b/docs/source/fastNLP.core.metrics.backend.paddle_backend.backend.rst @@ -0,0 +1,7 @@ +fastNLP.core.metrics.backend.paddle\_backend.backend module +=========================================================== + +.. automodule:: fastNLP.core.metrics.backend.paddle_backend.backend + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.metrics.backend.paddle_backend.rst b/docs/source/fastNLP.core.metrics.backend.paddle_backend.rst new file mode 100644 index 00000000..fb4ec69d --- /dev/null +++ b/docs/source/fastNLP.core.metrics.backend.paddle_backend.rst @@ -0,0 +1,15 @@ +fastNLP.core.metrics.backend.paddle\_backend package +==================================================== + +.. automodule:: fastNLP.core.metrics.backend.paddle_backend + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.metrics.backend.paddle_backend.backend diff --git a/docs/source/fastNLP.core.metrics.backend.rst b/docs/source/fastNLP.core.metrics.backend.rst new file mode 100644 index 00000000..52ca7958 --- /dev/null +++ b/docs/source/fastNLP.core.metrics.backend.rst @@ -0,0 +1,26 @@ +fastNLP.core.metrics.backend package +==================================== + +.. automodule:: fastNLP.core.metrics.backend + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.metrics.backend.jittor_backend + fastNLP.core.metrics.backend.paddle_backend + fastNLP.core.metrics.backend.torch_backend + +Submodules +---------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.metrics.backend.auto_backend + fastNLP.core.metrics.backend.backend diff --git a/docs/source/fastNLP.core.metrics.backend.torch_backend.backend.rst b/docs/source/fastNLP.core.metrics.backend.torch_backend.backend.rst new file mode 100644 index 00000000..b7ecd71f --- /dev/null +++ b/docs/source/fastNLP.core.metrics.backend.torch_backend.backend.rst @@ -0,0 +1,7 @@ +fastNLP.core.metrics.backend.torch\_backend.backend module +========================================================== + +.. automodule:: fastNLP.core.metrics.backend.torch_backend.backend + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.metrics.backend.torch_backend.rst b/docs/source/fastNLP.core.metrics.backend.torch_backend.rst new file mode 100644 index 00000000..07beae73 --- /dev/null +++ b/docs/source/fastNLP.core.metrics.backend.torch_backend.rst @@ -0,0 +1,15 @@ +fastNLP.core.metrics.backend.torch\_backend package +=================================================== + +.. automodule:: fastNLP.core.metrics.backend.torch_backend + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.metrics.backend.torch_backend.backend diff --git a/docs/source/fastNLP.core.metrics.classify_f1_pre_rec_metric.rst b/docs/source/fastNLP.core.metrics.classify_f1_pre_rec_metric.rst new file mode 100644 index 00000000..e0af9e1b --- /dev/null +++ b/docs/source/fastNLP.core.metrics.classify_f1_pre_rec_metric.rst @@ -0,0 +1,7 @@ +fastNLP.core.metrics.classify\_f1\_pre\_rec\_metric module +========================================================== + +.. automodule:: fastNLP.core.metrics.classify_f1_pre_rec_metric + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.metrics.element.rst b/docs/source/fastNLP.core.metrics.element.rst new file mode 100644 index 00000000..880fb405 --- /dev/null +++ b/docs/source/fastNLP.core.metrics.element.rst @@ -0,0 +1,7 @@ +fastNLP.core.metrics.element module +=================================== + +.. automodule:: fastNLP.core.metrics.element + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.metrics.metric.rst b/docs/source/fastNLP.core.metrics.metric.rst new file mode 100644 index 00000000..607fb232 --- /dev/null +++ b/docs/source/fastNLP.core.metrics.metric.rst @@ -0,0 +1,7 @@ +fastNLP.core.metrics.metric module +================================== + +.. automodule:: fastNLP.core.metrics.metric + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.metrics.rst b/docs/source/fastNLP.core.metrics.rst new file mode 100644 index 00000000..e2770769 --- /dev/null +++ b/docs/source/fastNLP.core.metrics.rst @@ -0,0 +1,28 @@ +fastNLP.core.metrics package +============================ + +.. automodule:: fastNLP.core.metrics + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.metrics.backend + +Submodules +---------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.metrics.accuracy + fastNLP.core.metrics.classify_f1_pre_rec_metric + fastNLP.core.metrics.element + fastNLP.core.metrics.metric + fastNLP.core.metrics.span_f1_pre_rec_metric + fastNLP.core.metrics.utils diff --git a/docs/source/fastNLP.core.metrics.span_f1_pre_rec_metric.rst b/docs/source/fastNLP.core.metrics.span_f1_pre_rec_metric.rst new file mode 100644 index 00000000..915507ea --- /dev/null +++ b/docs/source/fastNLP.core.metrics.span_f1_pre_rec_metric.rst @@ -0,0 +1,7 @@ +fastNLP.core.metrics.span\_f1\_pre\_rec\_metric module +====================================================== + +.. automodule:: fastNLP.core.metrics.span_f1_pre_rec_metric + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.metrics.utils.rst b/docs/source/fastNLP.core.metrics.utils.rst new file mode 100644 index 00000000..8d78e07b --- /dev/null +++ b/docs/source/fastNLP.core.metrics.utils.rst @@ -0,0 +1,7 @@ +fastNLP.core.metrics.utils module +================================= + +.. automodule:: fastNLP.core.metrics.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.rst b/docs/source/fastNLP.core.rst new file mode 100644 index 00000000..d71ffaf3 --- /dev/null +++ b/docs/source/fastNLP.core.rst @@ -0,0 +1,32 @@ +fastNLP.core package +==================== + +.. automodule:: fastNLP.core + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.callbacks + fastNLP.core.collators + fastNLP.core.controllers + fastNLP.core.dataloaders + fastNLP.core.dataset + fastNLP.core.drivers + fastNLP.core.log + fastNLP.core.metrics + fastNLP.core.samplers + fastNLP.core.utils + +Submodules +---------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.vocabulary diff --git a/docs/source/fastNLP.core.samplers.conversion_utils.rst b/docs/source/fastNLP.core.samplers.conversion_utils.rst new file mode 100644 index 00000000..855207cc --- /dev/null +++ b/docs/source/fastNLP.core.samplers.conversion_utils.rst @@ -0,0 +1,7 @@ +fastNLP.core.samplers.conversion\_utils module +============================================== + +.. automodule:: fastNLP.core.samplers.conversion_utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.samplers.mix_sampler.rst b/docs/source/fastNLP.core.samplers.mix_sampler.rst new file mode 100644 index 00000000..9a33cfdb --- /dev/null +++ b/docs/source/fastNLP.core.samplers.mix_sampler.rst @@ -0,0 +1,7 @@ +fastNLP.core.samplers.mix\_sampler module +========================================= + +.. automodule:: fastNLP.core.samplers.mix_sampler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.samplers.reproducible_batch_sampler.rst b/docs/source/fastNLP.core.samplers.reproducible_batch_sampler.rst new file mode 100644 index 00000000..00411ec8 --- /dev/null +++ b/docs/source/fastNLP.core.samplers.reproducible_batch_sampler.rst @@ -0,0 +1,7 @@ +fastNLP.core.samplers.reproducible\_batch\_sampler module +========================================================= + +.. automodule:: fastNLP.core.samplers.reproducible_batch_sampler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.samplers.reproducible_sampler.rst b/docs/source/fastNLP.core.samplers.reproducible_sampler.rst new file mode 100644 index 00000000..e244e08e --- /dev/null +++ b/docs/source/fastNLP.core.samplers.reproducible_sampler.rst @@ -0,0 +1,7 @@ +fastNLP.core.samplers.reproducible\_sampler module +================================================== + +.. automodule:: fastNLP.core.samplers.reproducible_sampler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.samplers.rst b/docs/source/fastNLP.core.samplers.rst new file mode 100644 index 00000000..f1b7be4c --- /dev/null +++ b/docs/source/fastNLP.core.samplers.rst @@ -0,0 +1,20 @@ +fastNLP.core.samplers package +============================= + +.. automodule:: fastNLP.core.samplers + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.samplers.conversion_utils + fastNLP.core.samplers.mix_sampler + fastNLP.core.samplers.reproducible_batch_sampler + fastNLP.core.samplers.reproducible_sampler + fastNLP.core.samplers.unrepeated_sampler + fastNLP.core.samplers.utils diff --git a/docs/source/fastNLP.core.samplers.unrepeated_sampler.rst b/docs/source/fastNLP.core.samplers.unrepeated_sampler.rst new file mode 100644 index 00000000..c76ac5bc --- /dev/null +++ b/docs/source/fastNLP.core.samplers.unrepeated_sampler.rst @@ -0,0 +1,7 @@ +fastNLP.core.samplers.unrepeated\_sampler module +================================================ + +.. automodule:: fastNLP.core.samplers.unrepeated_sampler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.samplers.utils.rst b/docs/source/fastNLP.core.samplers.utils.rst new file mode 100644 index 00000000..4f36cf04 --- /dev/null +++ b/docs/source/fastNLP.core.samplers.utils.rst @@ -0,0 +1,7 @@ +fastNLP.core.samplers.utils module +================================== + +.. automodule:: fastNLP.core.samplers.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.utils.cache_results.rst b/docs/source/fastNLP.core.utils.cache_results.rst new file mode 100644 index 00000000..a23a56ee --- /dev/null +++ b/docs/source/fastNLP.core.utils.cache_results.rst @@ -0,0 +1,7 @@ +fastNLP.core.utils.cache\_results module +======================================== + +.. automodule:: fastNLP.core.utils.cache_results + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.utils.dummy_class.rst b/docs/source/fastNLP.core.utils.dummy_class.rst new file mode 100644 index 00000000..b4ba01cf --- /dev/null +++ b/docs/source/fastNLP.core.utils.dummy_class.rst @@ -0,0 +1,7 @@ +fastNLP.core.utils.dummy\_class module +====================================== + +.. automodule:: fastNLP.core.utils.dummy_class + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.utils.exceptions.rst b/docs/source/fastNLP.core.utils.exceptions.rst new file mode 100644 index 00000000..a99dc4eb --- /dev/null +++ b/docs/source/fastNLP.core.utils.exceptions.rst @@ -0,0 +1,7 @@ +fastNLP.core.utils.exceptions module +==================================== + +.. automodule:: fastNLP.core.utils.exceptions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.utils.jittor_utils.rst b/docs/source/fastNLP.core.utils.jittor_utils.rst new file mode 100644 index 00000000..85241422 --- /dev/null +++ b/docs/source/fastNLP.core.utils.jittor_utils.rst @@ -0,0 +1,7 @@ +fastNLP.core.utils.jittor\_utils module +======================================= + +.. automodule:: fastNLP.core.utils.jittor_utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.utils.paddle_utils.rst b/docs/source/fastNLP.core.utils.paddle_utils.rst new file mode 100644 index 00000000..819dc3ca --- /dev/null +++ b/docs/source/fastNLP.core.utils.paddle_utils.rst @@ -0,0 +1,7 @@ +fastNLP.core.utils.paddle\_utils module +======================================= + +.. automodule:: fastNLP.core.utils.paddle_utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.utils.rich_progress.rst b/docs/source/fastNLP.core.utils.rich_progress.rst new file mode 100644 index 00000000..f4660381 --- /dev/null +++ b/docs/source/fastNLP.core.utils.rich_progress.rst @@ -0,0 +1,7 @@ +fastNLP.core.utils.rich\_progress module +======================================== + +.. automodule:: fastNLP.core.utils.rich_progress + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.utils.rst b/docs/source/fastNLP.core.utils.rst new file mode 100644 index 00000000..a63ed1db --- /dev/null +++ b/docs/source/fastNLP.core.utils.rst @@ -0,0 +1,22 @@ +fastNLP.core.utils package +========================== + +.. automodule:: fastNLP.core.utils + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core.utils.cache_results + fastNLP.core.utils.dummy_class + fastNLP.core.utils.exceptions + fastNLP.core.utils.jittor_utils + fastNLP.core.utils.paddle_utils + fastNLP.core.utils.rich_progress + fastNLP.core.utils.torch_utils + fastNLP.core.utils.utils diff --git a/docs/source/fastNLP.core.utils.torch_utils.rst b/docs/source/fastNLP.core.utils.torch_utils.rst new file mode 100644 index 00000000..f09e3882 --- /dev/null +++ b/docs/source/fastNLP.core.utils.torch_utils.rst @@ -0,0 +1,7 @@ +fastNLP.core.utils.torch\_utils module +====================================== + +.. automodule:: fastNLP.core.utils.torch_utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.utils.utils.rst b/docs/source/fastNLP.core.utils.utils.rst new file mode 100644 index 00000000..6ca577d6 --- /dev/null +++ b/docs/source/fastNLP.core.utils.utils.rst @@ -0,0 +1,7 @@ +fastNLP.core.utils.utils module +=============================== + +.. automodule:: fastNLP.core.utils.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.core.vocabulary.rst b/docs/source/fastNLP.core.vocabulary.rst new file mode 100644 index 00000000..a4339b25 --- /dev/null +++ b/docs/source/fastNLP.core.vocabulary.rst @@ -0,0 +1,7 @@ +fastNLP.core.vocabulary module +============================== + +.. automodule:: fastNLP.core.vocabulary + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.envs.distributed.rst b/docs/source/fastNLP.envs.distributed.rst new file mode 100644 index 00000000..bb14f01d --- /dev/null +++ b/docs/source/fastNLP.envs.distributed.rst @@ -0,0 +1,7 @@ +fastNLP.envs.distributed module +=============================== + +.. automodule:: fastNLP.envs.distributed + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.envs.env.rst b/docs/source/fastNLP.envs.env.rst new file mode 100644 index 00000000..8df50d92 --- /dev/null +++ b/docs/source/fastNLP.envs.env.rst @@ -0,0 +1,7 @@ +fastNLP.envs.env module +======================= + +.. automodule:: fastNLP.envs.env + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.envs.imports.rst b/docs/source/fastNLP.envs.imports.rst new file mode 100644 index 00000000..eaf8465d --- /dev/null +++ b/docs/source/fastNLP.envs.imports.rst @@ -0,0 +1,7 @@ +fastNLP.envs.imports module +=========================== + +.. automodule:: fastNLP.envs.imports + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.envs.rst b/docs/source/fastNLP.envs.rst new file mode 100644 index 00000000..4c95ccfe --- /dev/null +++ b/docs/source/fastNLP.envs.rst @@ -0,0 +1,20 @@ +fastNLP.envs package +==================== + +.. automodule:: fastNLP.envs + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.envs.distributed + fastNLP.envs.env + fastNLP.envs.imports + fastNLP.envs.set_backend + fastNLP.envs.set_env_on_import + fastNLP.envs.utils diff --git a/docs/source/fastNLP.envs.set_backend.rst b/docs/source/fastNLP.envs.set_backend.rst new file mode 100644 index 00000000..b0d7e3b3 --- /dev/null +++ b/docs/source/fastNLP.envs.set_backend.rst @@ -0,0 +1,7 @@ +fastNLP.envs.set\_backend module +================================ + +.. automodule:: fastNLP.envs.set_backend + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.envs.set_env_on_import.rst b/docs/source/fastNLP.envs.set_env_on_import.rst new file mode 100644 index 00000000..60f5cbac --- /dev/null +++ b/docs/source/fastNLP.envs.set_env_on_import.rst @@ -0,0 +1,7 @@ +fastNLP.envs.set\_env\_on\_import module +======================================== + +.. automodule:: fastNLP.envs.set_env_on_import + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.envs.utils.rst b/docs/source/fastNLP.envs.utils.rst new file mode 100644 index 00000000..fd0256a6 --- /dev/null +++ b/docs/source/fastNLP.envs.utils.rst @@ -0,0 +1,7 @@ +fastNLP.envs.utils module +========================= + +.. automodule:: fastNLP.envs.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.io.data_bundle.rst b/docs/source/fastNLP.io.data_bundle.rst new file mode 100644 index 00000000..05fcd9c7 --- /dev/null +++ b/docs/source/fastNLP.io.data_bundle.rst @@ -0,0 +1,7 @@ +fastNLP.io.data\_bundle module +============================== + +.. automodule:: fastNLP.io.data_bundle + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.io.embed_loader.rst b/docs/source/fastNLP.io.embed_loader.rst new file mode 100644 index 00000000..acd67dfc --- /dev/null +++ b/docs/source/fastNLP.io.embed_loader.rst @@ -0,0 +1,7 @@ +fastNLP.io.embed\_loader module +=============================== + +.. automodule:: fastNLP.io.embed_loader + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.io.file_reader.rst b/docs/source/fastNLP.io.file_reader.rst new file mode 100644 index 00000000..4c2f8928 --- /dev/null +++ b/docs/source/fastNLP.io.file_reader.rst @@ -0,0 +1,7 @@ +fastNLP.io.file\_reader module +============================== + +.. automodule:: fastNLP.io.file_reader + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.io.file_utils.rst b/docs/source/fastNLP.io.file_utils.rst new file mode 100644 index 00000000..f19d6e2e --- /dev/null +++ b/docs/source/fastNLP.io.file_utils.rst @@ -0,0 +1,7 @@ +fastNLP.io.file\_utils module +============================= + +.. automodule:: fastNLP.io.file_utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.io.loader.classification.rst b/docs/source/fastNLP.io.loader.classification.rst new file mode 100644 index 00000000..6bfd46c7 --- /dev/null +++ b/docs/source/fastNLP.io.loader.classification.rst @@ -0,0 +1,7 @@ +fastNLP.io.loader.classification module +======================================= + +.. automodule:: fastNLP.io.loader.classification + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.io.loader.conll.rst b/docs/source/fastNLP.io.loader.conll.rst new file mode 100644 index 00000000..96123649 --- /dev/null +++ b/docs/source/fastNLP.io.loader.conll.rst @@ -0,0 +1,7 @@ +fastNLP.io.loader.conll module +============================== + +.. automodule:: fastNLP.io.loader.conll + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.io.loader.coreference.rst b/docs/source/fastNLP.io.loader.coreference.rst new file mode 100644 index 00000000..58dfb880 --- /dev/null +++ b/docs/source/fastNLP.io.loader.coreference.rst @@ -0,0 +1,7 @@ +fastNLP.io.loader.coreference module +==================================== + +.. automodule:: fastNLP.io.loader.coreference + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.io.loader.csv.rst b/docs/source/fastNLP.io.loader.csv.rst new file mode 100644 index 00000000..f84f5b18 --- /dev/null +++ b/docs/source/fastNLP.io.loader.csv.rst @@ -0,0 +1,7 @@ +fastNLP.io.loader.csv module +============================ + +.. automodule:: fastNLP.io.loader.csv + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.io.loader.cws.rst b/docs/source/fastNLP.io.loader.cws.rst new file mode 100644 index 00000000..a42ff1f5 --- /dev/null +++ b/docs/source/fastNLP.io.loader.cws.rst @@ -0,0 +1,7 @@ +fastNLP.io.loader.cws module +============================ + +.. automodule:: fastNLP.io.loader.cws + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.io.loader.json.rst b/docs/source/fastNLP.io.loader.json.rst new file mode 100644 index 00000000..53f28586 --- /dev/null +++ b/docs/source/fastNLP.io.loader.json.rst @@ -0,0 +1,7 @@ +fastNLP.io.loader.json module +============================= + +.. automodule:: fastNLP.io.loader.json + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.io.loader.loader.rst b/docs/source/fastNLP.io.loader.loader.rst new file mode 100644 index 00000000..4c437624 --- /dev/null +++ b/docs/source/fastNLP.io.loader.loader.rst @@ -0,0 +1,7 @@ +fastNLP.io.loader.loader module +=============================== + +.. automodule:: fastNLP.io.loader.loader + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.io.loader.matching.rst b/docs/source/fastNLP.io.loader.matching.rst new file mode 100644 index 00000000..5faa91cc --- /dev/null +++ b/docs/source/fastNLP.io.loader.matching.rst @@ -0,0 +1,7 @@ +fastNLP.io.loader.matching module +================================= + +.. automodule:: fastNLP.io.loader.matching + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.io.loader.qa.rst b/docs/source/fastNLP.io.loader.qa.rst new file mode 100644 index 00000000..e3684853 --- /dev/null +++ b/docs/source/fastNLP.io.loader.qa.rst @@ -0,0 +1,7 @@ +fastNLP.io.loader.qa module +=========================== + +.. automodule:: fastNLP.io.loader.qa + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.io.loader.rst b/docs/source/fastNLP.io.loader.rst new file mode 100644 index 00000000..13bd5fe9 --- /dev/null +++ b/docs/source/fastNLP.io.loader.rst @@ -0,0 +1,24 @@ +fastNLP.io.loader package +========================= + +.. automodule:: fastNLP.io.loader + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.io.loader.classification + fastNLP.io.loader.conll + fastNLP.io.loader.coreference + fastNLP.io.loader.csv + fastNLP.io.loader.cws + fastNLP.io.loader.json + fastNLP.io.loader.loader + fastNLP.io.loader.matching + fastNLP.io.loader.qa + fastNLP.io.loader.summarization diff --git a/docs/source/fastNLP.io.loader.summarization.rst b/docs/source/fastNLP.io.loader.summarization.rst new file mode 100644 index 00000000..10338f94 --- /dev/null +++ b/docs/source/fastNLP.io.loader.summarization.rst @@ -0,0 +1,7 @@ +fastNLP.io.loader.summarization module +====================================== + +.. automodule:: fastNLP.io.loader.summarization + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.io.model_io.rst b/docs/source/fastNLP.io.model_io.rst new file mode 100644 index 00000000..fe13d1d7 --- /dev/null +++ b/docs/source/fastNLP.io.model_io.rst @@ -0,0 +1,7 @@ +fastNLP.io.model\_io module +=========================== + +.. automodule:: fastNLP.io.model_io + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.io.pipe.classification.rst b/docs/source/fastNLP.io.pipe.classification.rst new file mode 100644 index 00000000..4428e698 --- /dev/null +++ b/docs/source/fastNLP.io.pipe.classification.rst @@ -0,0 +1,7 @@ +fastNLP.io.pipe.classification module +===================================== + +.. automodule:: fastNLP.io.pipe.classification + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.io.pipe.conll.rst b/docs/source/fastNLP.io.pipe.conll.rst new file mode 100644 index 00000000..0d481811 --- /dev/null +++ b/docs/source/fastNLP.io.pipe.conll.rst @@ -0,0 +1,7 @@ +fastNLP.io.pipe.conll module +============================ + +.. automodule:: fastNLP.io.pipe.conll + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.io.pipe.construct_graph.rst b/docs/source/fastNLP.io.pipe.construct_graph.rst new file mode 100644 index 00000000..4a0c0726 --- /dev/null +++ b/docs/source/fastNLP.io.pipe.construct_graph.rst @@ -0,0 +1,7 @@ +fastNLP.io.pipe.construct\_graph module +======================================= + +.. automodule:: fastNLP.io.pipe.construct_graph + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.io.pipe.coreference.rst b/docs/source/fastNLP.io.pipe.coreference.rst new file mode 100644 index 00000000..bccdb0a7 --- /dev/null +++ b/docs/source/fastNLP.io.pipe.coreference.rst @@ -0,0 +1,7 @@ +fastNLP.io.pipe.coreference module +================================== + +.. automodule:: fastNLP.io.pipe.coreference + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.io.pipe.cws.rst b/docs/source/fastNLP.io.pipe.cws.rst new file mode 100644 index 00000000..46990499 --- /dev/null +++ b/docs/source/fastNLP.io.pipe.cws.rst @@ -0,0 +1,7 @@ +fastNLP.io.pipe.cws module +========================== + +.. automodule:: fastNLP.io.pipe.cws + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.io.pipe.matching.rst b/docs/source/fastNLP.io.pipe.matching.rst new file mode 100644 index 00000000..08f98a78 --- /dev/null +++ b/docs/source/fastNLP.io.pipe.matching.rst @@ -0,0 +1,7 @@ +fastNLP.io.pipe.matching module +=============================== + +.. automodule:: fastNLP.io.pipe.matching + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.io.pipe.pipe.rst b/docs/source/fastNLP.io.pipe.pipe.rst new file mode 100644 index 00000000..b39f56a4 --- /dev/null +++ b/docs/source/fastNLP.io.pipe.pipe.rst @@ -0,0 +1,7 @@ +fastNLP.io.pipe.pipe module +=========================== + +.. automodule:: fastNLP.io.pipe.pipe + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.io.pipe.qa.rst b/docs/source/fastNLP.io.pipe.qa.rst new file mode 100644 index 00000000..38cd6476 --- /dev/null +++ b/docs/source/fastNLP.io.pipe.qa.rst @@ -0,0 +1,7 @@ +fastNLP.io.pipe.qa module +========================= + +.. automodule:: fastNLP.io.pipe.qa + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.io.pipe.rst b/docs/source/fastNLP.io.pipe.rst new file mode 100644 index 00000000..d8cf306e --- /dev/null +++ b/docs/source/fastNLP.io.pipe.rst @@ -0,0 +1,24 @@ +fastNLP.io.pipe package +======================= + +.. automodule:: fastNLP.io.pipe + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.io.pipe.classification + fastNLP.io.pipe.conll + fastNLP.io.pipe.construct_graph + fastNLP.io.pipe.coreference + fastNLP.io.pipe.cws + fastNLP.io.pipe.matching + fastNLP.io.pipe.pipe + fastNLP.io.pipe.qa + fastNLP.io.pipe.summarization + fastNLP.io.pipe.utils diff --git a/docs/source/fastNLP.io.pipe.summarization.rst b/docs/source/fastNLP.io.pipe.summarization.rst new file mode 100644 index 00000000..5163da8d --- /dev/null +++ b/docs/source/fastNLP.io.pipe.summarization.rst @@ -0,0 +1,7 @@ +fastNLP.io.pipe.summarization module +==================================== + +.. automodule:: fastNLP.io.pipe.summarization + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.io.pipe.utils.rst b/docs/source/fastNLP.io.pipe.utils.rst new file mode 100644 index 00000000..be5db9ab --- /dev/null +++ b/docs/source/fastNLP.io.pipe.utils.rst @@ -0,0 +1,7 @@ +fastNLP.io.pipe.utils module +============================ + +.. automodule:: fastNLP.io.pipe.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.io.rst b/docs/source/fastNLP.io.rst new file mode 100644 index 00000000..4fab1696 --- /dev/null +++ b/docs/source/fastNLP.io.rst @@ -0,0 +1,29 @@ +fastNLP.io package +================== + +.. automodule:: fastNLP.io + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.io.loader + fastNLP.io.pipe + +Submodules +---------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.io.data_bundle + fastNLP.io.embed_loader + fastNLP.io.file_reader + fastNLP.io.file_utils + fastNLP.io.model_io + fastNLP.io.utils diff --git a/docs/source/fastNLP.io.utils.rst b/docs/source/fastNLP.io.utils.rst new file mode 100644 index 00000000..b19d8427 --- /dev/null +++ b/docs/source/fastNLP.io.utils.rst @@ -0,0 +1,7 @@ +fastNLP.io.utils module +======================= + +.. automodule:: fastNLP.io.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/fastNLP.rst b/docs/source/fastNLP.rst new file mode 100644 index 00000000..bee33e72 --- /dev/null +++ b/docs/source/fastNLP.rst @@ -0,0 +1,17 @@ +fastNLP package +=============== + +.. automodule:: fastNLP + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 6 + + fastNLP.core + fastNLP.envs + fastNLP.io diff --git a/docs/source/figures/procedures.PNG b/docs/source/figures/procedures.PNG new file mode 100644 index 0000000000000000000000000000000000000000..982249e8d9ba420471a418651c9a79c02c612c9a GIT binary patch literal 14083 zcmd6Oc|6o>|M#d)POBEBB2y|wA(1U+${LbHsVw7AmNYr`ZI(`(R7_>fU_uBnM;O^= z>LgRh*he#%!Wc}9F~;oU`Koj7``q_)-~T+%^Lk!Cufg~Gn(uXeKiB*EY}e;{Ux{Z< z+pSx@V>Ji_T4#UK`YZ^v0tH;>{k#(RTlpkr7Wk(Se%8(sRMDX}3EZp*IN@{x_zJT| z`pZwi{iWbPEyjC#sHtpcAH9WZH?P#$ud$-p`%Lp6 zma49S+~sTDTUIL{`gZ%?y{LSj;4O|_Ev+=mQz@2jFKy~<*>$1t-iC!L{AGs3lhu(` z+azeeXuy-bDc{d~<^L(GX6ETdRyI-|vK)9n2z0~7cSP~~l}}!#P~rR4g#(&P!vKD^ z-cJO7zqoPdf9PZBUl?d(ES^Za1`+yH#ZDG}8h;vKge8L+!;`hOaY`A~v_I1NS-%$Y zO+AB<>)kKm-u<87;yYhcg^P?uBP#AsLtof14EZxZfHOv9&&Si@HtH*w@`+wTfy;!ohONR|j_Z|J`kz zlC0OcbHyWk&)y9npQD7Q!0flTI74%AUqs{Bq5C?>@>RRx1u$;sij6lSy8txY)qfTr zJ%bavOt}An68=)F0P^`rxVY5pruXn1YhfbX9Q5pgW~>8r%LhDK;mruV$^ry>kwv_< z*l~;n>o-(*p12EDs`zF@t7`1Bli;6~Ko?%ZivX28*Omf_v-kT$@l9STG}TU{I8fs= z`siBF?+56olt7@;G$_^z+}iqF>4xhW$k!?q$cMY6z|Z`}kNSn4VEHEC3)ke(Q-_wn z89B^d4mv(PuTiAr!@RTh&4pB$Vckp0q5|m9>djCPsP_O`MIF@goU~yZ>1-=ZyzGX} zFMw6tpiLa(i21rr_l6qlJbni4>1Iirn=x}rb&8;^x0Wp9Y5|8pUbBr9rQoAYF%M6V z7nXoQ7uGJB&x@qRr_2!IXPp%{9&0hIXS$qafIa>8y;VL8KdYh#>D>OtZG?Jik0O`t z4f_4(Q&JG@;Orgyw z=^zmqA3ja1`NYPPh_MTw1B{&^qRZSrHuBbcxqHF90=z=JqO(`}-MbL(mf<0F)@I|s zwfExC^14_~lfVdLKKG$+LGxZ=g1AvkYJ{99o^>rwjc)Y*d1KSYInOOjhJ0UM3FCisW6i5Su8oo%) z>>N0LY)@H_~v#|5R z)Az8OpZg=hdo<9X%!ax#;l)$Z3B59FKka$bwa3#*$0#s~*}HAa))#X}MiU0Za^=s1 zs*_Nxop0VrdAkh#OKZzn5L;_G==T-jAGlSSLN3%;MhnJIr!Q0DQJ7~)ZkvQh)W>vByaI?1`7hpSIXO+?=#MDW??9uERVA&^Yv7Eeyfm46O}e z3>)X)RLZka#4i?V>FX%0G-?m=L33c^B2vIU|OMDnd_=qzX-4wy?+ zW8gP8C((Z2y<^5Gl{37u}z%zaqQka@`dVIYe9V#~QtF z^f57?-B1W}FtqjkPaS*?zzrFHNm4bAa{SGIYJXS2zjYEl*=JdIuQ)`VW#P0GeZskl;q`3k)KzEXWc8( zFj~qbU)R!Yr9c-ON$OQX$6E$xz7Oxn4(CwLaMRG)XHUh60&ESB;ImdC0eh(S#kYH{ zPTlH1#rgEznsRlvsDa8iJDXR=jwTr!F;J4}>j!%~VCM5@U#|=$-mf`Uq|?Y*n^YpS zPMC^!Pzi;QJFT62-D7EV|C0#0h}E!(eT3{;6d%|ts%4-WNQW?Gy7lUn)0HfX@tCJ) zvv1`a^#wf8+CjnSvy!(WHjJ;ROFhxIufwG>syOgLg=%#_TE?eh0k05Ht2ld@V-SAy zqv@X_e(WoAr|hg%rdSBnM1d>Eg|8wGaf*YZPkD@~^zPPA)5q26jUbZ0#(KcJ_@1AY zPf4@y&R`0~_cf#lcTez-}xRTDx7<>=O#aO0%BiB_qSY)rmDLCgU)36OY3+0;y@WjKP!wnmZRy^RNz0I3Kq@HzO5VOT86j% zsGP(iztH-q)~fjR?55r`C@1QSGW@I3*+NJmW8FfAPSYa=M`fhvZ$b0|&YB$WL%t2d znK{q*??j&97cB2ZeQSoBn-l-RwvXH3UB=EnX8J+-tY!l2ZF%H~9i#oBna@HLda|S!Z<{Gc{v1B^t#JP3DB5>^)r2~C&WQ1 zri=4=n!Te4mhiZRK#bW(v;J$WccA!Aj&82=-Uy`YVP~`6xzpo}Qy2b-Ps2P$VA`qA z9zZ1q|2EKlAJyI|e%-XGcegaFVn~bjN6028#X@G=53JkJ=XNayiqFJ# zo>S*F7Ij{J?0sqkkG-5bs-blCDa7wUI(xrob;V=@?UD*Zc7DRMngopx#9m-1zhys9 z)a{aUH)nE#w|M*aysHZ-z&p<8_(B;6C}`wpr#NFOjXFsa;Z@j+;%NE`oH!X491=dQ z(pD^<{M{rs|7t0$`D9Dr8d85Dgo*G-x|k%pP=p%seMxq%vv z%%KzPqE~*ZHsjP(QG*X6|Du=5^#;0>TxT1J6)SLr4n(y6^iOu z-PcqyU5%MyvYz3?bw6Gi?-YND6fj5F8nw2Pmav^LcGk?!&~;7dn4HLpO3${en2sK9 z6=Gd|477u#Qy(xE)k|`uw$!#!hcTPkZng}rhM52{RO4LT(Eomp5LR!!{XVVNz2Nfw z7M|Z&a{oT{n~j^b>}`v$?|75Xr*)*1LLXJTJmGaz$b4rdUplGRwQiLM+_x4G_JSo2TueI@Wg>W6Cslq*OYM zB^c!@DHqn8TBwMSP0FQZt~oTC6>?XuQsYj?ud+7wOxr%ZY8+?6H2`O=&CmEEJ2Yde z3%jK|j0qoV5WA=w(4hUyVDz^b7g$g|`amynxWx;JPs;GXim#@g>WV=VKTjfH9*l%B8t6GZSyR;xaTCE3BxWs@zBfZdoV9)OcN;y;5wuQE;YM1>L zJGbjk76#_Hh1{s0!Bwl7T0;Rfo{uFba~t`xK0%*~-?xM2irP~3ipp_`E%^LXZ9B?p zePZuoII`Ng*LCB3O-R9FnfY{?*?R(#Myc(hc91h#siboRIUY?mlS!7WYYW@AiDn<^ zI>t`p72`0LbTaoGMf%4;uWs=;`DNCWivAOQ+8^X!s7Lv5Kk39`7x||6^fh+u3FJo! zn#hV34RhX00U2c|b)R0n_Fqk5#Udm%^JXPYR)^f5y0|mpX)H3=e1vjF9DS|8D2#aeN{Ot-$&)=; zgyL*~;gL1Yy(eH2zMD|wUs+BoZf2KGFEUBy^({7B@6Iig4pe$dn%}wJo8Iyi-xHc@6;W}2&{p)5GmFWtL04DGIWpss zGsOoAQd*N=4DOw-EJSS}fAp)w7jZ`#VP%wtK?>sLF(LA7j>OR(`tDk+&9OP$qMHUJ`!LMMITsuM0JHF$;DgAu75?RJodIL zQC_Z$^N%?fkul(QL5Lm{qY4HWB6&?v4u|~;;SD*lTi<_AHk5L-2Bu50A4|%1#Ev1- zDW65AsZ*2FEV3XfE2UE=ZKN+frooi$Y5 zm{=PQafT-Qeu()f;8(<79!4L~D>mZy9eBEwm>_i{P$jLa&h?fcHW;t_eG`MyHdDXq zUb@IAc2@7onMm&F%cbxnadIDnWJoUeJV=C^GmkWfTqwkjpFxWKDjG0kA}jJ+o4-dx zb7n6D<;Pb$YlbgU?7Ps<(wv@lH?y_BhW~)bnZnV#+1c#qR>eNuzk$t^l{+uC&&eDY zujg}>>9LFsKcbths|6Cqyxkpc)xU)HJmPG3@gasSOcBlP9QYO-D08GYo7qejn&Z&3 zW(OVWE*iRQp&RybdmFvKXGuqFJtoX-pL$VyYx`cCTlc))2spYv5z1+_RY18y4zn4T z9JPoR%DsUuKKEdyO0TuTd?~iP%}tUJ*P+kHhJ8HJzi>()MGRMMoMD{G+VV zf=RFZa#W?~V*un74I+v9DWi6Xifq_~)|=oVcEy^rjKWdLNDbO2hcO0)#4 zC!B*A>WsI;p)`nICCTz@1Lsd)$LTup(-BFA*L(FMbR0H26OqIPB<-z0U^L5g8a+Wv zhFYiQy>R+7g|)@48LC|#xlY~UTL~{N*0d3VG;0z@4RZ_2T`56lA`|@%{J_@<#-`c5 z02>b-DhyUz!6+ch= z5tAlfO3p<1IQwqnmqb12_=y_K-vWtQ)JTT}BaX!uRSp!dr5ub^OyXT9<$ktuZL*o3fV1)zD4YjG_@9u%X|0jSTK1+Zz*^R^&fbg5 z2)>ldAFBAI)jIL~)gEnQ`}k`mdZNlKl!NAr#h^_`G?z6k3NHuP_gwg9kZS=mgcl@S zhiBlH8>V~WUWvyuAy-63VzYS*+o*rQDx4#*krQ=0_aqlzXwauwQuSNE)fW-V#g>UP z;gv}(fgKi3qqelx5W1dF9*ezD@j;xO0ZfN*&WiLne^8ZOA6CQTz6dOB5Sp$xz1xE- zEpr~$n!9|C9{IC(G@L{0|B0hSOwxnSW96vDUSx5SGfj(D@te>&>ZsFP$thX?{Sei! zDQAW|M6cm2m8^;sJqo3=Vp?dml#RNfsek!g#`>}4UKr=(Dh_W~2M&zjP+FUcY}9H!nwh0~TxB_Wh-;3E(RB zO2%`Jli55nW-js~-Hgj?T^bkIO=4!VJ;yD|nyDFt*$LhQN7B(cW}2>Z@2+`3xgSsQ z8#)8p(Urx>y+#MN!N5|>)7?(nHZ*5Y?9(IOK z!R(BSZs7UM3o2N|ya$R{BxG}sEdrVrwoXxH_)7i%Fg$fk_wi9a*Si@-Y9 zrYDkPMKxXEhdvU$HkofQwu(V>j^!Gzw8HVs-nSL$h0vj6s@&Zvffdu5UL(`_zdE%Q z!gJ;N&GODLDFHEGRR~U zpsKz0VRWWvzG4)NGpz}y=v3mv3K@&eE{hk64}4@Xv&1LPFt~8BH{S0(SNY!q*e98p z(5Mbvq9k$*^JbhUVlZbHQwe@R5bI|(BG8N$jzGJ(xy{{#vQOULYo|_eid2Cnw}eh! zw2Sp-^_)-U@xtKL-9Vnu@WUx!rKjA@RP!pfm@u?dTlRaQw%-raLgWK>k#)hKL^4Oh5Pv!eRpUA*NAF4pCCXwHf$dhc%J8dY+Id z*P&Zr$I;LDB&bT@vA%t|duqzlV~Kqb?{r@Lt$v&M187BjL-N<}z9m*Qg!5rY+cghg z(_YIZj~DhIaJJt&NwT=7vXOMKzQq;d&)}Ic z+ln-%UQB1vtl0=~c@JbYb3YXSdUAc8Jy<-e+_nX9M<1uZ%$aeHiAnOEtgWFhTvIFe zs&uKxeoMEcddLi2(X(=fvc7J%z#t7a63K(Rc^?W{4UT@oDO1mL&aw1put~m$4yGSs zm8#|58dK)$O^+fLyNz=9ga-~iS~#`^Z`J2Uy7%~D*Vg)E7yqS2RiBE(TvcL1x=IJfizd3zeE%#%Enpr?iqTU*LV+!vC7>K7%kxH>6jmkS%D7}eRKQj_y&=dbN z2L^cj3_|2viPdmXxsrB7Qiz6rpO^E3;=zG+qa`m1zr8pyZm$z9T|yl-SaZzA zquNWL`vdd>tQ|FJg1jU0ho49_Zw|f#)T86;gSi;zD7rHQ(&HgZnZ0(kN;|2&NpD^XprUY$n7uod&OLJckMOJv;Cv%&CFCx;a-*`cvs7u zC+lyPP+t+R>ctvxXGSEdn2}uOx4T*~0-9pv46m{|J82t*I-Ar!?!dj`jCHyliEBWk|H}>ww;QqMQ@^Gm#@VWY@ zj;<<8VpKh)g~Y#hGidUn9u1n?BUAO&KXKb%{?aqfcIIH~ncgDtDUa~cUtYVeE7c92 zFb4MiIOF~pCA627hnj}7)aSE=Bi*28a zgQ|a-#1_h(K=AOjq^&h2ke>d*7!w2jv#D2iQM`5o${-XfBTerPUI!2TSre7+2dw)J zSn2Ob+o@kkjNNytTm6l~yzBj8D1Rt~x%y7O7OdF}=@oZ<`z>n8Qt1(7753p8&DUn$ zoI|w{ILfN;wIsWHc~t6DY5_61w5R47&qolq+0Bvb)t_rgnkQA ziMjZfNFl8!`rcz|ti{P$xPp;eN|1qa3rg+V?LTBX2ki)Si)y}ocP#A-eOV1xrKqTr z*P5z_M}1pz{1)pz?I!M=$_t1f85MRmrNY2jcQp%<`Sn`!FAe%uEDRnXOIBQT%^pF% zX)AN$KP8N}yo+^R4;XP{p?ECCxg#f_8Q6HNqK_!R5)4jB54E`|m3j{^y>e+bzR*EO zyI1_~eNT#YT`h}vM)ZL2A3UM{l6ZG)0}N9?p{ku_@@eyWaWsyyuX%FPbU&&}qauNL z9;GT#opOBUiDw~e@&rLcs=d@myva{`4ZvOpElX8N340Y-x%=sT#*^grv8{#I$mFy(O>yi&@3_gr z@WqwCW*HR(s^;$q;PXvN3FuI+4e0!aVoR(QR60r zM?3xdUR%0*h397-3w7jJAfnYT2b?@V~3%Ck9sN0 z+Sw``u)$?z)~B0yUnLUz1g|ftViIxneYB9%PDfe)2oE8x=EC8xvlL#OE2KSK*Do^SLo2iQ1It7Y`s9lZ8P#S2^&(Kz&w%C0=7-{0iG^Bo`fhhy=T>b+?)+G4%|EZv%6fjq z!E+yt1#JDI4&+Ul6q{fwh5FQFf{9L2Liaj|I>fh**ioHC;LEm%qbI+%)N0v4S~}XJCrEFtj>vD2il?H+?!0jf&!jhz(=S{E{D%=W}UKFqV2Qa^G`VsoZJDul9ixx9#2Y&jzlf zPu|fZt&OuDiM*O%9-3wqx$2a(H<4hH1o8Vo3VyD*lbYtPtj$OxaA*D0&O+|;7FJAe zlkLdc%_53;myHEF^ZuM2Y03o&}P|^n-KZziGbkLg{ubRO0*7i1y5R z#241H@cXiJXjt(T-SmTp3l`1*JFZ8tgf~88)?p);`Vh!6PN+&(3}k>`v+4NS@$8ez zvB!h4Cokj%R_E-$nHku%rm#PVexdlDpZ3TxzL?Z{{-)c-ODYI-A6;bDr`H^oR?LgI zv{e#g`DvBQs?&F~$pcbhu$@QtT?{hGf-jk%iZt=}LN^-f8b;ORwBE0LX8y(R6Zw}^ z4zo1-!c0m{LMrB~^wN!mpLcMEx5j2qGKk)SP6YJOkozsnFQkNHB!RZlYr-p=NUmBs zEX;f{Z9%~6;oW?|T;2Y{VktjvFVZ=@&Gd2h>+|1z#9(g{Yx%k5ko~(qemte;gN)5T zV;Ls;iL)X110rgWJy=W}UT^w2(Oc6GdAbNt5I?VZZm^|?8b#8OZ+JJ1q-XK7VNm?> z4SKZ{;ivjmJ2XniHvG?gGgE;?o`PggUi^dZ;CG}a`k`MF3zLmT{9(*fN&B!RZtJYf zk#cl|Oc5aUY9piwR7H^J(x;;TB4%+$zDe#%guQyZm3OoG#<)!>(vg^-_Z1B=*i3TY zn5)MV<&cE4N4DbN0>7LQ^W?}bGJX|2)O@kxu^71-yg3$8%hh+y3QUSz4Gu;|reWmL zOaHLY-w+rbENNcIg_&VClDe)S0XZz7#*fC^u!UI4`3MIquUmOGLR`zT4f6Vi$ z{M6f)^r$%fhmjlOR`o#SN76Uv?cZjTh@yQ!m+rD`b3;wq?YN~GkfoVdjbD6GfP>*? z!zaVl{Te1lskaFxxlqJdD4Ry;5k83AxC65z7*fRNvC8x#qVBGDqLX1nCsYtDU-V{^$mu8Zu zfu;qx=0xUdnOidSK(&SEJ&wl?DzLFCZ_N3pjPxdpzpymKgvc7~C$Z3Cx%q=U%8E+d zvVWCrt3>N}^S^+M{uUq=$_uSo_IvT}ra)cntb!^>mZHh^MIQqgP_zmix6^^& z6P^^3g5fYCw3!>G@l2X7>Gpfn>Q41!!Uf$h4b#x_e;@{XX87gkuLjP0S3952y%(n8 za#8MT6pO^I+6=>`T+V%~yRT~#KKui;&h4t=J_Dx>%+bGrhNld)%7)3ctcTspZ#q|} z_XAbx$$=%r@^@}2aQVD34g1`}{|(uPSgROPmN#m`+LaXKG*PN1W56txMaMe536}I= z*qs@HX#Wi!mp}3Zc5_5XW9)A_2WaMhl2?y1d-Y2&$nMC8MC&}}TXeo1vzh3yGIxct z=|=5DVO-i4a#Es-o)s+q2{-OwzBkQ%l|3sTi5R~qAun9wNG}Ypr;%ZMYjT{|@`1@0 zahKxOx}>~7yQHH@j0vjP3=bc8p_ycHk-6PRNk@?J`&o_oFpH6GqMs;M{JD=i@b2zmu0vtn z=Z*>21Zd4Ycb+fWC1Pkh1Qk&bGiE#jRE}T}-shLr+Vdl(VVng-~Xi>li^2aGn|OgfS1|gjFX}yXM2T z(6#zSkUHXxlM^koGv&q zYoLTiNS16{C0hRGNpJ3G8BVywauuwL8Er}W&Q`OZ-_FO?_^nka*1veY4k0@9pV@eD z4>IzfVmM11Q#~NxOyVe3FLZmtS_M>Yq0B zH;gJRl5W=D1dv|~Gp&;GizQ*~^4ejV@mMgviQuu?{9B(pY)G($uWJ4V;7u9;yh(LG zu)*wbJZG9d{$2$(sPoeoLnGhpz;-uhfb(d*#CbfNpay+V+zQB!WIS38DPFM;hTy)h zL*=7xDFWQduhJ@{asexST7N-*IWRKTc$Xb`sFq>}Mpk<)KVIS8R1XFNB`brN8vu84 zX8g%0i|ba$2g)5BRX6U}1n^8h2rH4jl_ZGQbO2NL&g&!~RRGw43oINs^po6~1`hBD zyQuPupOxQFtj7R1wl6zOipbTj^^Rqxg|BOK);T^GJ&FfdjUKlSVRp+>m2bR~y53G< zrcYNc=&s4`=h;@^0tT#8pIzls>au^0s4mj)D$m>iuYL+ zVG-#SiHyvVQMBzQiZ5o)PXf%`4!5Ts*N4p?Jngb_mUlE+Dp})@3!ldUQYqG>_BwoK zxT%4@Jkyweg&)M9c81F4^FFS*)6)D>6M5N#gFFSWM4uTswsNbm!c`)k!@WpF+@yh; z-@RS+w+6$u$&wq;J_k>{)Hht|FM0~eiWu%+M0pY$Jxq4aDW2F6eh;T zHQedZ_#0(>|9|18Yy4+!Ixt~x+xkZ_Ax1D{jfV*=dS>u50wDKd0itL;4gKeQI>czGM(+aO(+rcmtTzSmhC;{{g(>gy&^|3a+t@+259bQZ!rsMnfMsKk-IwVn0&4 z&xy3G#d#65O&fKmmzSuS@^oI|#(SE790+uHjfi?gIqtVn15?oa7Vwx_9*pDL4IGt# zW2Y5BZ>~)=@WlsV@{z4yp$g47|CRmrDJDA>#b;uiRAl;9iFH?<0u3ywe_gsFWNU#0zA!pKqn_MeqWeT7Ngr?2FQKpOC53nd1 zdyc877bVvyzEY@i9HS32+;WYf{^Mg+%W}6=@Tnn01E+Ql$BS!{pQ%`CqSV(DLX-$0 zn7V6t{82ey1QVNsoz}+#K)vi(nE8JG38+o|4?O?{i1+{DaMtrr + +API 文档 +------------- + +除了用户手册之外，你还可以通过查阅 API 文档来找到你所需要的工具。 + +.. toctree:: + :titlesonly: + :maxdepth: 2 + + fastNLP + + +索引与搜索 +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 00000000..5515520a --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,7 @@ +fastNLP +======= + +.. toctree:: + :maxdepth: 6 + + fastNLP diff --git a/docs/source/user/example.rst b/docs/source/user/example.rst new file mode 100644 index 00000000..cc83d578 --- /dev/null +++ b/docs/source/user/example.rst @@ -0,0 +1,162 @@ +====== +大标题 +====== + +.. note:: + 中文标题需要符号的数量至少是中文字数的两倍 + +.. warning:: + 符号的数量只可以多，不可以少。 + +小标题1 +########### + +小标题2 +********* + +小标题3(正常使用) +======================== + +小标题4 +------------------- + +推荐使用大标题、小标题3和小标题4 + +官方文档 http://docutils.sourceforge.net/docs/user/rst/quickref.html + +`熟悉markdown的同学推荐参考这篇文章 `_ + +\<\>内表示的是链接地址，\<\>外的是显示到外面的文字 + +常见语法 +============ + +*emphasis* + +**strong** + +`text` + +``inline literal`` + +http://docutils.sf.net/ 孤立的网址会自动生成链接 + +显示为特定的文字的链接 `sohu `_ + +突出显示的 + 上面文字 + +正常缩进 + + 形成锻炼 + + + +特殊模块 +============ + +选项会自动识别 + +-v An option +-o file Same with value +--delta A long option +--delta=len Same with value + + +图片 + +.. image:: ../figures/procedures.PNG + :height: 200 + :width: 560 + :scale: 50 + :alt: alternate text + :align: center + +显示一个冒号的代码块:: + + 中间要空一行 + +:: + + 不显示冒号的代码块 + +.. code-block:: python + + :linenos: + :emphasize-lines: 1,3 + + print("专业的代码块") + print("") + print("有行号和高亮") + +数学块 +========== + +.. math:: + + H_2O + Na = NaOH + H_2 \uparrow + +复杂表格 +========== + ++------------------------+------------+----------+----------+ +| Header row, column 1 | Header 2 | Header 3 | Header 4 | +| (header rows optional) | | | | ++========================+============+==========+==========+ +| body row 1, column 1 | column 2 | column 3 | column 4 | ++------------------------+------------+----------+----------+ +| body row 2 | Cells may span columns. | ++------------------------+------------+---------------------+ +| body row 3 | Cells may | - Table cells | ++------------------------+ span rows. | - contain | +| body row 4 | | - body elements. | ++------------------------+------------+---------------------+ + +简易表格 +========== + +===== ===== ====== + Inputs Output +------------ ------ + A B A or B +===== ===== ====== +False False False +True True True +===== ===== ====== + +csv 表格 +============ + +.. csv-table:: + :header: sentence, target + + This is the first instance ., 0 + Second instance ., 1 + Third instance ., 1 + ..., ... + + + +[重要]各种链接 +=================== + +各种链接帮助我们连接到fastNLP文档的各个位置 + +\<\>内表示的是链接地址，\<\>外的是显示到外面的文字 + +:doc:`根据文件名链接 ` + +:mod:`~fastNLP.core.batch` + +:class:`~fastNLP.Batch` + +~表示只显示最后一项 + +:meth:`fastNLP.DataSet.apply` + +下面这个代码是不可行的，必须要用 r""" 才行: + +.. code:: + + :param float beta: f_beta分数， :math:`f_{beta} = \frac{(1 + {beta}^{2})*(pre*rec)}{({beta}^{2}*pre + rec)}` . 常用为 `beta=0.5, 1, 2` 若为0.5则精确率的权重高于召回率；若为1，则两者平等；若为2，则召回率权重高于精确率。 + diff --git a/docs/transfer.ipynb b/docs/transfer.ipynb new file mode 100644 index 00000000..ff897acd --- /dev/null +++ b/docs/transfer.ipynb @@ -0,0 +1,101 @@ +{ + "cells": [ + { + "cell_type": "code", + "execution_count": 20, + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "'应当为一个字符串，其值应当为以下之一：``[None, \"dist\", \"unrepeatdist\"]``；为 ``None`` 时，表示不需要考虑当前 ``dataloader`` 切换为分布式状态；为 ``\"dist\"`` 时，表示该 ``dataloader`` 应该保证每个 ``gpu`` 上返回的 ``batch`` 的数量是一样多的，允许出现少量 ``sample`` ，在 不同 ``gpu`` 上出现重复；为 ``\"unrepeatdist\"`` 时，表示该 ``dataloader`` 应该保证所有 ``gpu`` 上迭代出来的数据合并起来应该刚好等于原始的 数据，允许不同 ``gpu`` 上 ``batch`` 的数量不一致。其中 ``trainer`` 中 ``kwargs`` 的参数 ``use_dist_sampler`` 为 ``True`` 时，该值为 ``\"dist\"``； 否则为 ``None`` ，``evaluator`` 中的 ``kwargs`` 的参数 ``use_dist_sampler`` 为 ``True`` 时，该值为 ``\"unrepeatdist\"``，否则为 ``None``； 注意当 ``dist`` 为 ``ReproducibleSampler, ReproducibleBatchSampler`` 时，是断点重训加载时 ``driver.load`` 函数在调用； 当 ``dist`` 为 ``str`` 或者 ``None`` 时，是 ``trainer`` 在初始化时调用该函数；'" + ] + }, + "execution_count": 20, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "import re\n", + "import sys\n", + "sys.path.append(\"../\")\n", + "# import fastNLP\n", + "\n", + "def get_class(text):\n", + " return f\":class:`~{text}`\"\n", + "\n", + "def get_meth(text):\n", + " return f\":meth:`~{text}`\"\n", + "\n", + "def get_module(text):\n", + " return f\":mod:`~{text}`\"\n", + "\n", + "def replace(matched):\n", + " \"\"\"\n", + " \"\"\"\n", + " text = matched.group()\n", + " non_space = text.strip()\n", + " if non_space == \"\":\n", + " return text\n", + " # 如果原本就添加了 `，那么只加一个\n", + " if non_space.startswith(\"`\"):\n", + " res = \"`\" + non_space\n", + " else:\n", + " res = \"``\" + non_space\n", + " if non_space.endswith(\"`\"):\n", + " res += \"`\"\n", + " else:\n", + " res += \"``\"\n", + " return text.replace(non_space, f\"{res}\")\n", + "\n", + "def transfer(text):\n", + " \"\"\"\n", + " 将输入的 ``text`` 中的英文单词添加 \"``\"。在得到结果后最好手动检查一下，\n", + " \"\"\"\n", + " res = re.sub(\n", + " # 匹配字母、下划线、点、逗号、引号、中括号和`\n", + " pattern=r\"[a-zA-Z_ \\.,\\\"\\'\\[\\]`]+\",\n", + " repl=replace,\n", + " string=text\n", + " )\n", + " return res\n", + "\n", + "\n", + "text = '应当为一个字符串，其值应当为以下之一：[None, \"dist\", \"unrepeatdist\"]；为 None 时，表示不需要考虑当前 dataloader \\\n", + " 切换为分布式状态；为 \"dist\" 时，表示该 dataloader 应该保证每个 gpu 上返回的 batch 的数量是一样多的，允许出现少量 sample ，在 \\\n", + " 不同 gpu 上出现重复；为 \"unrepeatdist\" 时，表示该 dataloader 应该保证所有 gpu 上迭代出来的数据合并起来应该刚好等于原始的 \\\n", + " 数据，允许不同 gpu 上 batch 的数量不一致。其中 trainer 中 kwargs 的参数 `use_dist_sampler` 为 True 时，该值为 \"dist\"； \\\n", + " 否则为 None ，evaluator 中的 kwargs 的参数 `use_dist_sampler` 为 True 时，该值为 \"unrepeatdist\"，否则为 None； \\\n", + " 注意当 dist 为 ReproducibleSampler, ReproducibleBatchSampler 时，是断点重训加载时 driver.load 函数在调用； \\\n", + " 当 dist 为 str 或者 None 时，是 trainer 在初始化时调用该函数；'\n", + "transfer(text)" + ] + } + ], + "metadata": { + "interpreter": { + "hash": "c79c3370938623706c2d55a7989cf7c7c31ff0346157477d22565bb370580b77" + }, + "kernelspec": { + "display_name": "Python 3.7.13 ('fnlp')", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.7.13" + }, + "orig_nbformat": 4 + }, + "nbformat": 4, + "nbformat_minor": 2 +}