docs更新

设置了模板，对fastNLP文件夹下的内容生成了文档

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = fastNLP
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.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)

docs/make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+set SPHINXPROJ=fastNLP
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

docs/source/conf.py

@@ -0,0 +1,161 @@
+# -*- 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('../../'))
+
+import sphinx_rtd_theme
+
+# -- Project information -----------------------------------------------------
+
+project = 'fastNLP'
+copyright = '2018, xpqiu'
+author = 'xpqiu'
+
+# The short X.Y version
+version = ''
+# The full version, including alpha/beta/rc tags
+release = '1.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',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# 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 = None
+
+# 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 = []
+
+# 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 = {}
+
+# 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 = 'fastNLPdoc'
+
+
+# -- 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 = [
+    (master_doc, 'fastNLP.tex', 'fastNLP Documentation',
+     'xpqiu', 'manual'),
+]
+
+
+# -- 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 -------------------------------------------------

docs/source/fastNLP.core.rst

@@ -0,0 +1,62 @@
+fastNLP.core package
+====================
+
+Submodules
+----------
+
+fastNLP.core.action module
+--------------------------
+
+.. automodule:: fastNLP.core.action
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+fastNLP.core.metrics module
+---------------------------
+
+.. automodule:: fastNLP.core.metrics
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+fastNLP.core.optimizer module
+-----------------------------
+
+.. automodule:: fastNLP.core.optimizer
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+fastNLP.core.predictor module
+-----------------------------
+
+.. automodule:: fastNLP.core.predictor
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+fastNLP.core.tester module
+--------------------------
+
+.. automodule:: fastNLP.core.tester
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+fastNLP.core.trainer module
+---------------------------
+
+.. automodule:: fastNLP.core.trainer
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: fastNLP.core
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/fastNLP.loader.rst

@@ -0,0 +1,62 @@
+fastNLP.loader package
+======================
+
+Submodules
+----------
+
+fastNLP.loader.base\_loader module
+----------------------------------
+
+.. automodule:: fastNLP.loader.base_loader
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+fastNLP.loader.config\_loader module
+------------------------------------
+
+.. automodule:: fastNLP.loader.config_loader
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+fastNLP.loader.dataset\_loader module
+-------------------------------------
+
+.. automodule:: fastNLP.loader.dataset_loader
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+fastNLP.loader.embed\_loader module
+-----------------------------------
+
+.. automodule:: fastNLP.loader.embed_loader
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+fastNLP.loader.model\_loader module
+-----------------------------------
+
+.. automodule:: fastNLP.loader.model_loader
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+fastNLP.loader.preprocess module
+--------------------------------
+
+.. automodule:: fastNLP.loader.preprocess
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: fastNLP.loader
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/fastNLP.models.rst

@@ -0,0 +1,46 @@
+fastNLP.models package
+======================
+
+Submodules
+----------
+
+fastNLP.models.base\_model module
+---------------------------------
+
+.. automodule:: fastNLP.models.base_model
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+fastNLP.models.char\_language\_model module
+-------------------------------------------
+
+.. automodule:: fastNLP.models.char_language_model
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+fastNLP.models.cnn\_text\_classification module
+-----------------------------------------------
+
+.. automodule:: fastNLP.models.cnn_text_classification
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+fastNLP.models.sequence\_modeling module
+----------------------------------------
+
+.. automodule:: fastNLP.models.sequence_modeling
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: fastNLP.models
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/fastNLP.modules.aggregation.rst

@@ -0,0 +1,54 @@
+fastNLP.modules.aggregation package
+===================================
+
+Submodules
+----------
+
+fastNLP.modules.aggregation.attention module
+--------------------------------------------
+
+.. automodule:: fastNLP.modules.aggregation.attention
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+fastNLP.modules.aggregation.avg\_pool module
+--------------------------------------------
+
+.. automodule:: fastNLP.modules.aggregation.avg_pool
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+fastNLP.modules.aggregation.kmax\_pool module
+---------------------------------------------
+
+.. automodule:: fastNLP.modules.aggregation.kmax_pool
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+fastNLP.modules.aggregation.max\_pool module
+--------------------------------------------
+
+.. automodule:: fastNLP.modules.aggregation.max_pool
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+fastNLP.modules.aggregation.self\_attention module
+--------------------------------------------------
+
+.. automodule:: fastNLP.modules.aggregation.self_attention
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: fastNLP.modules.aggregation
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/fastNLP.modules.decoder.rst

@@ -0,0 +1,22 @@
+fastNLP.modules.decoder package
+===============================
+
+Submodules
+----------
+
+fastNLP.modules.decoder.CRF module
+----------------------------------
+
+.. automodule:: fastNLP.modules.decoder.CRF
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: fastNLP.modules.decoder
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/fastNLP.modules.encoder.rst

@@ -0,0 +1,78 @@
+fastNLP.modules.encoder package
+===============================
+
+Submodules
+----------
+
+fastNLP.modules.encoder.char\_embedding module
+----------------------------------------------
+
+.. automodule:: fastNLP.modules.encoder.char_embedding
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+fastNLP.modules.encoder.conv module
+-----------------------------------
+
+.. automodule:: fastNLP.modules.encoder.conv
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+fastNLP.modules.encoder.conv\_maxpool module
+--------------------------------------------
+
+.. automodule:: fastNLP.modules.encoder.conv_maxpool
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+fastNLP.modules.encoder.embedding module
+----------------------------------------
+
+.. automodule:: fastNLP.modules.encoder.embedding
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+fastNLP.modules.encoder.linear module
+-------------------------------------
+
+.. automodule:: fastNLP.modules.encoder.linear
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+fastNLP.modules.encoder.lstm module
+-----------------------------------
+
+.. automodule:: fastNLP.modules.encoder.lstm
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+fastNLP.modules.encoder.masked\_rnn module
+------------------------------------------
+
+.. automodule:: fastNLP.modules.encoder.masked_rnn
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+fastNLP.modules.encoder.variational\_rnn module
+-----------------------------------------------
+
+.. automodule:: fastNLP.modules.encoder.variational_rnn
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: fastNLP.modules.encoder
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/fastNLP.modules.interaction.rst

@@ -0,0 +1,10 @@
+fastNLP.modules.interaction package
+===================================
+
+Module contents
+---------------
+
+.. automodule:: fastNLP.modules.interaction
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/fastNLP.modules.rst

@@ -0,0 +1,40 @@
+fastNLP.modules package
+=======================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    fastNLP.modules.aggregation
+    fastNLP.modules.decoder
+    fastNLP.modules.encoder
+    fastNLP.modules.interaction
+
+Submodules
+----------
+
+fastNLP.modules.other\_modules module
+-------------------------------------
+
+.. automodule:: fastNLP.modules.other_modules
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+fastNLP.modules.utils module
+----------------------------
+
+.. automodule:: fastNLP.modules.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: fastNLP.modules
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/fastNLP.rst

@@ -0,0 +1,33 @@
+fastNLP package
+===============
+
+Subpackages
+-----------
+
+.. toctree::
+
+    fastNLP.core
+    fastNLP.loader
+    fastNLP.models
+    fastNLP.modules
+    fastNLP.saver
+
+Submodules
+----------
+
+fastNLP.fastnlp module
+----------------------
+
+.. automodule:: fastNLP.fastnlp
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: fastNLP
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/fastNLP.saver.rst

@@ -0,0 +1,30 @@
+fastNLP.saver package
+=====================
+
+Submodules
+----------
+
+fastNLP.saver.logger module
+---------------------------
+
+.. automodule:: fastNLP.saver.logger
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+fastNLP.saver.model\_saver module
+---------------------------------
+
+.. automodule:: fastNLP.saver.model_saver
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: fastNLP.saver
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/index.rst

@@ -0,0 +1,23 @@
+.. fastNLP documentation master file, created by
+   sphinx-quickstart on Mon Aug 20 17:06:44 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to fastNLP's documentation!
+===================================
+
+.. toctree::
+   :maxdepth: 4
+   :caption: Contents:
+   
+   fastNLP
+
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/modules.rst

@@ -0,0 +1,7 @@
+fastNLP
+=======
+
+.. toctree::
+   :maxdepth: 4
+
+   fastNLP