@@ -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) |
@@ -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) |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.callbacks.callback module | |||||
====================================== | |||||
.. automodule:: fastNLP.core.callbacks.callback | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.callbacks.callback\_event module | |||||
============================================= | |||||
.. automodule:: fastNLP.core.callbacks.callback_event | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.callbacks.callback\_manager module | |||||
=============================================== | |||||
.. automodule:: fastNLP.core.callbacks.callback_manager | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.callbacks.checkpoint\_callback module | |||||
================================================== | |||||
.. automodule:: fastNLP.core.callbacks.checkpoint_callback | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.callbacks.early\_stop\_callback module | |||||
=================================================== | |||||
.. automodule:: fastNLP.core.callbacks.early_stop_callback | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.callbacks.has\_monitor\_callback module | |||||
==================================================== | |||||
.. automodule:: fastNLP.core.callbacks.has_monitor_callback | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -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: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.callbacks.lr\_scheduler\_callback module | |||||
===================================================== | |||||
.. automodule:: fastNLP.core.callbacks.lr_scheduler_callback | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.callbacks.more\_evaluate\_callback module | |||||
====================================================== | |||||
.. automodule:: fastNLP.core.callbacks.more_evaluate_callback | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.callbacks.progress\_callback module | |||||
================================================ | |||||
.. automodule:: fastNLP.core.callbacks.progress_callback | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -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 |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.callbacks.topk\_saver module | |||||
========================================= | |||||
.. automodule:: fastNLP.core.callbacks.topk_saver | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -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 |
@@ -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: |
@@ -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: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.callbacks.utils module | |||||
=================================== | |||||
.. automodule:: fastNLP.core.callbacks.utils | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.collators.collator module | |||||
====================================== | |||||
.. automodule:: fastNLP.core.collators.collator | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.collators.packer\_unpacker module | |||||
============================================== | |||||
.. automodule:: fastNLP.core.collators.packer_unpacker | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.collators.padders.exceptions module | |||||
================================================ | |||||
.. automodule:: fastNLP.core.collators.padders.exceptions | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.collators.padders.get\_padder module | |||||
================================================= | |||||
.. automodule:: fastNLP.core.collators.padders.get_padder | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.collators.padders.jittor\_padder module | |||||
==================================================== | |||||
.. automodule:: fastNLP.core.collators.padders.jittor_padder | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.collators.padders.numpy\_padder module | |||||
=================================================== | |||||
.. automodule:: fastNLP.core.collators.padders.numpy_padder | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.collators.padders.padder module | |||||
============================================ | |||||
.. automodule:: fastNLP.core.collators.padders.padder | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.collators.padders.paddle\_padder module | |||||
==================================================== | |||||
.. automodule:: fastNLP.core.collators.padders.paddle_padder | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.collators.padders.raw\_padder module | |||||
================================================= | |||||
.. automodule:: fastNLP.core.collators.padders.raw_padder | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -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 |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.collators.padders.torch\_padder module | |||||
=================================================== | |||||
.. automodule:: fastNLP.core.collators.padders.torch_padder | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.collators.padders.torch\_utils module | |||||
================================================== | |||||
.. automodule:: fastNLP.core.collators.padders.torch_utils | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.collators.padders.utils module | |||||
=========================================== | |||||
.. automodule:: fastNLP.core.collators.padders.utils | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -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 |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.controllers.evaluator module | |||||
========================================= | |||||
.. automodule:: fastNLP.core.controllers.evaluator | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -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: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.controllers.loops.loop module | |||||
========================================== | |||||
.. automodule:: fastNLP.core.controllers.loops.loop | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -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 |
@@ -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: |
@@ -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 |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.controllers.trainer module | |||||
======================================= | |||||
.. automodule:: fastNLP.core.controllers.trainer | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -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 |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.controllers.utils.state module | |||||
=========================================== | |||||
.. automodule:: fastNLP.core.controllers.utils.state | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.controllers.utils.utils module | |||||
=========================================== | |||||
.. automodule:: fastNLP.core.controllers.utils.utils | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.dataloaders.jittor\_dataloader.fdl module | |||||
====================================================== | |||||
.. automodule:: fastNLP.core.dataloaders.jittor_dataloader.fdl | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -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 |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.dataloaders.mix\_dataloader module | |||||
=============================================== | |||||
.. automodule:: fastNLP.core.dataloaders.mix_dataloader | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.dataloaders.paddle\_dataloader.fdl module | |||||
====================================================== | |||||
.. automodule:: fastNLP.core.dataloaders.paddle_dataloader.fdl | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -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 |
@@ -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 |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.dataloaders.torch\_dataloader.fdl module | |||||
===================================================== | |||||
.. automodule:: fastNLP.core.dataloaders.torch_dataloader.fdl | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -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 |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.dataloaders.utils module | |||||
===================================== | |||||
.. automodule:: fastNLP.core.dataloaders.utils | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.dataset.dataset module | |||||
=================================== | |||||
.. automodule:: fastNLP.core.dataset.dataset | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.dataset.field module | |||||
================================= | |||||
.. automodule:: fastNLP.core.dataset.field | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.dataset.instance module | |||||
==================================== | |||||
.. automodule:: fastNLP.core.dataset.instance | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -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 |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.drivers.choose\_driver module | |||||
========================================== | |||||
.. automodule:: fastNLP.core.drivers.choose_driver | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.drivers.driver module | |||||
================================== | |||||
.. automodule:: fastNLP.core.drivers.driver | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -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: |
@@ -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: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.drivers.jittor\_driver.mpi module | |||||
============================================== | |||||
.. automodule:: fastNLP.core.drivers.jittor_driver.mpi | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -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 |
@@ -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: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.drivers.jittor\_driver.utils module | |||||
================================================ | |||||
.. automodule:: fastNLP.core.drivers.jittor_driver.utils | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -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: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.drivers.paddle\_driver.fleet module | |||||
================================================ | |||||
.. automodule:: fastNLP.core.drivers.paddle_driver.fleet | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -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: |
@@ -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: |
@@ -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: |
@@ -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 |
@@ -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: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.drivers.paddle\_driver.utils module | |||||
================================================ | |||||
.. automodule:: fastNLP.core.drivers.paddle_driver.utils | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -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 |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.drivers.torch\_driver.ddp module | |||||
============================================= | |||||
.. automodule:: fastNLP.core.drivers.torch_driver.ddp | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -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: |
@@ -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: |
@@ -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: |
@@ -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 |
@@ -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: |
@@ -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: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.drivers.torch\_driver.utils module | |||||
=============================================== | |||||
.. automodule:: fastNLP.core.drivers.torch_driver.utils | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.drivers.utils module | |||||
================================= | |||||
.. automodule:: fastNLP.core.drivers.utils | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.log.handler module | |||||
=============================== | |||||
.. automodule:: fastNLP.core.log.handler | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.log.highlighter module | |||||
=================================== | |||||
.. automodule:: fastNLP.core.log.highlighter | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.log.logger module | |||||
============================== | |||||
.. automodule:: fastNLP.core.log.logger | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.log.print module | |||||
============================= | |||||
.. automodule:: fastNLP.core.log.print | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -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 |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.metrics.accuracy module | |||||
==================================== | |||||
.. automodule:: fastNLP.core.metrics.accuracy | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.metrics.backend.auto\_backend module | |||||
================================================= | |||||
.. automodule:: fastNLP.core.metrics.backend.auto_backend | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.metrics.backend.backend module | |||||
=========================================== | |||||
.. automodule:: fastNLP.core.metrics.backend.backend | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -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: |
@@ -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 |
@@ -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: |
@@ -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 |
@@ -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 |
@@ -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: |
@@ -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 |
@@ -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: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.metrics.element module | |||||
=================================== | |||||
.. automodule:: fastNLP.core.metrics.element | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -0,0 +1,7 @@ | |||||
fastNLP.core.metrics.metric module | |||||
================================== | |||||
.. automodule:: fastNLP.core.metrics.metric | |||||
:members: | |||||
:undoc-members: | |||||
:show-inheritance: |
@@ -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 |