diff --git a/docs/source/index.rst b/docs/source/index.rst index 7f04a9db..05a942bc 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -7,6 +7,7 @@ Contents main.md quickstart.md + install.md CONTRIBUTING.md ref.rst @@ -16,13 +17,13 @@ Contents config_config.md attention_bridges.md - FAQ.md .. toctree:: :caption: Tutorials :maxdepth: 2 prepare_data.md + examples/Translation.md .. toctree:: :caption: Scripts diff --git a/docs/source/mammoth.inputters.rst b/docs/source/mammoth.inputters.rst index b95aae67..751a0876 100644 --- a/docs/source/mammoth.inputters.rst +++ b/docs/source/mammoth.inputters.rst @@ -1,20 +1,28 @@ Data Loaders ================= -Data Readers -------------- +Dataset +------- + +.. autoclass:: mammoth.inputters.dataset.ParallelCorpus + :members: + -.. autoexception:: mammoth.inputters.datareader_base.MissingDependencyException +Data loading +------------ -.. autoclass:: mammoth.inputters.DataReaderBase +.. autoclass:: mammoth.inputters.dataloader.DynamicDatasetIter :members: -.. autoclass:: mammoth.inputters.TextDataReader +.. autoclass:: mammoth.inputters.dataloader.LookAheadBucketing :members: +.. autoclass:: mammoth.inputters.dataloader.InferenceBatcher + :members: -Dataset --------- -.. autoclass:: mammoth.inputters.Dataset +Vocab +----- + +.. autoclass:: mammoth.inputters.vocab.Vocab :members: diff --git a/docs/source/mammoth.modules.rst b/docs/source/mammoth.modules.rst index de33bfd5..ea8c45ab 100644 --- a/docs/source/mammoth.modules.rst +++ b/docs/source/mammoth.modules.rst @@ -1,109 +1,60 @@ Modules ============= -Core Modules ------------- +Embeddings +---------- .. autoclass:: mammoth.modules.Embeddings :members: -Encoders ---------- - -.. autoclass:: mammoth.encoders.EncoderBase - :members: - -.. autoclass:: mammoth.encoders.MeanEncoder - :members: +Attention Bridge +---------------- -.. autoclass:: mammoth.encoders.RNNEncoder +.. autoclass:: mammoth.modules.attention_bridge.AttentionBridge :members: -Decoders ---------- - - -.. autoclass:: mammoth.decoders.DecoderBase - :members: - -.. autoclass:: mammoth.decoders.decoder.RNNDecoderBase - :members: +Encoders +-------- -.. autoclass:: mammoth.decoders.StdRNNDecoder +.. autoclass:: mammoth.modules.encoder.EncoderBase :members: -.. autoclass:: mammoth.decoders.InputFeedRNNDecoder +.. autoclass:: mammoth.modules.transformer_encoder.TransformerEncoder :members: -Attention ----------- - -.. autoclass:: mammoth.modules.AverageAttention +.. autoclass:: mammoth.modules.mean_encoder.MeanEncoder :members: -.. autoclass:: mammoth.modules.GlobalAttention +.. autoclass:: mammoth.modules.layer_stack_encoder.LayerStackEncoder :members: +Decoders +-------- -Architecture: Transformer ----------------------------- - -.. autoclass:: mammoth.modules.PositionalEncoding - :members: - -.. autoclass:: mammoth.modules.position_ffn.PositionwiseFeedForward - :members: - -.. autoclass:: mammoth.encoders.TransformerEncoder +.. autoclass:: mammoth.modules.decoder.DecoderBase :members: -.. autoclass:: mammoth.decoders.TransformerDecoder +.. autoclass:: mammoth.modules.layer_stack_decoder.LayerStackDecoder :members: -.. autoclass:: mammoth.modules.MultiHeadedAttention +.. autoclass:: mammoth.modules.decoder_ensemble.EnsembleModel :members: - :undoc-members: - - -Architecture: Conv2Conv ----------------------------- -(These methods are from a user contribution -and have not been thoroughly tested.) - - -.. autoclass:: mammoth.encoders.CNNEncoder +.. autoclass:: mammoth.modules.transformer_decoder.TransformerDecoder :members: -.. autoclass:: mammoth.decoders.CNNDecoder - :members: - -.. autoclass:: mammoth.modules.ConvMultiStepAttention - :members: +Sublayers +--------- -.. autoclass:: mammoth.modules.WeightNormConv2d +.. autoclass:: mammoth.modules.average_attn.AverageAttention :members: -Architecture: SRU ----------------------------- - -.. autoclass:: mammoth.models.sru.SRU +.. autoclass:: mammoth.modules.multi_headed_attn.MultiHeadedAttention :members: - -Copy Attention --------------- - -.. autoclass:: mammoth.modules.CopyGenerator - :members: - - -Structured Attention -------------------------------------------- - -.. autoclass:: mammoth.modules.structured_attention.MatrixTree +.. autoclass:: mammoth.modules.position_ffn.PositionwiseFeedForward :members: