Merge pull request #349 from NVIDIA/fix-doc

Fix of documentation after package reorganization
NVIDIA · Feb 12, 2020 · 233a0fe · 233a0fe
2 parents ee4bf33 + 2316a34
commit 233a0fe
Show file tree

Hide file tree

Showing 11 changed files with 102 additions and 66 deletions.
diff --git a/docs/docs_zh/sources/source/collections/nemo_asr.rst b/docs/docs_zh/sources/source/collections/nemo_asr.rst
@@ -1,17 +1,17 @@
-NeMo_ASR collection
+NeMo ASR collection
 ===================
 
 语音数据处理模块
 ------------------------------
-.. automodule:: nemo_asr.data_layer
+.. automodule:: nemo.collections.asr.data_layer
     :members:
     :undoc-members:
     :show-inheritance:
     :exclude-members: forward
 
 语音识别模块
 ------------------------------------
-.. automodule:: nemo_asr.jasper
+.. automodule:: nemo.collections.asr.jasper
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/docs/docs_zh/sources/source/collections/nemo_nlp.rst b/docs/docs_zh/sources/source/collections/nemo_nlp.rst
@@ -1,76 +1,100 @@
-NeMo_NLP collection
+NeMo NLP collection
 ===================
 
 NLP 数据处理模块
 ---------------------------
-.. automodule:: nemo_nlp.data_layers
+.. automodule:: nemo.collections.nlp.data.datasets
     :members:
     :undoc-members:
     :show-inheritance:
-    :exclude-members: forward
 
 NLP 分词器
 --------------
 
-.. automodule:: nemo_nlp.data.tokenizers.bert_tokenizer
+.. automodule:: nemo.collections.nlp.data.tokenizers.bert_tokenizer
    :members:
    :undoc-members:
    :show-inheritance:
 
-.. automodule:: nemo_nlp.data.tokenizers.char_tokenizer
+.. automodule:: nemo.collections.nlp.data.tokenizers.char_tokenizer
    :members:
    :undoc-members:
    :show-inheritance:
 
-.. automodule:: nemo_nlp.data.tokenizers.gpt2_tokenizer
+.. automodule:: nemo.collections.nlp.data.tokenizers.gpt2_tokenizer
    :members:
    :undoc-members:
    :show-inheritance:
 
-.. automodule:: nemo_nlp.data.tokenizers.spc_tokenizer
+.. automodule:: nemo.collections.nlp.data.tokenizers.sentencepiece_tokenizer
    :members:
    :undoc-members:
    :show-inheritance:
 
-.. automodule:: nemo_nlp.data.tokenizers.tokenizer_spec
+.. automodule:: nemo.collections.nlp.data.tokenizers.tokenizer_spec
    :members:
    :undoc-members:
    :show-inheritance:
 
-.. automodule:: nemo_nlp.data.tokenizers.word_tokenizer
+.. automodule:: nemo.collections.nlp.data.tokenizers.word_tokenizer
    :members:
    :undoc-members:
    :show-inheritance:
 
-.. automodule:: nemo_nlp.data.tokenizers.yttm_tokenizer
+.. automodule:: nemo.collections.nlp.data.tokenizers.youtokentome_tokenizer
    :members:
    :undoc-members:
    :show-inheritance:
 
 NLP 神经模块
 ------------------
 
-.. automodule:: nemo_nlp.modules.classifiers
+
+.. automodule:: nemo.collections.nlp.nm.data_layers
    :members:
    :undoc-members:
    :show-inheritance:
    :exclude-members: forward
 
 
-.. automodule:: nemo_nlp.modules.losses
+.. automodule:: nemo.collections.nlp.nm.losses
    :members:
    :undoc-members:
    :show-inheritance:
    :exclude-members: forward
 
 
-.. automodule:: nemo_nlp.modules.pytorch_utils
+.. automodule:: nemo.collections.nlp.nm.trainables.common.sequence_classification_nm
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :exclude-members: forward
+
+.. automodule:: nemo.collections.nlp.nm.trainables.common.sequence_regression_nm
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :exclude-members: forward
+
+.. automodule:: nemo.collections.nlp.nm.trainables.common.token_classification_nm
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :exclude-members: forward
+
+.. automodule:: nemo.collections.nlp.nm.trainables.common.transformer.transformer_nm
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :exclude-members: forward
+
+.. automodule:: nemo.collections.nlp.nm.trainables.dialogue_state_tracking.state_tracking_trade_nm
    :members:
    :undoc-members:
    :show-inheritance:
    :exclude-members: forward
 
-.. automodule:: nemo_nlp.modules.transformer_nm
+.. automodule:: nemo.collections.nlp.nm.trainables.joint_intent_slot.joint_intent_slot_nm
    :members:
    :undoc-members:
    :show-inheritance:
@@ -79,7 +103,7 @@ NLP 神经模块
 NLP Hugging Face 神经模块
 -------------------------------
 
-.. automodule:: nemo_nlp.huggingface.bert
+.. automodule:: nemo.collections.nlp.nm.trainables.common.huggingface.bert_nm
    :members:
    :undoc-members:
    :show-inheritance:

diff --git a/docs/docs_zh/sources/source/collections/nemo_tts.rst b/docs/docs_zh/sources/source/collections/nemo_tts.rst
@@ -1,25 +1,25 @@
-NeMo_TTS collection
+NeMo TTS collection
 ===================
 
 语音数据处理模块
 ------------------------------
-.. automodule:: nemo_tts.data_layers
+.. automodule:: nemo.collections.tts.data_layers
     :members:
     :undoc-members:
     :show-inheritance:
     :exclude-members: forward
 
 Tacotron 2 模块
 ------------------
-.. automodule:: nemo_tts.tacotron2_modules
+.. automodule:: nemo.collections.tts.tacotron2_modules
     :members:
     :undoc-members:
     :show-inheritance:
     :exclude-members: forward
 
 Waveglow 模块
 ------------------
-.. automodule:: nemo_tts.waveglow_modules
+.. automodule:: nemo.collections.tts.waveglow_modules
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/docs/docs_zh/sources/source/conf.py b/docs/docs_zh/sources/source/conf.py
@@ -25,11 +25,6 @@
 
 sys.path.insert(0, os.path.abspath("."))
 sys.path.insert(0, os.path.abspath("../../../"))
-sys.path.insert(0, os.path.abspath("../../../nemo/nemo"))
-sys.path.insert(0, os.path.abspath("../../../collections"))
-sys.path.insert(0, os.path.abspath("../../../collections/nemo_asr"))
-sys.path.insert(0, os.path.abspath("../../../collections/nemo_nlp"))
-# sys.path.insert(0, os.path.abspath("../../../collections/nemo_lpr"))
 
 # ---- Mocking up the classes. -----
 MOCK_CLASSES = {'Dataset': 'torch.utils.data', 'Module': 'torch.nn'}
@@ -63,6 +58,7 @@ def __getattr__(cls, name):
     'h5py',
     'kaldi_io',
     'transformers',
+    'transformers.tokenization_bert',
 ]
 
 sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)

diff --git a/docs/sources/source/collections/nemo_asr.rst b/docs/sources/source/collections/nemo_asr.rst
@@ -1,17 +1,17 @@
-NeMo_ASR collection
+NeMo ASR collection
 ===================
 
 Speech data processing modules
 ------------------------------
-.. automodule:: nemo_asr.data_layer
+.. automodule:: nemo.collections.asr.data_layer
     :members:
     :undoc-members:
     :show-inheritance:
     :exclude-members: forward
 
 Automatic Speech Recognition modules
 ------------------------------------
-.. automodule:: nemo_asr.jasper
+.. automodule:: nemo.collections.asr.jasper
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/docs/sources/source/collections/nemo_nlp.rst b/docs/sources/source/collections/nemo_nlp.rst
@@ -1,76 +1,99 @@
-NeMo_NLP collection
+NeMo NLP collection
 ===================
 
 NLP data processing modules
 ---------------------------
-.. automodule:: nemo_nlp.data_layers
+.. automodule:: nemo.collections.nlp.data.datasets
     :members:
     :undoc-members:
     :show-inheritance:
-    :exclude-members: forward
 
 NLP Tokenizers
 --------------
 
-.. automodule:: nemo_nlp.data.tokenizers.bert_tokenizer
+.. automodule:: nemo.collections.nlp.data.tokenizers.bert_tokenizer
    :members:
    :undoc-members:
    :show-inheritance:
 
-.. automodule:: nemo_nlp.data.tokenizers.char_tokenizer
+.. automodule:: nemo.collections.nlp.data.tokenizers.char_tokenizer
    :members:
    :undoc-members:
    :show-inheritance:
 
-.. automodule:: nemo_nlp.data.tokenizers.gpt2_tokenizer
+.. automodule:: nemo.collections.nlp.data.tokenizers.gpt2_tokenizer
    :members:
    :undoc-members:
    :show-inheritance:
 
-.. automodule:: nemo_nlp.data.tokenizers.spc_tokenizer
+.. automodule:: nemo.collections.nlp.data.tokenizers.sentencepiece_tokenizer
    :members:
    :undoc-members:
    :show-inheritance:
 
-.. automodule:: nemo_nlp.data.tokenizers.tokenizer_spec
+.. automodule:: nemo.collections.nlp.data.tokenizers.tokenizer_spec
    :members:
    :undoc-members:
    :show-inheritance:
 
-.. automodule:: nemo_nlp.data.tokenizers.word_tokenizer
+.. automodule:: nemo.collections.nlp.data.tokenizers.word_tokenizer
    :members:
    :undoc-members:
    :show-inheritance:
 
-.. automodule:: nemo_nlp.data.tokenizers.yttm_tokenizer
+.. automodule:: nemo.collections.nlp.data.tokenizers.youtokentome_tokenizer
    :members:
    :undoc-members:
    :show-inheritance:
 
 NLP Neural Modules
 ------------------
 
-.. automodule:: nemo_nlp.modules.classifiers
+.. automodule:: nemo.collections.nlp.nm.data_layers
    :members:
    :undoc-members:
    :show-inheritance:
    :exclude-members: forward
 
 
-.. automodule:: nemo_nlp.modules.losses
+.. automodule:: nemo.collections.nlp.nm.losses
    :members:
    :undoc-members:
    :show-inheritance:
    :exclude-members: forward
 
 
-.. automodule:: nemo_nlp.modules.pytorch_utils
+.. automodule:: nemo.collections.nlp.nm.trainables.common.sequence_classification_nm
    :members:
    :undoc-members:
    :show-inheritance:
    :exclude-members: forward
 
-.. automodule:: nemo_nlp.modules.transformer_nm
+.. automodule:: nemo.collections.nlp.nm.trainables.common.sequence_regression_nm
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :exclude-members: forward
+
+.. automodule:: nemo.collections.nlp.nm.trainables.common.token_classification_nm
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :exclude-members: forward
+
+.. automodule:: nemo.collections.nlp.nm.trainables.common.transformer.transformer_nm
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :exclude-members: forward
+
+.. automodule:: nemo.collections.nlp.nm.trainables.dialogue_state_tracking.state_tracking_trade_nm
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :exclude-members: forward
+
+.. automodule:: nemo.collections.nlp.nm.trainables.joint_intent_slot.joint_intent_slot_nm
    :members:
    :undoc-members:
    :show-inheritance:
@@ -79,7 +102,7 @@ NLP Neural Modules
 NLP Hugging Face Neural Modules
 -------------------------------
 
-.. automodule:: nemo_nlp.huggingface.bert
+.. automodule:: nemo.collections.nlp.nm.trainables.common.huggingface.bert_nm
    :members:
    :undoc-members:
    :show-inheritance:

diff --git a/docs/sources/source/collections/nemo_tts.rst b/docs/sources/source/collections/nemo_tts.rst
@@ -1,25 +1,25 @@
-NeMo_TTS collection
+NeMo TTS collection
 ===================
 
 Speech data processing modules
 ------------------------------
-.. automodule:: nemo_tts.data_layers
+.. automodule:: nemo.collections.tts.data_layers
     :members:
     :undoc-members:
     :show-inheritance:
     :exclude-members: forward
 
 Tacotron 2 modules
 ------------------
-.. automodule:: nemo_tts.tacotron2_modules
+.. automodule:: nemo.collections.tts.tacotron2_modules
     :members:
     :undoc-members:
     :show-inheritance:
     :exclude-members: forward
 
 Waveglow modules
 ------------------
-.. automodule:: nemo_tts.waveglow_modules
+.. automodule:: nemo.collections.tts.waveglow_modules
     :members:
     :undoc-members:
     :show-inheritance:

diff --git a/docs/sources/source/conf.py b/docs/sources/source/conf.py
@@ -25,12 +25,6 @@
 
 sys.path.insert(0, os.path.abspath("."))
 sys.path.insert(0, os.path.abspath("../../../"))
-sys.path.insert(0, os.path.abspath("../../../nemo/nemo"))
-sys.path.insert(0, os.path.abspath("../../../collections"))
-sys.path.insert(0, os.path.abspath("../../../collections/nemo_asr"))
-sys.path.insert(0, os.path.abspath("../../../collections/nemo_nlp"))
-sys.path.insert(0, os.path.abspath("../../../collections/nemo_tts"))
-# sys.path.insert(0, os.path.abspath("../../../collections/nemo_lpr"))
 
 # ---- Mocking up the classes. -----
 MOCK_CLASSES = {'Dataset': 'torch.utils.data', 'Module': 'torch.nn'}
@@ -66,6 +60,7 @@ def __getattr__(cls, name):
     'h5py',
     'kaldi_io',
     'transformers',
+    'transformers.tokenization_bert',
 ]
 
 sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)

diff --git a/examples/image/gan.py b/examples/image/gan.py
@@ -44,7 +44,7 @@
     batch_size=batch_size, shuffle=True, train=True, root=args.train_dataset
 )
 
-generator = nemo_simple_gan.SimpleGenerator()
+generator = nemo_simple_gan.SimpleGenerator(batch_size)
 discriminator = nemo_simple_gan.SimpleDiscriminator()
 neg_disc_loss = nemo_simple_gan.DiscriminatorLoss(neg=True)
 disc_loss = nemo_simple_gan.DiscriminatorLoss()