Read the Docs build information Build id: 550876 Project: nvidia-nemo Version: main Commit: 4c1d7b586fe764894f3468a11369aebc4962fa9f Date: 2021-02-03T21:25:53.714313Z State: finished Success: True [rtd-command-info] start-time: 2021-02-03T21:25:55.691538Z, end-time: 2021-02-03T21:26:01.465561Z, duration: 5, exit-code: 0 git clone --no-single-branch --depth 50 https://github.com/NVIDIA/NeMo.git . Cloning into '.'... [rtd-command-info] start-time: 2021-02-03T21:26:01.943705Z, end-time: 2021-02-03T21:26:02.106752Z, duration: 0, exit-code: 0 git checkout --force origin/main Note: checking out 'origin/main'. You are in 'detached HEAD' state. You can look around, make experimental changes and commit them, and you can discard any commits you make in this state without impacting any branches by performing another checkout. If you want to create a new branch to retain commits you create, you may do so (now or later) by using -b with the checkout command again. Example: git checkout -b HEAD is now at 4c1d7b58 asr data read support kaldi pipeline (#1644) [rtd-command-info] start-time: 2021-02-03T21:26:02.351334Z, end-time: 2021-02-03T21:26:02.406513Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2021-02-03T21:26:03.799478Z, end-time: 2021-02-03T21:26:07.702382Z, duration: 3, exit-code: 0 python3.7 -mvirtualenv Using base prefix '/home/docs/.pyenv/versions/3.7.9' New python executable in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/bin/python3.7 Also creating executable in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/bin/python Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2021-02-03T21:26:07.874000Z, end-time: 2021-02-03T21:26:08.715136Z, duration: 0, exit-code: 0 python -m pip install --upgrade --no-cache-dir pip Requirement already satisfied: pip in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (21.0.1) [rtd-command-info] start-time: 2021-02-03T21:26:08.882888Z, end-time: 2021-02-03T21:26:18.049075Z, duration: 9, exit-code: 0 python -m pip install --upgrade --no-cache-dir setuptools==41.0.1 docutils==0.14 mock==1.0.1 pillow==5.4.1 alabaster>=0.7,<0.8,!=0.7.5 six commonmark==0.8.1 recommonmark==0.5.0 sphinx<2 sphinx-rtd-theme<0.5 readthedocs-sphinx-ext<2.2 Collecting setuptools==41.0.1 Downloading setuptools-41.0.1-py2.py3-none-any.whl (575 kB) Collecting docutils==0.14 Downloading docutils-0.14-py3-none-any.whl (543 kB) Collecting mock==1.0.1 Downloading mock-1.0.1.zip (861 kB) Collecting pillow==5.4.1 Downloading Pillow-5.4.1-cp37-cp37m-manylinux1_x86_64.whl (2.0 MB) Collecting alabaster!=0.7.5,<0.8,>=0.7 Downloading alabaster-0.7.12-py2.py3-none-any.whl (14 kB) Collecting six Downloading six-1.15.0-py2.py3-none-any.whl (10 kB) Collecting commonmark==0.8.1 Downloading commonmark-0.8.1-py2.py3-none-any.whl (47 kB) Collecting recommonmark==0.5.0 Downloading recommonmark-0.5.0-py2.py3-none-any.whl (9.8 kB) Collecting sphinx<2 Downloading Sphinx-1.8.5-py2.py3-none-any.whl (3.1 MB) Collecting sphinx-rtd-theme<0.5 Downloading sphinx_rtd_theme-0.4.3-py2.py3-none-any.whl (6.4 MB) Collecting readthedocs-sphinx-ext<2.2 Downloading readthedocs_sphinx_ext-2.1.3-py2.py3-none-any.whl (11 kB) Collecting future Downloading future-0.18.2.tar.gz (829 kB) Collecting Jinja2>=2.9 Downloading Jinja2-2.11.3-py2.py3-none-any.whl (125 kB) Collecting requests Downloading requests-2.25.1-py2.py3-none-any.whl (61 kB) Collecting babel!=2.0,>=1.3 Downloading Babel-2.9.0-py2.py3-none-any.whl (8.8 MB) Collecting snowballstemmer>=1.1 Downloading snowballstemmer-2.1.0-py2.py3-none-any.whl (93 kB) Collecting imagesize Downloading imagesize-1.2.0-py2.py3-none-any.whl (4.8 kB) Collecting sphinxcontrib-websupport Downloading sphinxcontrib_websupport-1.2.4-py2.py3-none-any.whl (39 kB) Collecting Pygments>=2.0 Downloading Pygments-2.7.4-py3-none-any.whl (950 kB) Collecting packaging Downloading packaging-20.9-py2.py3-none-any.whl (40 kB) Collecting pytz>=2015.7 Downloading pytz-2021.1-py2.py3-none-any.whl (510 kB) Collecting MarkupSafe>=0.23 Downloading MarkupSafe-1.1.1-cp37-cp37m-manylinux2010_x86_64.whl (33 kB) Collecting urllib3<1.27,>=1.21.1 Downloading urllib3-1.26.3-py2.py3-none-any.whl (137 kB) Collecting idna<3,>=2.5 Downloading idna-2.10-py2.py3-none-any.whl (58 kB) Collecting chardet<5,>=3.0.2 Downloading chardet-4.0.0-py2.py3-none-any.whl (178 kB) Collecting certifi>=2017.4.17 Downloading certifi-2020.12.5-py2.py3-none-any.whl (147 kB) Collecting pyparsing>=2.0.2 Downloading pyparsing-2.4.7-py2.py3-none-any.whl (67 kB) Collecting sphinxcontrib-serializinghtml Downloading sphinxcontrib_serializinghtml-1.1.4-py2.py3-none-any.whl (89 kB) Building wheels for collected packages: mock, future Building wheel for mock (setup.py): started Building wheel for mock (setup.py): finished with status 'done' Created wheel for mock: filename=mock-1.0.1-py3-none-any.whl size=23755 sha256=7483ba2d4dafba26f11790e6948e1f408b8f8d5bfdd604cb2131c504286b800c Stored in directory: /tmp/pip-ephem-wheel-cache-5f3ozz4j/wheels/7a/94/b1/0fdc5339a5bd487a5cc15421ec200d9ba3e2aa7190e4a727f1 Building wheel for future (setup.py): started Building wheel for future (setup.py): finished with status 'done' Created wheel for future: filename=future-0.18.2-py3-none-any.whl size=491059 sha256=57415d1a1160bd7932ac4793af5c460121c427579416d51a4b4387e0f0fc1c7c Stored in directory: /tmp/pip-ephem-wheel-cache-5f3ozz4j/wheels/56/b0/fe/4410d17b32f1f0c3cf54cdfb2bc04d7b4b8f4ae377e2229ba0 Successfully built mock future Installing collected packages: urllib3, sphinxcontrib-serializinghtml, pytz, pyparsing, MarkupSafe, idna, chardet, certifi, sphinxcontrib-websupport, snowballstemmer, six, setuptools, requests, Pygments, packaging, Jinja2, imagesize, future, docutils, babel, alabaster, sphinx, commonmark, sphinx-rtd-theme, recommonmark, readthedocs-sphinx-ext, pillow, mock Attempting uninstall: setuptools Found existing installation: setuptools 53.0.0 Uninstalling setuptools-53.0.0: Successfully uninstalled setuptools-53.0.0 Successfully installed Jinja2-2.11.3 MarkupSafe-1.1.1 Pygments-2.7.4 alabaster-0.7.12 babel-2.9.0 certifi-2020.12.5 chardet-4.0.0 commonmark-0.8.1 docutils-0.14 future-0.18.2 idna-2.10 imagesize-1.2.0 mock-1.0.1 packaging-20.9 pillow-5.4.1 pyparsing-2.4.7 pytz-2021.1 readthedocs-sphinx-ext-2.1.3 recommonmark-0.5.0 requests-2.25.1 setuptools-41.0.1 six-1.15.0 snowballstemmer-2.1.0 sphinx-1.8.5 sphinx-rtd-theme-0.4.3 sphinxcontrib-serializinghtml-1.1.4 sphinxcontrib-websupport-1.2.4 urllib3-1.26.3 [rtd-command-info] start-time: 2021-02-03T21:26:18.223303Z, end-time: 2021-02-03T21:26:22.270519Z, duration: 4, exit-code: 0 python -m pip install --exists-action=w --no-cache-dir -r requirements/requirements_docs.txt Collecting latexcodec Downloading latexcodec-2.0.1-py2.py3-none-any.whl (18 kB) Collecting sphinx>=3.0 Downloading Sphinx-3.4.3-py3-none-any.whl (2.9 MB) Requirement already satisfied: sphinx_rtd_theme in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from -r requirements/requirements_docs.txt (line 3)) (0.4.3) Collecting sphinxcontrib-bibtex Downloading sphinxcontrib_bibtex-2.1.4-py3-none-any.whl (17 kB) Collecting wrapt Downloading wrapt-1.12.1.tar.gz (27 kB) Requirement already satisfied: snowballstemmer>=1.1 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from sphinx>=3.0->-r requirements/requirements_docs.txt (line 2)) (2.1.0) Collecting sphinxcontrib-devhelp Downloading sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl (84 kB) Collecting sphinxcontrib-jsmath Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB) Requirement already satisfied: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from sphinx>=3.0->-r requirements/requirements_docs.txt (line 2)) (0.7.12) Requirement already satisfied: babel>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from sphinx>=3.0->-r requirements/requirements_docs.txt (line 2)) (2.9.0) Collecting sphinxcontrib-applehelp Downloading sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl (121 kB) Collecting sphinxcontrib-htmlhelp Downloading sphinxcontrib_htmlhelp-1.0.3-py2.py3-none-any.whl (96 kB) Requirement already satisfied: imagesize in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from sphinx>=3.0->-r requirements/requirements_docs.txt (line 2)) (1.2.0) Requirement already satisfied: packaging in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from sphinx>=3.0->-r requirements/requirements_docs.txt (line 2)) (20.9) Requirement already satisfied: Jinja2>=2.3 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from sphinx>=3.0->-r requirements/requirements_docs.txt (line 2)) (2.11.3) Requirement already satisfied: Pygments>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from sphinx>=3.0->-r requirements/requirements_docs.txt (line 2)) (2.7.4) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from sphinx>=3.0->-r requirements/requirements_docs.txt (line 2)) (41.0.1) Requirement already satisfied: docutils>=0.12 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from sphinx>=3.0->-r requirements/requirements_docs.txt (line 2)) (0.14) Collecting sphinxcontrib-qthelp Downloading sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl (90 kB) Requirement already satisfied: requests>=2.5.0 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from sphinx>=3.0->-r requirements/requirements_docs.txt (line 2)) (2.25.1) Requirement already satisfied: sphinxcontrib-serializinghtml in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from sphinx>=3.0->-r requirements/requirements_docs.txt (line 2)) (1.1.4) Requirement already satisfied: pytz>=2015.7 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from babel>=1.3->sphinx>=3.0->-r requirements/requirements_docs.txt (line 2)) (2021.1) Requirement already satisfied: MarkupSafe>=0.23 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from Jinja2>=2.3->sphinx>=3.0->-r requirements/requirements_docs.txt (line 2)) (1.1.1) Requirement already satisfied: chardet<5,>=3.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from requests>=2.5.0->sphinx>=3.0->-r requirements/requirements_docs.txt (line 2)) (4.0.0) Requirement already satisfied: urllib3<1.27,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from requests>=2.5.0->sphinx>=3.0->-r requirements/requirements_docs.txt (line 2)) (1.26.3) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from requests>=2.5.0->sphinx>=3.0->-r requirements/requirements_docs.txt (line 2)) (2020.12.5) Requirement already satisfied: idna<3,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from requests>=2.5.0->sphinx>=3.0->-r requirements/requirements_docs.txt (line 2)) (2.10) Requirement already satisfied: six>=1.4.1 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from latexcodec->-r requirements/requirements_docs.txt (line 1)) (1.15.0) Collecting pybtex-docutils>=0.2.2 Downloading pybtex_docutils-1.0.0-py3-none-any.whl (4.7 kB) Collecting pybtex>=0.20 Downloading pybtex-0.24.0-py2.py3-none-any.whl (561 kB) Collecting PyYAML>=3.01 Downloading PyYAML-5.4.1-cp37-cp37m-manylinux1_x86_64.whl (636 kB) Requirement already satisfied: pyparsing>=2.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from packaging->sphinx>=3.0->-r requirements/requirements_docs.txt (line 2)) (2.4.7) Building wheels for collected packages: wrapt Building wheel for wrapt (setup.py): started Building wheel for wrapt (setup.py): finished with status 'done' Created wheel for wrapt: filename=wrapt-1.12.1-cp37-cp37m-linux_x86_64.whl size=71029 sha256=4f35b941119c1468b21d16e6eecdaf73205179347a50c1c9598cd1d72c151e80 Stored in directory: /tmp/pip-ephem-wheel-cache-37y9fowq/wheels/62/76/4c/aa25851149f3f6d9785f6c869387ad82b3fd37582fa8147ac6 Successfully built wrapt Installing collected packages: PyYAML, latexcodec, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, pybtex, sphinx, pybtex-docutils, wrapt, sphinxcontrib-bibtex Attempting uninstall: sphinx Found existing installation: Sphinx 1.8.5 Uninstalling Sphinx-1.8.5: Successfully uninstalled Sphinx-1.8.5 Successfully installed PyYAML-5.4.1 latexcodec-2.0.1 pybtex-0.24.0 pybtex-docutils-1.0.0 sphinx-3.4.3 sphinxcontrib-applehelp-1.0.2 sphinxcontrib-bibtex-2.1.4 sphinxcontrib-devhelp-1.0.2 sphinxcontrib-htmlhelp-1.0.3 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.3 wrapt-1.12.1 [rtd-command-info] start-time: 2021-02-03T21:26:23.445681Z, end-time: 2021-02-03T21:26:23.512332Z, duration: 0, exit-code: 0 cat docs/source/conf.py #!/usr/bin/env python3 # -*- coding: utf-8 -*- # Copyright (c) 2020, NVIDIA CORPORATION. All rights reserved. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. import os import sys # 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("../../nemo")) from package_info import __version__ autodoc_mock_imports = [ 'torch', 'torch.nn', 'torch.utils', 'torch.optim', 'torch.utils.data', 'torch.utils.data.sampler', 'torchvision', 'torchvision.models', 'torchtext', 'torch_stft', 'pytorch_lightning', 'h5py', 'kaldi_io', 'transformers', 'transformers.tokenization_bert', 'apex', 'ruamel', 'frozendict', 'inflect', 'unidecode', 'librosa', 'soundfile', 'sentencepiece', 'youtokentome', 'megatron-lm', 'numpy', 'dateutil', 'wget', 'scipy', 'pandas', 'matplotlib', 'sklearn', 'braceexpand', 'webdataset', 'tqdm', 'numba', 'hydra', 'omegaconf', 'onnx', 'editdistance', 'megatron', 'g2p_en', 'pesq', 'pystoi', ] # -- 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.todo", "sphinx.ext.coverage", "sphinx.ext.mathjax", "sphinx.ext.ifconfig", "sphinx.ext.viewcode", "sphinx.ext.napoleon", "sphinx.ext.githubpages", "sphinxcontrib.bibtex", "sphinx.ext.inheritance_diagram", "sphinx.ext.intersphinx", "sphinxcontrib.bibtex", ] bibtex_bibfiles = ['asr/asr_all.bib', 'tts/tts_all.bib'] intersphinx_mapping = { 'pytorch': ('https://pytorch.org/docs/stable', None), 'pytorch-lightning': ('https://pytorch-lightning.readthedocs.io/en/latest/', None), } # Set default flags for all classes. autodoc_default_options = {'members': None, 'undoc-members': None, 'show-inheritance': True} locale_dirs = ['locale/'] # path is example but recommended. gettext_compact = False # optional. # 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" # General information about the project. project = "NVIDIA NeMo" copyright = "2018-, NVIDIA CORPORATION" author = "NVIDIA CORPORATION" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # The short X.Y version. # version = "0.10.0" version = __version__ # The full version, including alpha/beta/rc tags. # release = "0.9.0" release = __version__ # 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 patterns also effect to html_static_path and html_extra_path exclude_patterns = [] # The name of the Pygments (syntax highlighting) style to use. pygments_style = "default" # NVIDIA theme settings. html_theme = 'nvidia_theme' html_theme_path = ["."] html_theme_options = { 'display_version': True, 'project_version': version, 'project_name': project, 'logo_path': None, 'logo_only': True, } html_title = 'Introduction' html_logo = html_theme_options["logo_path"] # -- Options for HTMLHelp output ------------------------------------------ # Output file base name for HTML help builder. htmlhelp_basename = "nemodoc" ########################################################################### # auto-created readthedocs.org specific configuration # ########################################################################### # # The following code was added during an automated build on readthedocs.org # It is auto created and injected for every build. The result is based on the # conf.py.tmpl file found in the readthedocs.org codebase: # https://github.com/rtfd/readthedocs.org/blob/master/readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl # import importlib import sys import os.path from six import string_types from sphinx import version_info # Get suffix for proper linking to GitHub # This is deprecated in Sphinx 1.3+, # as each page can have its own suffix if globals().get('source_suffix', False): if isinstance(source_suffix, string_types): SUFFIX = source_suffix elif isinstance(source_suffix, (list, tuple)): # Sphinx >= 1.3 supports list/tuple to define multiple suffixes SUFFIX = source_suffix[0] elif isinstance(source_suffix, dict): # Sphinx >= 1.8 supports a mapping dictionary for multiple suffixes SUFFIX = list(source_suffix.keys())[0] # make a ``list()`` for py2/py3 compatibility else: # default to .rst SUFFIX = '.rst' else: SUFFIX = '.rst' # Add RTD Static Path. Add to the end because it overwrites previous files. if not 'html_static_path' in globals(): html_static_path = [] if os.path.exists('_static'): html_static_path.append('_static') # Add RTD Theme only if they aren't overriding it already using_rtd_theme = ( ( 'html_theme' in globals() and html_theme in ['default'] and # Allow people to bail with a hack of having an html_style 'html_style' not in globals() ) or 'html_theme' not in globals() ) if using_rtd_theme: theme = importlib.import_module('sphinx_rtd_theme') html_theme = 'sphinx_rtd_theme' html_style = None html_theme_options = {} if 'html_theme_path' in globals(): html_theme_path.append(theme.get_html_theme_path()) else: html_theme_path = [theme.get_html_theme_path()] if globals().get('websupport2_base_url', False): websupport2_base_url = 'https://readthedocs.com/websupport' websupport2_static_url = 'https://assets.readthedocs.com/' #Add project information to the template context. context = { 'using_theme': using_rtd_theme, 'html_theme': html_theme, 'current_version': "main", 'version_slug': "main", 'MEDIA_URL': "https://media.readthedocs.com/media/", 'STATIC_URL': "https://assets.readthedocs.com/", 'PRODUCTION_DOMAIN': "readthedocs.com", 'versions': [ ("stable", "/en/stable/"), ("v1.0.0b1", "/en/v1.0.0b1/"), ("v0.11.1", "/en/v0.11.1/"), ("v0.11.0", "/en/v0.11.0/"), ("v0.10.1", "/en/v0.10.1/"), ("main-vis-res", "/en/main-vis-res/"), ("main", "/en/main/"), ], 'downloads': [ ], 'subprojects': [ ], 'slug': 'nvidia-nemo', 'name': u'NeMo', 'rtd_language': u'en', 'programming_language': u'py', 'canonical_url': 'https://nvidia-nemo.readthedocs-hosted.com/deeplearning/nemo/user-guide/docs/en/master/', 'analytics_code': 'None', 'single_version': False, 'conf_py_path': '/docs/source/', 'api_host': 'https://readthedocs.com', 'github_user': 'NVIDIA', 'proxied_api_host': '/deeplearning/nemo/user-guide/docs/_', 'github_repo': 'NeMo', 'github_version': 'main', 'display_github': True, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': 'main', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': 'main', 'display_gitlab': False, 'READTHEDOCS': True, 'using_theme': (html_theme == "default"), 'new_theme': (html_theme == "sphinx_rtd_theme"), 'source_suffix': SUFFIX, 'ad_free': False, 'docsearch_disabled': False, 'user_analytics_code': '', 'global_analytics_code': 'UA-17997319-2', 'commit': '4c1d7b58', } # For sphinx >=1.8 we can use html_baseurl to set the canonical URL. # https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_baseurl if version_info >= (1, 8): if not globals().get('html_baseurl'): html_baseurl = context['canonical_url'] context['canonical_url'] = None if 'html_context' in globals(): html_context.update(context) else: html_context = context # Add custom RTD extension if 'extensions' in globals(): # Insert at the beginning because it can interfere # with other extensions. # See https://github.com/rtfd/readthedocs.org/pull/4054 extensions.insert(0, "readthedocs_ext.readthedocs") else: extensions = ["readthedocs_ext.readthedocs"] # Add External version warning banner to the external version documentation if 'branch' == 'external': extensions.insert(1, "readthedocs_ext.external_version_warning") readthedocs_vcs_url = 'None' readthedocs_build_url = 'https://readthedocs.com/projects/nvidia-nemo/builds/550876/' project_language = 'en' # User's Sphinx configurations language_user = globals().get('language', None) latex_engine_user = globals().get('latex_engine', None) latex_elements_user = globals().get('latex_elements', None) # Remove this once xindy gets installed in Docker image and XINDYOPS # env variable is supported # https://github.com/rtfd/readthedocs-docker-images/pull/98 latex_use_xindy = False chinese = any([ language_user in ('zh_CN', 'zh_TW'), project_language in ('zh_CN', 'zh_TW'), ]) japanese = any([ language_user == 'ja', project_language == 'ja', ]) if chinese: latex_engine = latex_engine_user or 'xelatex' latex_elements_rtd = { 'preamble': '\\usepackage[UTF8]{ctex}\n', } latex_elements = latex_elements_user or latex_elements_rtd elif japanese: latex_engine = latex_engine_user or 'platex' # Make sure our build directory is always excluded exclude_patterns = globals().get('exclude_patterns', []) exclude_patterns.extend(['_build']) [rtd-command-info] start-time: 2021-02-03T21:26:23.622890Z, end-time: 2021-02-03T21:26:27.071019Z, duration: 3, exit-code: 0 python -m sphinx -T -E -b readthedocs -d _build/doctrees-readthedocs -D language=en . _build/html Running Sphinx v3.4.3 loading translations [en]... done making output directory... done checking for /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/main/docs/source/asr/asr_all.bib in bibtex cache... not found parsing bibtex file /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/main/docs/source/asr/asr_all.bib... parsed 101 entries checking for /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/main/docs/source/tts/tts_all.bib in bibtex cache... not found parsing bibtex file /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/main/docs/source/tts/tts_all.bib... parsed 5 entries loading intersphinx inventory from https://pytorch.org/docs/stable/objects.inv... loading intersphinx inventory from https://pytorch-lightning.readthedocs.io/en/latest/objects.inv... building [mo]: targets for 0 po files that are out of date building [readthedocs]: targets for 16 source files that are out of date updating environment: [new config] 16 added, 0 changed, 0 removed reading sources... [ 6%] api-docs/nemo reading sources... [ 12%] asr/api [NeMo W 2021-02-03 21:26:24 experimental:28] Module is experimental, not ready for production and is not fully supported. Use at your own risk. [NeMo W 2021-02-03 21:26:24 experimental:28] Module is experimental, not ready for production and is not fully supported. Use at your own risk. [NeMo W 2021-02-03 21:26:24 experimental:28] Module is experimental, not ready for production and is not fully supported. Use at your own risk. [NeMo W 2021-02-03 21:26:24 experimental:28] Module is experimental, not ready for production and is not fully supported. Use at your own risk. reading sources... [ 18%] asr/datasets reading sources... [ 25%] asr/intro reading sources... [ 31%] asr/models reading sources... [ 37%] common/intro reading sources... [ 43%] core reading sources... [ 50%] cv/intro [NeMo W 2021-02-03 21:26:25 experimental:28] Module is experimental, not ready for production and is not fully supported. Use at your own risk. [NeMo W 2021-02-03 21:26:25 experimental:28] Module is experimental, not ready for production and is not fully supported. Use at your own risk. reading sources... [ 56%] index reading sources... [ 62%] nlp/api reading sources... [ 68%] nlp/intro reading sources... [ 75%] nlp/models reading sources... [ 81%] tts/base reading sources... [ 87%] tts/intro reading sources... [ 93%] tts/model_API reading sources... [100%] tts/models /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/main/nemo/core/classes/modelPT.py:docstring of nemo.core.classes.modelPT.ModelPT.extract_state_dict_from:5: WARNING: Unexpected indentation. /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/main/nemo/core/classes/modelPT.py:docstring of nemo.core.classes.modelPT.ModelPT.extract_state_dict_from:23: WARNING: Unexpected indentation. /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/main/nemo/core/classes/modelPT.py:docstring of nemo.core.classes.modelPT.ModelPT.extract_state_dict_from:20: WARNING: Inline literal start-string without end-string. /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/main/nemo/core/classes/modelPT.py:docstring of nemo.core.classes.modelPT.ModelPT.extract_state_dict_from:24: WARNING: Block quote ends without a blank line; unexpected unindent. /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/main/nemo/core/classes/modelPT.py:docstring of nemo.core.classes.modelPT.ModelPT.extract_state_dict_from:24: WARNING: Inline literal start-string without end-string. /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/main/nemo/core/classes/modelPT.py:docstring of nemo.core.classes.modelPT.ModelPT.extract_state_dict_from:24: WARNING: Inline interpreted text or phrase reference start-string without end-string. /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/main/nemo/core/classes/modelPT.py:docstring of nemo.core.classes.modelPT.ModelPT.extract_state_dict_from:26: WARNING: Inline literal start-string without end-string. /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/main/nemo/core/classes/modelPT.py:docstring of nemo.core.classes.modelPT.ModelPT.extract_state_dict_from:30: WARNING: Inline literal start-string without end-string. /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/main/nemo/core/classes/modelPT.py:docstring of nemo.core.classes.modelPT.ModelPT.extract_state_dict_from:30: WARNING: Inline interpreted text or phrase reference start-string without end-string. /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/main/nemo/core/classes/modelPT.py:docstring of nemo.core.classes.modelPT.ModelPT.prepare_test:7: WARNING: Unexpected indentation. /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/main/nemo/core/neural_types/neural_type.py:docstring of nemo.core.neural_types.neural_type.NeuralType:4: WARNING: Unexpected indentation. /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/main/nemo/core/neural_types/neural_type.py:docstring of nemo.core.neural_types.neural_type.NeuralType:7: WARNING: Block quote ends without a blank line; unexpected unindent. WARNING: autodoc: failed to import class 'asr.models.EncDecCTCModel' from module 'nemo.collections'; the following exception was raised: No module named 'kaldiio' WARNING: autodoc: failed to import class 'asr.models.EncDecClassificationModel' from module 'nemo.collections'; the following exception was raised: No module named 'kaldiio' WARNING: autodoc: failed to import class 'asr.models.EncDecSpeakerLabelModel' from module 'nemo.collections'; the following exception was raised: No module named 'kaldiio' WARNING: autodoc: failed to import class 'asr.modules.ConvASREncoder' from module 'nemo.collections'; the following exception was raised: No module named 'kaldiio' WARNING: autodoc: failed to import class 'asr.modules.ConvASRDecoder' from module 'nemo.collections'; the following exception was raised: No module named 'kaldiio' WARNING: autodoc: failed to import class 'nlp.models.GLUEModel' from module 'nemo.collections'; the following exception was raised: No module named 'rapidfuzz' WARNING: autodoc: failed to import class 'nlp.models.PunctuationCapitalizationModel' from module 'nemo.collections'; the following exception was raised: No module named 'rapidfuzz' WARNING: autodoc: failed to import class 'nlp.models.TokenClassificationModel' from module 'nemo.collections'; the following exception was raised: No module named 'rapidfuzz' WARNING: autodoc: failed to import class 'nlp.modules.BertModule' from module 'nemo.collections'; the following exception was raised: No module named 'rapidfuzz' WARNING: autodoc: failed to import class 'nlp.modules.MegatronBertEncoder' from module 'nemo.collections'; the following exception was raised: No module named 'rapidfuzz' WARNING: autodoc: failed to import class 'nlp.modules.AlbertEncoder' from module 'nemo.collections'; the following exception was raised: No module named 'rapidfuzz' WARNING: autodoc: failed to import class 'nlp.modules.BertEncoder' from module 'nemo.collections'; the following exception was raised: No module named 'rapidfuzz' WARNING: autodoc: failed to import class 'nlp.modules.DistilBertEncoder' from module 'nemo.collections'; the following exception was raised: No module named 'rapidfuzz' WARNING: autodoc: failed to import class 'nlp.modules.RobertaEncoder' from module 'nemo.collections'; the following exception was raised: No module named 'rapidfuzz' WARNING: autodoc: failed to import class 'nlp.modules.SequenceClassifier' from module 'nemo.collections'; the following exception was raised: No module named 'rapidfuzz' WARNING: autodoc: failed to import class 'nlp.modules.SequenceRegression' from module 'nemo.collections'; the following exception was raised: No module named 'rapidfuzz' WARNING: autodoc: failed to import class 'nlp.modules.SequenceTokenClassifier' from module 'nemo.collections'; the following exception was raised: No module named 'rapidfuzz' WARNING: autodoc: failed to import function 'nlp.modules.get_lm_model' from module 'nemo.collections'; the following exception was raised: No module named 'rapidfuzz' WARNING: autodoc: failed to import function 'nlp.modules.get_pretrained_lm_models_list' from module 'nemo.collections'; the following exception was raised: No module named 'rapidfuzz' WARNING: autodoc: failed to import function 'nlp.modules.get_megatron_lm_models_list' from module 'nemo.collections'; the following exception was raised: No module named 'rapidfuzz' WARNING: autodoc: failed to import class 'tts.models.base.SpectrogramGenerator' from module 'nemo.collections'; the following exception was raised: No module named 'kaldiio' WARNING: autodoc: failed to import class 'tts.models.base.Vocoder' from module 'nemo.collections'; the following exception was raised: No module named 'kaldiio' WARNING: autodoc: failed to import class 'tts.models.Tacotron2Model' from module 'nemo.collections'; the following exception was raised: No module named 'kaldiio' WARNING: autodoc: failed to import class 'tts.models.GlowTTSModel' from module 'nemo.collections'; the following exception was raised: No module named 'kaldiio' WARNING: autodoc: failed to import class 'tts.models.WaveGlowModel' from module 'nemo.collections'; the following exception was raised: No module named 'kaldiio' WARNING: autodoc: failed to import class 'tts.models.SqueezeWaveModel' from module 'nemo.collections'; the following exception was raised: No module named 'kaldiio' looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done writing output... [ 6%] api-docs/nemo writing output... [ 12%] asr/api writing output... [ 18%] asr/datasets writing output... [ 25%] asr/intro writing output... [ 31%] asr/models writing output... [ 37%] common/intro writing output... [ 43%] core writing output... [ 50%] cv/intro writing output... [ 56%] index writing output... [ 62%] nlp/api writing output... [ 68%] nlp/intro writing output... [ 75%] nlp/models writing output... [ 81%] tts/base writing output... [ 87%] tts/intro writing output... [ 93%] tts/model_API writing output... [100%] tts/models /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/main/docs/source/tts/models.rst:51: WARNING: could not find bibtex key "yang2020multiband" generating indices... genindex py-modindex done highlighting module code... [ 9%] nemo.collections.common.metrics.perplexity highlighting module code... [ 18%] nemo.collections.cv.datasets.mnist_dataset highlighting module code... [ 27%] nemo.collections.cv.losses.nll_loss highlighting module code... [ 36%] nemo.collections.cv.models.mnist_lenet5 highlighting module code... [ 45%] nemo.collections.cv.modules.lenet5 highlighting module code... [ 54%] nemo.core.classes.modelPT highlighting module code... [ 63%] nemo.core.config.base_config highlighting module code... [ 72%] nemo.core.config.optimizers highlighting module code... [ 81%] nemo.core.config.pytorch highlighting module code... [ 90%] nemo.core.config.schedulers highlighting module code... [100%] nemo.core.neural_types.neural_type writing additional pages... search done copying images... [ 25%] asr/jasper_vertical.png copying images... [ 50%] asr/quartz_vertical.png copying images... [ 75%] tts/waveglow.png copying images... [100%] tts/squeezewave_wn.png copying static files... done copying extra files... done dumping search index in English (code: en)... done dumping object inventory... done build succeeded, 39 warnings. The HTML pages are in _build/html. Updating searchtools for Read the Docs search...