From 97ccf5d665ace6f7e39fc58ff34d1645330c21a0 Mon Sep 17 00:00:00 2001 From: Jindra Helcl Date: Wed, 31 Aug 2016 16:59:43 +0200 Subject: [PATCH] [ci skip] generated apidoc docs --- docs/.gitignore | 1 + docs/source/conf.py | 3 +- docs/source/index.rst | 3 +- docs/source/modules.rst | 7 ++ docs/source/neuralmonkey.config.rst | 54 ++++++++ docs/source/neuralmonkey.decoders.decoder.rst | 9 +- docs/source/neuralmonkey.decoders.rst | 38 ++++++ docs/source/neuralmonkey.encoders.rst | 38 ++++++ docs/source/neuralmonkey.evaluators.rst | 54 ++++++++ docs/source/neuralmonkey.nn.rst | 54 ++++++++ docs/source/neuralmonkey.processors.rst | 38 ++++++ docs/source/neuralmonkey.readers.rst | 38 ++++++ docs/source/neuralmonkey.rst | 118 ++++++++++++++++++ docs/source/neuralmonkey.runners.rst | 46 +++++++ docs/source/neuralmonkey.tests.rst | 46 +++++++ docs/source/neuralmonkey.trainers.rst | 38 ++++++ 16 files changed, 580 insertions(+), 5 deletions(-) create mode 100644 docs/.gitignore create mode 100644 docs/source/modules.rst create mode 100644 docs/source/neuralmonkey.config.rst create mode 100644 docs/source/neuralmonkey.decoders.rst create mode 100644 docs/source/neuralmonkey.encoders.rst create mode 100644 docs/source/neuralmonkey.evaluators.rst create mode 100644 docs/source/neuralmonkey.nn.rst create mode 100644 docs/source/neuralmonkey.processors.rst create mode 100644 docs/source/neuralmonkey.readers.rst create mode 100644 docs/source/neuralmonkey.rst create mode 100644 docs/source/neuralmonkey.runners.rst create mode 100644 docs/source/neuralmonkey.tests.rst create mode 100644 docs/source/neuralmonkey.trainers.rst diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 000000000..c795b054e --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +build \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index 279e57f42..f2d7e071e 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -18,7 +18,7 @@ # 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. -#sys.path.insert(0, os.path.abspath('.')) +sys.path.insert(0, os.path.abspath('../..')) # -- General configuration ------------------------------------------------ @@ -30,6 +30,7 @@ # ones. extensions = [ 'sphinx.ext.autodoc', + 'sphinx.ext.napoleon', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.pngmath', diff --git a/docs/source/index.rst b/docs/source/index.rst index 66f9361b7..b734fbca6 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -17,5 +17,4 @@ Welcome to Neural Monkey's documentation! **Sub-modules** -.. toctree:: - neuralmonkey.decoders.decoder +.. toctree:: modules diff --git a/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 000000000..8894f0124 --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,7 @@ +neuralmonkey +============ + +.. toctree:: + :maxdepth: 4 + + neuralmonkey diff --git a/docs/source/neuralmonkey.config.rst b/docs/source/neuralmonkey.config.rst new file mode 100644 index 000000000..b692a4e1a --- /dev/null +++ b/docs/source/neuralmonkey.config.rst @@ -0,0 +1,54 @@ +neuralmonkey.config package +=========================== + +Submodules +---------- + +neuralmonkey.config.config_loader module +---------------------------------------- + +.. automodule:: neuralmonkey.config.config_loader + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.config.configuration module +---------------------------------------- + +.. automodule:: neuralmonkey.config.configuration + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.config.exceptions module +------------------------------------- + +.. automodule:: neuralmonkey.config.exceptions + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.config.parsing module +---------------------------------- + +.. automodule:: neuralmonkey.config.parsing + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.config.utils module +-------------------------------- + +.. automodule:: neuralmonkey.config.utils + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: neuralmonkey.config + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/neuralmonkey.decoders.decoder.rst b/docs/source/neuralmonkey.decoders.decoder.rst index 413279b5d..85a20700a 100644 --- a/docs/source/neuralmonkey.decoders.decoder.rst +++ b/docs/source/neuralmonkey.decoders.decoder.rst @@ -1,5 +1,10 @@ -``neuralmonkey.decoders.decoder`` Module +Module ``neuralmonkey.decoders.decoder`` ======================================== +The main decoder module. + .. automodule:: neuralmonkey.decoders.decoder - :members: + :members: + :private-members: + :special-members: __init__ + :undoc-members: diff --git a/docs/source/neuralmonkey.decoders.rst b/docs/source/neuralmonkey.decoders.rst new file mode 100644 index 000000000..28a4e3250 --- /dev/null +++ b/docs/source/neuralmonkey.decoders.rst @@ -0,0 +1,38 @@ +neuralmonkey.decoders package +============================= + +Submodules +---------- + +neuralmonkey.decoders.decoder module +------------------------------------ + +.. automodule:: neuralmonkey.decoders.decoder + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.decoders.monster_decoder module +-------------------------------------------- + +.. automodule:: neuralmonkey.decoders.monster_decoder + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.decoders.sequence_classifier module +------------------------------------------------ + +.. automodule:: neuralmonkey.decoders.sequence_classifier + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: neuralmonkey.decoders + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/neuralmonkey.encoders.rst b/docs/source/neuralmonkey.encoders.rst new file mode 100644 index 000000000..3f23c1800 --- /dev/null +++ b/docs/source/neuralmonkey.encoders.rst @@ -0,0 +1,38 @@ +neuralmonkey.encoders package +============================= + +Submodules +---------- + +neuralmonkey.encoders.cnn_encoder module +---------------------------------------- + +.. automodule:: neuralmonkey.encoders.cnn_encoder + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.encoders.image_encoder module +------------------------------------------ + +.. automodule:: neuralmonkey.encoders.image_encoder + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.encoders.sentence_encoder module +--------------------------------------------- + +.. automodule:: neuralmonkey.encoders.sentence_encoder + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: neuralmonkey.encoders + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/neuralmonkey.evaluators.rst b/docs/source/neuralmonkey.evaluators.rst new file mode 100644 index 000000000..312b6b83b --- /dev/null +++ b/docs/source/neuralmonkey.evaluators.rst @@ -0,0 +1,54 @@ +neuralmonkey.evaluators package +=============================== + +Submodules +---------- + +neuralmonkey.evaluators.accuracy module +--------------------------------------- + +.. automodule:: neuralmonkey.evaluators.accuracy + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.evaluators.bleu module +----------------------------------- + +.. automodule:: neuralmonkey.evaluators.bleu + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.evaluators.bleu_ref module +--------------------------------------- + +.. automodule:: neuralmonkey.evaluators.bleu_ref + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.evaluators.edit_distance module +-------------------------------------------- + +.. automodule:: neuralmonkey.evaluators.edit_distance + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.evaluators.perplexity module +----------------------------------------- + +.. automodule:: neuralmonkey.evaluators.perplexity + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: neuralmonkey.evaluators + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/neuralmonkey.nn.rst b/docs/source/neuralmonkey.nn.rst new file mode 100644 index 000000000..b2cff3e10 --- /dev/null +++ b/docs/source/neuralmonkey.nn.rst @@ -0,0 +1,54 @@ +neuralmonkey.nn package +======================= + +Submodules +---------- + +neuralmonkey.nn.bidirectional_rnn_layer module +---------------------------------------------- + +.. automodule:: neuralmonkey.nn.bidirectional_rnn_layer + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.nn.mlp module +-------------------------- + +.. automodule:: neuralmonkey.nn.mlp + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.nn.noisy_gru_cell module +------------------------------------- + +.. automodule:: neuralmonkey.nn.noisy_gru_cell + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.nn.pervasive_dropout_wrapper module +------------------------------------------------ + +.. automodule:: neuralmonkey.nn.pervasive_dropout_wrapper + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.nn.projection module +--------------------------------- + +.. automodule:: neuralmonkey.nn.projection + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: neuralmonkey.nn + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/neuralmonkey.processors.rst b/docs/source/neuralmonkey.processors.rst new file mode 100644 index 000000000..d973ed48e --- /dev/null +++ b/docs/source/neuralmonkey.processors.rst @@ -0,0 +1,38 @@ +neuralmonkey.processors package +=============================== + +Submodules +---------- + +neuralmonkey.processors.bpe module +---------------------------------- + +.. automodule:: neuralmonkey.processors.bpe + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.processors.german module +------------------------------------- + +.. automodule:: neuralmonkey.processors.german + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.processors.helpers module +-------------------------------------- + +.. automodule:: neuralmonkey.processors.helpers + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: neuralmonkey.processors + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/neuralmonkey.readers.rst b/docs/source/neuralmonkey.readers.rst new file mode 100644 index 000000000..dfc25666f --- /dev/null +++ b/docs/source/neuralmonkey.readers.rst @@ -0,0 +1,38 @@ +neuralmonkey.readers package +============================ + +Submodules +---------- + +neuralmonkey.readers.gzip_reader module +--------------------------------------- + +.. automodule:: neuralmonkey.readers.gzip_reader + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.readers.multi_file_reader module +--------------------------------------------- + +.. automodule:: neuralmonkey.readers.multi_file_reader + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.readers.plain_text_reader module +--------------------------------------------- + +.. automodule:: neuralmonkey.readers.plain_text_reader + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: neuralmonkey.readers + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/neuralmonkey.rst b/docs/source/neuralmonkey.rst new file mode 100644 index 000000000..9364dd060 --- /dev/null +++ b/docs/source/neuralmonkey.rst @@ -0,0 +1,118 @@ +neuralmonkey package +==================== + +Subpackages +----------- + +.. toctree:: + + neuralmonkey.config + neuralmonkey.decoders + neuralmonkey.encoders + neuralmonkey.evaluators + neuralmonkey.nn + neuralmonkey.processors + neuralmonkey.readers + neuralmonkey.runners + neuralmonkey.tests + neuralmonkey.trainers + +Submodules +---------- + +neuralmonkey.checking module +---------------------------- + +.. automodule:: neuralmonkey.checking + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.dataset module +--------------------------- + +.. automodule:: neuralmonkey.dataset + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.decoding_function module +------------------------------------- + +.. automodule:: neuralmonkey.decoding_function + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.image_utils module +------------------------------- + +.. automodule:: neuralmonkey.image_utils + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.lazy_dataset module +-------------------------------- + +.. automodule:: neuralmonkey.lazy_dataset + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.learning_utils module +---------------------------------- + +.. automodule:: neuralmonkey.learning_utils + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.logging module +--------------------------- + +.. automodule:: neuralmonkey.logging + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.run module +----------------------- + +.. automodule:: neuralmonkey.run + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.server module +-------------------------- + +.. automodule:: neuralmonkey.server + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.train module +------------------------- + +.. automodule:: neuralmonkey.train + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.vocabulary module +------------------------------ + +.. automodule:: neuralmonkey.vocabulary + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: neuralmonkey + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/neuralmonkey.runners.rst b/docs/source/neuralmonkey.runners.rst new file mode 100644 index 000000000..b90576ff1 --- /dev/null +++ b/docs/source/neuralmonkey.runners.rst @@ -0,0 +1,46 @@ +neuralmonkey.runners package +============================ + +Submodules +---------- + +neuralmonkey.runners.beam_search_runner module +---------------------------------------------- + +.. automodule:: neuralmonkey.runners.beam_search_runner + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.runners.copy_net_runner module +------------------------------------------- + +.. automodule:: neuralmonkey.runners.copy_net_runner + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.runners.perplexity_runner module +--------------------------------------------- + +.. automodule:: neuralmonkey.runners.perplexity_runner + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.runners.runner module +---------------------------------- + +.. automodule:: neuralmonkey.runners.runner + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: neuralmonkey.runners + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/neuralmonkey.tests.rst b/docs/source/neuralmonkey.tests.rst new file mode 100644 index 000000000..3a920ec9b --- /dev/null +++ b/docs/source/neuralmonkey.tests.rst @@ -0,0 +1,46 @@ +neuralmonkey.tests package +========================== + +Submodules +---------- + +neuralmonkey.tests.test_bleu module +----------------------------------- + +.. automodule:: neuralmonkey.tests.test_bleu + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.tests.test_config module +------------------------------------- + +.. automodule:: neuralmonkey.tests.test_config + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.tests.test_decoder module +-------------------------------------- + +.. automodule:: neuralmonkey.tests.test_decoder + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.tests.test_vocabulary module +----------------------------------------- + +.. automodule:: neuralmonkey.tests.test_vocabulary + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: neuralmonkey.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/neuralmonkey.trainers.rst b/docs/source/neuralmonkey.trainers.rst new file mode 100644 index 000000000..56d34afb4 --- /dev/null +++ b/docs/source/neuralmonkey.trainers.rst @@ -0,0 +1,38 @@ +neuralmonkey.trainers package +============================= + +Submodules +---------- + +neuralmonkey.trainers.copy_net_trainer module +--------------------------------------------- + +.. automodule:: neuralmonkey.trainers.copy_net_trainer + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.trainers.cross_entropy_trainer module +-------------------------------------------------- + +.. automodule:: neuralmonkey.trainers.cross_entropy_trainer + :members: + :undoc-members: + :show-inheritance: + +neuralmonkey.trainers.mixer module +---------------------------------- + +.. automodule:: neuralmonkey.trainers.mixer + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: neuralmonkey.trainers + :members: + :undoc-members: + :show-inheritance: