Read the Docs build information Build id: 454125 Project: nvidia-nemo Version: 1298 Commit: 9bf16616cefb92f57cacb2a865787328514e9d33 Date: 2020-10-17T22:14:16.429704Z State: finished Success: True [rtd-command-info] start-time: 2020-10-17T22:15:06.390256Z, end-time: 2020-10-17T22:15:12.243663Z, 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: 2020-10-17T22:15:12.793569Z, end-time: 2020-10-17T22:15:13.708898Z, duration: 0, exit-code: 0 git fetch origin --force --tags --prune --prune-tags --depth 50 pull/1298/head:external-1298 From https://github.com/NVIDIA/NeMo * [new ref] refs/pull/1298/head -> external-1298 [rtd-command-info] start-time: 2020-10-17T22:15:14.082327Z, end-time: 2020-10-17T22:15:14.233788Z, duration: 0, exit-code: 0 git checkout --force 9bf16616cefb92f57cacb2a865787328514e9d33 Note: checking out '9bf16616cefb92f57cacb2a865787328514e9d33'. 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 9bf16616 Remove unneeded flags in GQA [rtd-command-info] start-time: 2020-10-17T22:15:14.356624Z, end-time: 2020-10-17T22:15:14.412500Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2020-10-17T22:15:15.749880Z, end-time: 2020-10-17T22:15:19.640206Z, duration: 3, exit-code: 0 python3.7 -mvirtualenv Using base prefix '/home/docs/.pyenv/versions/3.7.3' New python executable in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/1298/bin/python3.7 Also creating executable in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/1298/bin/python Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2020-10-17T22:15:19.750424Z, end-time: 2020-10-17T22:15:20.455462Z, duration: 0, exit-code: 0 python -m pip install --upgrade --no-cache-dir pip Requirement already up-to-date: pip in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/1298/lib/python3.7/site-packages (20.2.4) [rtd-command-info] start-time: 2020-10-17T22:15:20.567145Z, end-time: 2020-10-17T22:15:28.878002Z, duration: 8, 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 commonmark==0.8.1 recommonmark==0.5.0 sphinx<2 sphinx-rtd-theme<0.5 readthedocs-sphinx-ext<1.1 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.tar.gz (818 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 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<1.1 Downloading readthedocs_sphinx_ext-1.0.4-py2.py3-none-any.whl (28 kB) Collecting future Downloading future-0.18.2.tar.gz (829 kB) Collecting Jinja2>=2.3 Downloading Jinja2-2.11.2-py2.py3-none-any.whl (125 kB) Collecting snowballstemmer>=1.1 Downloading snowballstemmer-2.0.0-py2.py3-none-any.whl (97 kB) Collecting sphinxcontrib-websupport Downloading sphinxcontrib_websupport-1.2.4-py2.py3-none-any.whl (39 kB) Collecting requests>=2.0.0 Downloading requests-2.24.0-py2.py3-none-any.whl (61 kB) Collecting babel!=2.0,>=1.3 Downloading Babel-2.8.0-py2.py3-none-any.whl (8.6 MB) Collecting imagesize Downloading imagesize-1.2.0-py2.py3-none-any.whl (4.8 kB) Collecting six>=1.5 Downloading six-1.15.0-py2.py3-none-any.whl (10 kB) Collecting Pygments>=2.0 Downloading Pygments-2.7.1-py3-none-any.whl (944 kB) Collecting packaging Downloading packaging-20.4-py2.py3-none-any.whl (37 kB) Collecting MarkupSafe>=0.23 Downloading MarkupSafe-1.1.1-cp37-cp37m-manylinux1_x86_64.whl (27 kB) Collecting sphinxcontrib-serializinghtml Downloading sphinxcontrib_serializinghtml-1.1.4-py2.py3-none-any.whl (89 kB) Collecting chardet<4,>=3.0.2 Downloading chardet-3.0.4-py2.py3-none-any.whl (133 kB) Collecting urllib3!=1.25.0,!=1.25.1,<1.26,>=1.21.1 Downloading urllib3-1.25.10-py2.py3-none-any.whl (127 kB) Collecting idna<3,>=2.5 Downloading idna-2.10-py2.py3-none-any.whl (58 kB) Collecting certifi>=2017.4.17 Downloading certifi-2020.6.20-py2.py3-none-any.whl (156 kB) Collecting pytz>=2015.7 Downloading pytz-2020.1-py2.py3-none-any.whl (510 kB) Collecting pyparsing>=2.0.2 Downloading pyparsing-2.4.7-py2.py3-none-any.whl (67 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=23754 sha256=3d4e8c2d25b216e8f93108f68e66e7996723ecd25f3c90519e816957383727cc Stored in directory: /tmp/pip-ephem-wheel-cache-iqdxh86z/wheels/16/03/37/f0a64ab894c9102906f192db1a4071b7592292ad661563c69b 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=7a098a4dae4eea7b542639dcd96969ee403d9818228e56bd16b74eb2a3bd85cb Stored in directory: /tmp/pip-ephem-wheel-cache-iqdxh86z/wheels/56/b0/fe/4410d17b32f1f0c3cf54cdfb2bc04d7b4b8f4ae377e2229ba0 Successfully built mock future Installing collected packages: setuptools, docutils, mock, pillow, alabaster, future, commonmark, MarkupSafe, Jinja2, snowballstemmer, sphinxcontrib-serializinghtml, sphinxcontrib-websupport, chardet, urllib3, idna, certifi, requests, pytz, babel, imagesize, six, Pygments, pyparsing, packaging, sphinx, recommonmark, sphinx-rtd-theme, readthedocs-sphinx-ext Attempting uninstall: setuptools Found existing installation: setuptools 50.3.2 Uninstalling setuptools-50.3.2: Successfully uninstalled setuptools-50.3.2 Successfully installed Jinja2-2.11.2 MarkupSafe-1.1.1 Pygments-2.7.1 alabaster-0.7.12 babel-2.8.0 certifi-2020.6.20 chardet-3.0.4 commonmark-0.8.1 docutils-0.14 future-0.18.2 idna-2.10 imagesize-1.2.0 mock-1.0.1 packaging-20.4 pillow-5.4.1 pyparsing-2.4.7 pytz-2020.1 readthedocs-sphinx-ext-1.0.4 recommonmark-0.5.0 requests-2.24.0 setuptools-41.0.1 six-1.15.0 snowballstemmer-2.0.0 sphinx-1.8.5 sphinx-rtd-theme-0.4.3 sphinxcontrib-serializinghtml-1.1.4 sphinxcontrib-websupport-1.2.4 urllib3-1.25.10 [rtd-command-info] start-time: 2020-10-17T22:15:29.048619Z, end-time: 2020-10-17T22:15:33.922177Z, 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.2.1-py3-none-any.whl (2.9 MB) Requirement already satisfied: sphinx_rtd_theme in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/1298/lib/python3.7/site-packages (from -r requirements/requirements_docs.txt (line 3)) (0.4.3) Collecting sphinxcontrib-bibtex Downloading sphinxcontrib_bibtex-1.0.0-py3-none-any.whl (14 kB) Collecting wrapt Downloading wrapt-1.12.1.tar.gz (27 kB) Requirement already satisfied: six>=1.4.1 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/1298/lib/python3.7/site-packages (from latexcodec->-r requirements/requirements_docs.txt (line 1)) (1.15.0) Requirement already satisfied: sphinxcontrib-serializinghtml in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/1298/lib/python3.7/site-packages (from sphinx>=3.0->-r requirements/requirements_docs.txt (line 2)) (1.1.4) Requirement already satisfied: requests>=2.5.0 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/1298/lib/python3.7/site-packages (from sphinx>=3.0->-r requirements/requirements_docs.txt (line 2)) (2.24.0) Collecting sphinxcontrib-devhelp Downloading sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl (84 kB) Requirement already satisfied: Pygments>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/1298/lib/python3.7/site-packages (from sphinx>=3.0->-r requirements/requirements_docs.txt (line 2)) (2.7.1) Collecting sphinxcontrib-jsmath Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB) Requirement already satisfied: imagesize in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/1298/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/1298/lib/python3.7/site-packages (from sphinx>=3.0->-r requirements/requirements_docs.txt (line 2)) (20.4) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/1298/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/1298/lib/python3.7/site-packages (from sphinx>=3.0->-r requirements/requirements_docs.txt (line 2)) (0.14) Requirement already satisfied: Jinja2>=2.3 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/1298/lib/python3.7/site-packages (from sphinx>=3.0->-r requirements/requirements_docs.txt (line 2)) (2.11.2) Requirement already satisfied: babel>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/1298/lib/python3.7/site-packages (from sphinx>=3.0->-r requirements/requirements_docs.txt (line 2)) (2.8.0) Collecting sphinxcontrib-qthelp Downloading sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl (90 kB) Requirement already satisfied: snowballstemmer>=1.1 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/1298/lib/python3.7/site-packages (from sphinx>=3.0->-r requirements/requirements_docs.txt (line 2)) (2.0.0) Collecting sphinxcontrib-applehelp Downloading sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl (121 kB) Requirement already satisfied: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/1298/lib/python3.7/site-packages (from sphinx>=3.0->-r requirements/requirements_docs.txt (line 2)) (0.7.12) Collecting sphinxcontrib-htmlhelp Downloading sphinxcontrib_htmlhelp-1.0.3-py2.py3-none-any.whl (96 kB) Collecting pybtex-docutils>=0.2.0 Downloading pybtex_docutils-0.2.2-py2.py3-none-any.whl (4.6 kB) Collecting oset>=0.1.3 Downloading oset-0.1.3.tar.gz (7.3 kB) Collecting pybtex>=0.20 Downloading pybtex-0.23.0-py2.py3-none-any.whl (279 kB) Requirement already satisfied: urllib3!=1.25.0,!=1.25.1,<1.26,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/1298/lib/python3.7/site-packages (from requests>=2.5.0->sphinx>=3.0->-r requirements/requirements_docs.txt (line 2)) (1.25.10) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/1298/lib/python3.7/site-packages (from requests>=2.5.0->sphinx>=3.0->-r requirements/requirements_docs.txt (line 2)) (2020.6.20) Requirement already satisfied: chardet<4,>=3.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/1298/lib/python3.7/site-packages (from requests>=2.5.0->sphinx>=3.0->-r requirements/requirements_docs.txt (line 2)) (3.0.4) Requirement already satisfied: idna<3,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/1298/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: pyparsing>=2.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/1298/lib/python3.7/site-packages (from packaging->sphinx>=3.0->-r requirements/requirements_docs.txt (line 2)) (2.4.7) Requirement already satisfied: MarkupSafe>=0.23 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/1298/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: pytz>=2015.7 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/1298/lib/python3.7/site-packages (from babel>=1.3->sphinx>=3.0->-r requirements/requirements_docs.txt (line 2)) (2020.1) Collecting PyYAML>=3.01 Downloading PyYAML-5.3.1.tar.gz (269 kB) Building wheels for collected packages: wrapt, oset, PyYAML 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=70984 sha256=2722b891ce6c4382b4a4fadf4e07144453f32463c690087b569d2e938718ddf3 Stored in directory: /tmp/pip-ephem-wheel-cache-zdhs37fo/wheels/62/76/4c/aa25851149f3f6d9785f6c869387ad82b3fd37582fa8147ac6 Building wheel for oset (setup.py): started Building wheel for oset (setup.py): finished with status 'done' Created wheel for oset: filename=oset-0.1.3-py3-none-any.whl size=9660 sha256=9918f0513ffc30bbeda244008c393630551de85d471a29432d8960f2505a8cb3 Stored in directory: /tmp/pip-ephem-wheel-cache-zdhs37fo/wheels/d3/97/cf/cfafe0bedac445a9492baca15b27f8afb4693182b00a975ac7 Building wheel for PyYAML (setup.py): started Building wheel for PyYAML (setup.py): finished with status 'done' Created wheel for PyYAML: filename=PyYAML-5.3.1-cp37-cp37m-linux_x86_64.whl size=44619 sha256=851d6a633335f0b487c625851aca8f5d74b63e7c6ad5cd111da2cee629732c32 Stored in directory: /tmp/pip-ephem-wheel-cache-zdhs37fo/wheels/5e/03/1e/e1e954795d6f35dfc7b637fe2277bff021303bd9570ecea653 Successfully built wrapt oset PyYAML Installing collected packages: latexcodec, sphinxcontrib-devhelp, sphinxcontrib-jsmath, sphinxcontrib-qthelp, sphinxcontrib-applehelp, sphinxcontrib-htmlhelp, sphinx, PyYAML, pybtex, pybtex-docutils, oset, sphinxcontrib-bibtex, wrapt 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.3.1 latexcodec-2.0.1 oset-0.1.3 pybtex-0.23.0 pybtex-docutils-0.2.2 sphinx-3.2.1 sphinxcontrib-applehelp-1.0.2 sphinxcontrib-bibtex-1.0.0 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: 2020-10-17T22:15:35.135365Z, end-time: 2020-10-17T22:15:35.205779Z, 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", ] # 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': "1298", 'version_slug': "1298", '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': '9bf16616cefb92f57cacb2a865787328514e9d33', 'display_github': True, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': '9bf16616cefb92f57cacb2a865787328514e9d33', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': '9bf16616cefb92f57cacb2a865787328514e9d33', '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': '9bf16616', } 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 'external' == 'external': extensions.insert(1, "readthedocs_ext.external_version_warning") 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: 2020-10-17T22:15:35.310276Z, end-time: 2020-10-17T22:15:40.494977Z, duration: 5, exit-code: 0 python sphinx-build -T -E -b readthedocs -d _build/doctrees-readthedocs -D language=en . _build/html Running Sphinx v3.2.1 loading translations [en]... done making output directory... done building [mo]: targets for 0 po files that are out of date building [readthedocs]: targets for 17 source files that are out of date updating environment: [new config] 17 added, 0 changed, 0 removed reading sources... [ 5%] api-docs/nemo reading sources... [ 11%] asr/api [NeMo W 2020-10-17 22:15:36 experimental:28] Module is experimental, not ready for production and is not fully supported. Use at your own risk. [NeMo W 2020-10-17 22:15:36 experimental:28] Module is experimental, not ready for production and is not fully supported. Use at your own risk. [NeMo W 2020-10-17 22:15:36 experimental:28] Module is experimental, not ready for production and is not fully supported. Use at your own risk. [NeMo W 2020-10-17 22:15:36 experimental:28] Module is experimental, not ready for production and is not fully supported. Use at your own risk. [NeMo W 2020-10-17 22:15:36 experimental:28] Module is experimental, not ready for production and is not fully supported. Use at your own risk. [NeMo W 2020-10-17 22:15:36 experimental:28] Module is experimental, not ready for production and is not fully supported. Use at your own risk. [NeMo W 2020-10-17 22:15:36 experimental:28] Module is experimental, not ready for production and is not fully supported. Use at your own risk. reading sources... [ 17%] asr/datasets reading sources... [ 23%] asr/intro reading sources... [ 29%] asr/models checking for /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/1298/docs/source/asr/asr_all.bib in bibtex cache... not found parsing bibtex file /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/1298/docs/source/asr/asr_all.bib... parsed 101 entries reading sources... [ 35%] common/intro reading sources... [ 41%] core reading sources... [ 47%] cv/intro reading sources... [ 52%] index reading sources... [ 58%] nlp/api [NeMo W 2020-10-17 22:15:37 experimental:28] Module is experimental, not ready for production and is not fully supported. Use at your own risk. [NeMo W 2020-10-17 22:15:37 experimental:28] Module is experimental, not ready for production and is not fully supported. Use at your own risk. reading sources... [ 64%] nlp/intro reading sources... [ 70%] nlp/models reading sources... [ 76%] tts/base [NeMo W 2020-10-17 22:15:37 experimental:28] Module is experimental, not ready for production and is not fully supported. Use at your own risk. [NeMo W 2020-10-17 22:15:37 experimental:28] Module is experimental, not ready for production and is not fully supported. Use at your own risk. [NeMo W 2020-10-17 22:15:37 experimental:28] Module is experimental, not ready for production and is not fully supported. Use at your own risk. [NeMo W 2020-10-17 22:15:37 experimental:28] Module is experimental, not ready for production and is not fully supported. Use at your own risk. [NeMo W 2020-10-17 22:15:37 experimental:28] Module is experimental, not ready for production and is not fully supported. Use at your own risk. reading sources... [ 82%] tts/intro reading sources... [ 88%] tts/model_API reading sources... [ 94%] tts/models checking for /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/1298/docs/source/tts/tts_all.bib in bibtex cache... not found parsing bibtex file /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/1298/docs/source/tts/tts_all.bib... parsed 4 entries reading sources... [100%] vis/intro /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/1298/nemo/core/classes/modelPT.py:docstring of nemo.core.ModelPT.extract_state_dict_from:5: WARNING: Unexpected indentation. /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/1298/nemo/core/classes/modelPT.py:docstring of nemo.core.ModelPT.extract_state_dict_from:23: WARNING: Unexpected indentation. /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/1298/nemo/core/classes/modelPT.py:docstring of nemo.core.ModelPT.extract_state_dict_from:20: WARNING: Inline literal start-string without end-string. /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/1298/nemo/core/classes/modelPT.py:docstring of nemo.core.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/1298/nemo/core/classes/modelPT.py:docstring of nemo.core.ModelPT.extract_state_dict_from:24: WARNING: Inline literal start-string without end-string. /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/1298/nemo/core/classes/modelPT.py:docstring of nemo.core.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/1298/nemo/core/classes/modelPT.py:docstring of nemo.core.ModelPT.extract_state_dict_from:26: WARNING: Inline literal start-string without end-string. /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/1298/nemo/core/classes/modelPT.py:docstring of nemo.core.ModelPT.extract_state_dict_from:30: WARNING: Inline literal start-string without end-string. /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/1298/nemo/core/classes/modelPT.py:docstring of nemo.core.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/1298/nemo/core/classes/modelPT.py:docstring of nemo.core.ModelPT.prepare_test:7: WARNING: Unexpected indentation. /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/1298/nemo/core/classes/modelPT.py:docstring of nemo.core.ModelPT.restore_from:4: WARNING: Unexpected indentation. /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/1298/nemo/core/classes/modelPT.py:docstring of nemo.core.ModelPT.restore_from:5: WARNING: Block quote ends without a blank line; unexpected unindent. /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/1298/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/1298/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. /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/1298/nemo/collections/asr/modules/conv_asr.py:docstring of nemo.collections.asr.modules.ConvASREncoder:3: WARNING: Unexpected indentation. /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/checkouts/1298/docs/source/vis/intro.rst:2: WARNING: Title underline too short. Visual Reasoning (CV+NLP) ===================== WARNING: autodoc: failed to import module 'vis.datasets.clevr' from module 'nemo.collections'; the following exception was raised: No module named 'cv2' looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done writing output... [ 5%] api-docs/nemo writing output... [ 11%] asr/api writing output... [ 17%] asr/datasets writing output... [ 23%] asr/intro writing output... [ 29%] asr/models writing output... [ 35%] common/intro writing output... [ 41%] core writing output... [ 47%] cv/intro writing output... [ 52%] index writing output... [ 58%] nlp/api writing output... [ 64%] nlp/intro writing output... [ 70%] nlp/models writing output... [ 76%] tts/base writing output... [ 82%] tts/intro writing output... [ 88%] tts/model_API writing output... [ 94%] tts/models writing output... [100%] vis/intro generating indices... genindex py-modindexdone highlighting module code... [ 3%] nemo.collections.asr.models.classification_models highlighting module code... [ 7%] nemo.collections.asr.models.ctc_models highlighting module code... [ 10%] nemo.collections.asr.models.label_models highlighting module code... [ 14%] nemo.collections.asr.modules.conv_asr highlighting module code... [ 17%] nemo.collections.cv.datasets.configs highlighting module code... [ 21%] nemo.collections.cv.modules.image_encoder highlighting module code... [ 25%] nemo.collections.cv.transforms.configs highlighting module code... [ 28%] nemo.collections.nlp.models.glue_benchmark.glue_benchmark_model highlighting module code... [ 32%] nemo.collections.nlp.models.token_classification.punctuation_capitalization_model highlighting module code... [ 35%] nemo.collections.nlp.models.token_classification.token_classification_model highlighting module code... [ 39%] nemo.collections.nlp.modules.common.bert_module highlighting module code... [ 42%] nemo.collections.nlp.modules.common.huggingface.albert highlighting module code... [ 46%] nemo.collections.nlp.modules.common.huggingface.bert highlighting module code... [ 50%] nemo.collections.nlp.modules.common.huggingface.distilbert highlighting module code... [ 53%] nemo.collections.nlp.modules.common.huggingface.roberta highlighting module code... [ 57%] nemo.collections.nlp.modules.common.lm_utils highlighting module code... [ 60%] nemo.collections.nlp.modules.common.megatron.megatron_bert highlighting module code... [ 64%] nemo.collections.nlp.modules.common.megatron.megatron_utils highlighting module code... [ 67%] nemo.collections.nlp.modules.common.sequence_classifier highlighting module code... [ 71%] nemo.collections.nlp.modules.common.sequence_regression highlighting module code... [ 75%] nemo.collections.nlp.modules.common.sequence_token_classifier highlighting module code... [ 78%] nemo.collections.tts.models.base highlighting module code... [ 82%] nemo.collections.tts.models.glow_tts highlighting module code... [ 85%] nemo.collections.tts.models.squeezewave highlighting module code... [ 89%] nemo.collections.tts.models.tacotron2 highlighting module code... [ 92%] nemo.collections.tts.models.waveglow highlighting module code... [ 96%] nemo.core.classes.modelPT highlighting module code... [100%] nemo.core.neural_types.neural_type writing additional pages... searchdone 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 readthedocs static files... done copying searchtools... done copying extra files... done dumping search index in English (code: en)... done dumping object inventory... done build succeeded, 17 warnings. The HTML pages are in _build/html.