doc fixes (#488)

neulab · Jul 30, 2018 · 623c961 · 623c961
1 parent b74fd36
commit 623c961
Show file tree

Hide file tree

Showing 10 changed files with 45 additions and 53 deletions.
diff --git a/docs/api_doc.rst b/docs/api_doc.rst
@@ -6,12 +6,8 @@ API Doc
 Experiment
 ----------
 
-.. automodule:: xnmt.experiment
-   :members:
-   :show-inheritance:
-
-.. _mod-exp_global:
-.. automodule:: xnmt.exp_global
+.. _mod-experiments:
+.. automodule:: xnmt.experiments
    :members:
    :show-inheritance:
 
@@ -28,28 +24,28 @@ Model Base Classes
 Translator
 ~~~~~~~~~~
 
-.. automodule:: xnmt.translator
+.. automodule:: xnmt.translators
    :members:
    :show-inheritance:
 
 Embedder
 ~~~~~~~~
 
-.. automodule:: xnmt.embedder
+.. automodule:: xnmt.embedders
    :members:
    :show-inheritance:
 
 Transducer
 ~~~~~~~~~~
 
-.. automodule:: xnmt.transducer
+.. automodule:: xnmt.transducers
    :members:
    :show-inheritance:
 
 RNN
 ~~~
 
-.. automodule:: xnmt.lstm
+.. automodule:: xnmt.recurrent_transducers
    :members:
    :show-inheritance:
 
@@ -64,46 +60,46 @@ RNN
 Attender
 ~~~~~~~~
 
-.. automodule:: xnmt.attender
+.. automodule:: xnmt.attenders
    :members:
    :show-inheritance:
 
 
 Decoder
 ~~~~~~~
 
-.. automodule:: xnmt.decoder
+.. automodule:: xnmt.decoders
    :members:
    :show-inheritance:
 
 
 Bridge
 ~~~~~~
-.. automodule:: xnmt.bridge
+.. automodule:: xnmt.bridges
    :members:
    :show-inheritance:
 
 Transform
 ~~~~~~~~~
-.. automodule:: xnmt.transform
+.. automodule:: xnmt.transforms
    :members:
    :show-inheritance:
 
 Scorer
 ~~~~~~
-.. automodule:: xnmt.scorer
+.. automodule:: xnmt.scorers
    :members:
    :show-inheritance:
 
 SequenceLabeler
 ~~~~~~~~~~~~~~~
-.. automodule:: xnmt.seq_labeler
+.. automodule:: xnmt.sequence_labelers
    :members:
    :show-inheritance:
 
 Classifier
 ~~~~~~~~~~
-.. automodule:: xnmt.classifier
+.. automodule:: xnmt.classifiers
    :members:
    :show-inheritance:
 
@@ -115,14 +111,14 @@ Loss
 Loss
 ~~~~
 
-.. automodule:: xnmt.loss
+.. automodule:: xnmt.losses
    :members:
    :show-inheritance:
 
 LossCalculator
 ~~~~~~~~~~~~~~
 
-.. automodule:: xnmt.loss_calculator
+.. automodule:: xnmt.loss_calculators
    :members:
    :show-inheritance:
 
@@ -131,13 +127,13 @@ Training
 
 TrainingRegimen
 ~~~~~~~~~~~~~~~
-.. automodule:: xnmt.training_regimen
+.. automodule:: xnmt.training_regimens
    :members:
    :show-inheritance:
 
 TrainingTask
 ~~~~~~~~~~~~
-.. automodule:: xnmt.training_task
+.. automodule:: xnmt.training_tasks
    :members:
    :show-inheritance:
 
@@ -146,21 +142,21 @@ Parameters
 
 ParamManager
 ~~~~~~~~~~~~
-.. automodule:: xnmt.param_collection
+.. automodule:: xnmt.param_collections
    :members:
    :show-inheritance:
 
 
 Optimizer
 ~~~~~~~~~
 
-.. automodule:: xnmt.optimizer
+.. automodule:: xnmt.optimizers
    :members:
    :show-inheritance:
 
 ParamInitializer
 ~~~~~~~~~~~~~~~~
-.. automodule:: xnmt.param_init
+.. automodule:: xnmt.param_initializers
    :members:
    :show-inheritance:
 
@@ -171,21 +167,21 @@ Inference
 AutoRegressiveInference
 ~~~~~~~~~~~~~~~~~~~~~~~
 
-.. automodule:: xnmt.inference
+.. automodule:: xnmt.inferences
    :members:
    :show-inheritance:
 
 SearchStrategy
 ~~~~~~~~~~~~~~
 
-.. automodule:: xnmt.search_strategy
+.. automodule:: xnmt.search_strategies
    :members:
    :show-inheritance:
 
 LengthNormalization
 ~~~~~~~~~~~~~~~~~~~
 
-.. automodule:: xnmt.length_normalization
+.. automodule:: xnmt.length_norm
    :members:
    :show-inheritance:
 
@@ -194,14 +190,14 @@ Evaluation
 
 EvalTasks
 ~~~~~~~~~
-.. automodule:: xnmt.eval_task
+.. automodule:: xnmt.eval_tasks
    :members:
    :show-inheritance:
 
-EvalScore / Evaluator
+Eval Metrics
 ~~~~~~~~~~~~~~~~~~~~~
 
-.. automodule:: xnmt.evaluator
+.. automodule:: xnmt.eval_metrics
    :members:
    :show-inheritance:
 
@@ -220,32 +216,28 @@ Input
 InputReader
 ~~~~~~~~~~~
 
-.. automodule:: xnmt.input_reader
+.. automodule:: xnmt.input_readers
    :members:
    :show-inheritance:
 
 Vocab
 ~~~~~
 
-.. automodule:: xnmt.vocab
+.. automodule:: xnmt.vocabs
    :members:
    :show-inheritance:
 
 Batcher
 ~~~~~~~
 
-.. automodule:: xnmt.batcher
+.. automodule:: xnmt.batchers
    :members:
    :show-inheritance:
 
 
 Preprocessing
 ~~~~~~~~~~~~~
 
-.. automodule:: xnmt.preproc_runner
-   :members:
-   :show-inheritance:
-
 .. automodule:: xnmt.preproc
    :members:
    :show-inheritance:

diff --git a/docs/experiment_config_files.rst b/docs/experiment_config_files.rst
@@ -55,7 +55,7 @@ by the directory the config file lies in, ``{PID}`` by the process id, and
 ``{GIT_REV}`` by the current git revision.
 
 To obtain a full list of allowed parameters, please check the documentation for
-:ref:`ExpGlobal <mod-exp_global>`.
+:ref:`ExpGlobal <mod-experiments>`.
 
 Preprocessing
 =============

diff --git a/examples/09_programmatic.py b/examples/09_programmatic.py
@@ -25,7 +25,7 @@
 from xnmt.embedders import SimpleWordEmbedder
 from xnmt.eval_tasks import LossEvalTask, AccuracyEvalTask
 from xnmt.experiments import Experiment
-from xnmt.infererences import AutoRegressiveInference
+from xnmt.inferences import AutoRegressiveInference
 from xnmt.input_readers import PlainTextReader
 from xnmt.recurrent_transducers import BiLSTMSeqTransducer, UniLSTMSeqTransducer
 from xnmt.transforms import AuxNonLinear

diff --git a/xnmt/__init__.py b/xnmt/__init__.py
@@ -31,7 +31,7 @@
 import xnmt.eval_metrics
 import xnmt.experiments
 import xnmt.hyper_params
-import xnmt.infererences
+import xnmt.inferences
 import xnmt.input_readers
 import xnmt.language_models
 import xnmt.recurrent_transducers

diff --git a/xnmt/classifiers.py b/xnmt/classifiers.py
@@ -1,6 +1,6 @@
 import numpy as np
 
-from xnmt import batchers, embedders, infererences, input_readers, losses, recurrent_transducers, model_base, scorers, \
+from xnmt import batchers, embedders, inferences, input_readers, losses, recurrent_transducers, model_base, scorers, \
   sent, transducers, transforms
 from xnmt.persistence import serializable_init, Serializable, bare
 
@@ -28,7 +28,7 @@ def __init__(self,
                trg_reader: input_readers.InputReader,
                src_embedder: embedders.Embedder = bare(embedders.SimpleWordEmbedder),
                encoder: transducers.SeqTransducer = bare(recurrent_transducers.BiLSTMSeqTransducer),
-               inference=bare(infererences.IndependentOutputInference),
+               inference=bare(inferences.IndependentOutputInference),
                transform: transforms.Transform = bare(transforms.NonLinear),
                scorer: scorers.Scorer = bare(scorers.Softmax)):
     super().__init__(src_reader=src_reader, trg_reader=trg_reader)

diff --git a/xnmt/eval_tasks.py b/xnmt/eval_tasks.py
@@ -5,8 +5,8 @@
 import dynet as dy
 
 from xnmt.batchers import Batcher
-from xnmt.eval_metrics import Evaluator
-from xnmt import infererences, input_readers, model_base
+from xnmt.eval_metrics import Evaluator, EvalScore
+from xnmt import inferences, input_readers, model_base
 from xnmt.persistence import serializable_init, Serializable, Ref, bare
 from xnmt.loss_calculators import LossCalculator, AutoRegressiveMLELoss
 from xnmt.eval_metrics import LossScore
@@ -117,7 +117,7 @@ class AccuracyEvalTask(EvalTask, reports.Reportable, Serializable):
   @events.register_xnmt_handler
   def __init__(self, src_file: Union[str,Sequence[str]], ref_file: Union[str,Sequence[str]], hyp_file: str,
                model: 'model_base.GeneratorModel' = Ref("model"), eval_metrics: Union[str, Sequence[Evaluator]] = "bleu",
-               inference: Optional['infererences.Inference'] = None, desc: Any = None):
+               inference: Optional['inferences.Inference'] = None, desc: Any = None):
     self.model = model
     if isinstance(eval_metrics, str):
       eval_metrics = [xnmt.xnmt_evaluate.eval_shortcuts[shortcut]() for shortcut in eval_metrics.split(",")]
@@ -156,7 +156,7 @@ class DecodingEvalTask(EvalTask, Serializable):
 
   @serializable_init
   def __init__(self, src_file: Union[str,Sequence[str]], hyp_file: str, model: 'model_base.GeneratorModel' = Ref("model"),
-               inference: Optional['infererences.Inference'] = None):
+               inference: Optional['inferences.Inference'] = None):
 
     self.model = model
     self.src_file = src_file

diff --git a/xnmt/infererences.py → xnmt/inferences.py b/xnmt/infererences.py → xnmt/inferences.py
diff --git a/xnmt/sequence_labelers.py b/xnmt/sequence_labelers.py
@@ -1,7 +1,7 @@
 import dynet as dy
 import numpy as np
 
-from xnmt import attenders, batchers, embedders, events, infererences, input_readers, losses, recurrent_transducers, \
+from xnmt import attenders, batchers, embedders, events, inferences, input_readers, losses, recurrent_transducers, \
   model_base, reports, scorers, sent, transducers, transforms, vocabs
 from xnmt.persistence import serializable_init, Serializable, bare
 
@@ -33,7 +33,7 @@ def __init__(self,
                encoder:transducers.SeqTransducer=bare(recurrent_transducers.BiLSTMSeqTransducer),
                transform:transforms.Transform=bare(transforms.NonLinear),
                scorer:scorers.Scorer=bare(scorers.Softmax),
-               inference:infererences.Inference=bare(infererences.IndependentOutputInference),
+               inference:inferences.Inference=bare(inferences.IndependentOutputInference),
                auto_cut_pad:bool=False):
     super().__init__(src_reader=src_reader, trg_reader=trg_reader)
     self.src_embedder = src_embedder

diff --git a/xnmt/translators.py b/xnmt/translators.py
@@ -11,7 +11,7 @@
 from xnmt.decoders import Decoder, AutoRegressiveDecoder, AutoRegressiveDecoderState
 from xnmt.embedders import Embedder, SimpleWordEmbedder
 from xnmt.events import register_xnmt_handler
-from xnmt import infererences, input_readers, model_base
+from xnmt import inferences, input_readers, model_base
 from xnmt import sent
 from xnmt.losses import FactoredLossExpr
 from xnmt.loss_calculators import LossCalculator
@@ -101,7 +101,7 @@ def __init__(self,
                attender: Attender=bare(MlpAttender),
                trg_embedder: Embedder=bare(SimpleWordEmbedder),
                decoder: Decoder=bare(AutoRegressiveDecoder),
-               inference: infererences.AutoRegressiveInference=bare(infererences.AutoRegressiveInference),
+               inference: inferences.AutoRegressiveInference=bare(inferences.AutoRegressiveInference),
                search_strategy:SearchStrategy=bare(BeamSearch),
                compute_report:bool = Ref("exp_global.compute_report", default=False),
                global_fertility:int=0):
@@ -417,7 +417,7 @@ class EnsembleTranslator(AutoRegressiveTranslator, Serializable, model_base.Even
 
   @register_xnmt_handler
   @serializable_init
-  def __init__(self, models, src_reader, trg_reader, inference=bare(infererences.AutoRegressiveInference)):
+  def __init__(self, models, src_reader, trg_reader, inference=bare(inferences.AutoRegressiveInference)):
     super().__init__(src_reader=src_reader, trg_reader=trg_reader)
     self.models = models
     self.inference = inference

diff --git a/xnmt/xnmt_evaluate.py b/xnmt/xnmt_evaluate.py
@@ -4,7 +4,7 @@
 
 from xnmt import eval_metrics
 from xnmt import logger
-from xnmt import infererences
+from xnmt import inferences
 
 from xnmt.eval_metrics import *  # import everything so we can parse it with eval()
 
@@ -54,7 +54,7 @@ def xnmt_evaluate(ref_file: Union[str, Sequence[str]], hyp_file: Union[str, Sequ
       ref_corpus = [tuple(ref_corpora[i][j] for i in range(len(ref_file))) for j in range(len(ref_corpora[0]))]
   hyp_corpus = read_data(hyp_file, post_process=hyp_postprocess)
   len_before = len(hyp_corpus)
-  ref_corpus, hyp_corpus = zip(*filter(lambda x: infererences.NO_DECODING_ATTEMPTED not in x[1], zip(ref_corpus, hyp_corpus)))
+  ref_corpus, hyp_corpus = zip(*filter(lambda x: inferences.NO_DECODING_ATTEMPTED not in x[1], zip(ref_corpus, hyp_corpus)))
   if len(ref_corpus) < len_before:
     logger.info(f"> ignoring {len_before - len(ref_corpus)} out of {len_before} test sentences.")