Read the Docs build information Build id: 2011392 Project: nvidia-nemo Version: 8406 Commit: 39e5d5f9bd934c64d053d43022062e745d8472b0 Date: 2024-02-12T19:43:04.399780Z State: finished Success: False [rtd-command-info] start-time: 2024-02-12T19:43:05.633486Z, end-time: 2024-02-12T19:43:13.043355Z, duration: 7, exit-code: 0 git clone --depth 1 https://github.com/NVIDIA/NeMo.git . Cloning into '.'... [rtd-command-info] start-time: 2024-02-12T19:43:13.106875Z, end-time: 2024-02-12T19:43:14.464754Z, duration: 1, exit-code: 0 git fetch origin --force --prune --prune-tags --depth 50 pull/8406/head:external-8406 From https://github.com/NVIDIA/NeMo * [new ref] refs/pull/8406/head -> external-8406 [rtd-command-info] start-time: 2024-02-12T19:43:14.623873Z, end-time: 2024-02-12T19:43:14.790143Z, duration: 0, exit-code: 0 git checkout --force 39e5d5f9bd934c64d053d43022062e745d8472b0 Note: switching to '39e5d5f9bd934c64d053d43022062e745d8472b0'. 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 switching back to a branch. If you want to create a new branch to retain commits you create, you may do so (now or later) by using -c with the switch command. Example: git switch -c Or undo this operation with: git switch - Turn off this advice by setting config variable advice.detachedHead to false HEAD is now at 39e5d5f update nfa nasa video link [rtd-command-info] start-time: 2024-02-12T19:43:14.871881Z, end-time: 2024-02-12T19:43:14.943630Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2024-02-12T19:43:15.038875Z, end-time: 2024-02-12T19:43:15.100361Z, duration: 0, exit-code: 0 cat .readthedocs.yml # ============================================================================= # Copyright (c) 2020 NVIDIA. 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. # ============================================================================= # Read the Docs configuration file # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details # Required field. version: 2 build: os: ubuntu-22.04 tools: python: "3.10" # Build documentation in the docs/ directory with Sphinx. sphinx: configuration: docs/source/conf.py # Set the version of Python and requirements required to build your docs python: install: - requirements: requirements/requirements_docs.txt [rtd-command-info] start-time: 2024-02-12T19:43:20.343325Z, end-time: 2024-02-12T19:43:20.423671Z, duration: 0, exit-code: 0 asdf global python 3.10.13 [rtd-command-info] start-time: 2024-02-12T19:43:20.845285Z, end-time: 2024-02-12T19:43:22.229444Z, duration: 1, exit-code: 0 python -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH created virtual environment CPython3.10.13.final.0-64 in 856ms creator CPython3Posix(dest=/home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/8406, clear=False, no_vcs_ignore=False, global=False) seeder FromAppData(download=False, pip=bundle, setuptools=bundle, wheel=bundle, via=copy, app_data_dir=/home/docs/.local/share/virtualenv) added seed packages: pip==23.1, setuptools==67.6.1, wheel==0.40.0 activators BashActivator,CShellActivator,FishActivator,NushellActivator,PowerShellActivator,PythonActivator [rtd-command-info] start-time: 2024-02-12T19:43:22.298386Z, end-time: 2024-02-12T19:43:34.890586Z, duration: 12, exit-code: 0 python -m pip install --upgrade --no-cache-dir pip setuptools Requirement already satisfied: pip in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/8406/lib/python3.10/site-packages (23.1) Collecting pip Downloading pip-24.0-py3-none-any.whl (2.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.1/2.1 MB 11.2 MB/s eta 0:00:00 Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/8406/lib/python3.10/site-packages (67.6.1) Collecting setuptools Downloading setuptools-69.1.0-py3-none-any.whl (819 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 819.3/819.3 kB 25.2 MB/s eta 0:00:00 Installing collected packages: setuptools, pip Attempting uninstall: setuptools Found existing installation: setuptools 67.6.1 Uninstalling setuptools-67.6.1: Successfully uninstalled setuptools-67.6.1 Attempting uninstall: pip Found existing installation: pip 23.1 Uninstalling pip-23.1: Successfully uninstalled pip-23.1 Successfully installed pip-24.0 setuptools-69.1.0 [rtd-command-info] start-time: 2024-02-12T19:43:34.965653Z, end-time: 2024-02-12T19:43:41.226870Z, duration: 6, exit-code: 0 python -m pip install --upgrade --no-cache-dir sphinx readthedocs-sphinx-ext Collecting sphinx Downloading sphinx-7.2.6-py3-none-any.whl.metadata (5.9 kB) Collecting readthedocs-sphinx-ext Downloading readthedocs_sphinx_ext-2.2.5-py2.py3-none-any.whl.metadata (1.5 kB) Collecting sphinxcontrib-applehelp (from sphinx) Downloading sphinxcontrib_applehelp-1.0.8-py3-none-any.whl.metadata (2.3 kB) Collecting sphinxcontrib-devhelp (from sphinx) Downloading sphinxcontrib_devhelp-1.0.6-py3-none-any.whl.metadata (2.3 kB) Collecting sphinxcontrib-jsmath (from sphinx) Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB) Collecting sphinxcontrib-htmlhelp>=2.0.0 (from sphinx) Downloading sphinxcontrib_htmlhelp-2.0.5-py3-none-any.whl.metadata (2.3 kB) Collecting sphinxcontrib-serializinghtml>=1.1.9 (from sphinx) Downloading sphinxcontrib_serializinghtml-1.1.10-py3-none-any.whl.metadata (2.4 kB) Collecting sphinxcontrib-qthelp (from sphinx) Downloading sphinxcontrib_qthelp-1.0.7-py3-none-any.whl.metadata (2.2 kB) Collecting Jinja2>=3.0 (from sphinx) Downloading Jinja2-3.1.3-py3-none-any.whl.metadata (3.3 kB) Collecting Pygments>=2.14 (from sphinx) Downloading pygments-2.17.2-py3-none-any.whl.metadata (2.6 kB) Collecting docutils<0.21,>=0.18.1 (from sphinx) Downloading docutils-0.20.1-py3-none-any.whl.metadata (2.8 kB) Collecting snowballstemmer>=2.0 (from sphinx) Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 93.0/93.0 kB 7.0 MB/s eta 0:00:00 Collecting babel>=2.9 (from sphinx) Downloading Babel-2.14.0-py3-none-any.whl.metadata (1.6 kB) Collecting alabaster<0.8,>=0.7 (from sphinx) Downloading alabaster-0.7.16-py3-none-any.whl.metadata (2.9 kB) Collecting imagesize>=1.3 (from sphinx) Downloading imagesize-1.4.1-py2.py3-none-any.whl (8.8 kB) Collecting requests>=2.25.0 (from sphinx) Downloading requests-2.31.0-py3-none-any.whl.metadata (4.6 kB) Collecting packaging>=21.0 (from sphinx) Downloading packaging-23.2-py3-none-any.whl.metadata (3.2 kB) Collecting MarkupSafe>=2.0 (from Jinja2>=3.0->sphinx) Downloading MarkupSafe-2.1.5-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (3.0 kB) Collecting charset-normalizer<4,>=2 (from requests>=2.25.0->sphinx) Downloading charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (33 kB) Collecting idna<4,>=2.5 (from requests>=2.25.0->sphinx) Downloading idna-3.6-py3-none-any.whl.metadata (9.9 kB) Collecting urllib3<3,>=1.21.1 (from requests>=2.25.0->sphinx) Downloading urllib3-2.2.0-py3-none-any.whl.metadata (6.4 kB) Collecting certifi>=2017.4.17 (from requests>=2.25.0->sphinx) Downloading certifi-2024.2.2-py3-none-any.whl.metadata (2.2 kB) Downloading sphinx-7.2.6-py3-none-any.whl (3.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.2/3.2 MB 88.1 MB/s eta 0:00:00 Downloading readthedocs_sphinx_ext-2.2.5-py2.py3-none-any.whl (11 kB) Downloading alabaster-0.7.16-py3-none-any.whl (13 kB) Downloading Babel-2.14.0-py3-none-any.whl (11.0 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 11.0/11.0 MB 191.2 MB/s eta 0:00:00 Downloading docutils-0.20.1-py3-none-any.whl (572 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 572.7/572.7 kB 300.0 MB/s eta 0:00:00 Downloading Jinja2-3.1.3-py3-none-any.whl (133 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 133.2/133.2 kB 273.4 MB/s eta 0:00:00 Downloading packaging-23.2-py3-none-any.whl (53 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 53.0/53.0 kB 232.6 MB/s eta 0:00:00 Downloading pygments-2.17.2-py3-none-any.whl (1.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.2/1.2 MB 297.7 MB/s eta 0:00:00 Downloading requests-2.31.0-py3-none-any.whl (62 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 62.6/62.6 kB 243.5 MB/s eta 0:00:00 Downloading sphinxcontrib_htmlhelp-2.0.5-py3-none-any.whl (99 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 99.2/99.2 kB 265.3 MB/s eta 0:00:00 Downloading sphinxcontrib_serializinghtml-1.1.10-py3-none-any.whl (92 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 92.7/92.7 kB 248.4 MB/s eta 0:00:00 Downloading sphinxcontrib_applehelp-1.0.8-py3-none-any.whl (120 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 120.0/120.0 kB 272.0 MB/s eta 0:00:00 Downloading sphinxcontrib_devhelp-1.0.6-py3-none-any.whl (83 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 83.5/83.5 kB 264.9 MB/s eta 0:00:00 Downloading sphinxcontrib_qthelp-1.0.7-py3-none-any.whl (89 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 89.4/89.4 kB 258.6 MB/s eta 0:00:00 Downloading certifi-2024.2.2-py3-none-any.whl (163 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 163.8/163.8 kB 264.5 MB/s eta 0:00:00 Downloading charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (142 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 142.1/142.1 kB 282.7 MB/s eta 0:00:00 Downloading idna-3.6-py3-none-any.whl (61 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 61.6/61.6 kB 248.3 MB/s eta 0:00:00 Downloading MarkupSafe-2.1.5-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (25 kB) Downloading urllib3-2.2.0-py3-none-any.whl (120 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 120.9/120.9 kB 276.1 MB/s eta 0:00:00 Installing collected packages: snowballstemmer, urllib3, sphinxcontrib-serializinghtml, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, Pygments, packaging, MarkupSafe, imagesize, idna, docutils, charset-normalizer, certifi, babel, alabaster, requests, Jinja2, sphinx, readthedocs-sphinx-ext Successfully installed Jinja2-3.1.3 MarkupSafe-2.1.5 Pygments-2.17.2 alabaster-0.7.16 babel-2.14.0 certifi-2024.2.2 charset-normalizer-3.3.2 docutils-0.20.1 idna-3.6 imagesize-1.4.1 packaging-23.2 readthedocs-sphinx-ext-2.2.5 requests-2.31.0 snowballstemmer-2.2.0 sphinx-7.2.6 sphinxcontrib-applehelp-1.0.8 sphinxcontrib-devhelp-1.0.6 sphinxcontrib-htmlhelp-2.0.5 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.7 sphinxcontrib-serializinghtml-1.1.10 urllib3-2.2.0 [rtd-command-info] start-time: 2024-02-12T19:43:41.297979Z, end-time: 2024-02-12T19:43:52.292168Z, duration: 10, exit-code: 0 python -m pip install --exists-action=w --no-cache-dir -r requirements/requirements_docs.txt Collecting boto3 (from -r requirements/requirements_docs.txt (line 1)) Downloading boto3-1.34.39-py3-none-any.whl.metadata (6.6 kB) Collecting Jinja2<3.1 (from -r requirements/requirements_docs.txt (line 2)) Downloading Jinja2-3.0.3-py3-none-any.whl (133 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 133.6/133.6 kB 5.5 MB/s eta 0:00:00 Collecting latexcodec (from -r requirements/requirements_docs.txt (line 3)) Downloading latexcodec-2.0.1-py2.py3-none-any.whl (18 kB) Collecting numpy (from -r requirements/requirements_docs.txt (line 4)) Downloading numpy-1.26.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (61 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 61.0/61.0 kB 14.4 MB/s eta 0:00:00 Collecting pydata-sphinx-theme==0.13.1 (from -r requirements/requirements_docs.txt (line 7)) Downloading pydata_sphinx_theme-0.13.1-py3-none-any.whl (1.6 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.6/1.6 MB 12.9 MB/s eta 0:00:00 Collecting Sphinx!=5.0.0,<6,>=4.0 (from -r requirements/requirements_docs.txt (line 8)) Downloading sphinx-5.3.0-py3-none-any.whl (3.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.2/3.2 MB 26.8 MB/s eta 0:00:00 Collecting sphinx-book-theme (from -r requirements/requirements_docs.txt (line 9)) Downloading sphinx_book_theme-1.1.0-py3-none-any.whl.metadata (5.7 kB) Collecting sphinx-copybutton (from -r requirements/requirements_docs.txt (line 10)) Downloading sphinx_copybutton-0.5.2-py3-none-any.whl (13 kB) Collecting sphinxcontrib-bibtex (from -r requirements/requirements_docs.txt (line 11)) Downloading sphinxcontrib_bibtex-2.6.2-py3-none-any.whl.metadata (6.1 kB) Collecting sphinxext-opengraph (from -r requirements/requirements_docs.txt (line 12)) Downloading sphinxext_opengraph-0.9.1-py3-none-any.whl.metadata (6.5 kB) Collecting urllib3<2.0.0 (from -r requirements/requirements_docs.txt (line 13)) Downloading urllib3-1.26.18-py2.py3-none-any.whl.metadata (48 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 48.9/48.9 kB 214.8 MB/s eta 0:00:00 Collecting wrapt (from -r requirements/requirements_docs.txt (line 14)) Downloading wrapt-1.16.0-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (6.6 kB) Collecting beautifulsoup4 (from pydata-sphinx-theme==0.13.1->-r requirements/requirements_docs.txt (line 7)) Downloading beautifulsoup4-4.12.3-py3-none-any.whl.metadata (3.8 kB) Requirement already satisfied: docutils!=0.17.0 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/8406/lib/python3.10/site-packages (from pydata-sphinx-theme==0.13.1->-r requirements/requirements_docs.txt (line 7)) (0.20.1) Requirement already satisfied: packaging in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/8406/lib/python3.10/site-packages (from pydata-sphinx-theme==0.13.1->-r requirements/requirements_docs.txt (line 7)) (23.2) Requirement already satisfied: Babel in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/8406/lib/python3.10/site-packages (from pydata-sphinx-theme==0.13.1->-r requirements/requirements_docs.txt (line 7)) (2.14.0) Requirement already satisfied: pygments>=2.7 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/8406/lib/python3.10/site-packages (from pydata-sphinx-theme==0.13.1->-r requirements/requirements_docs.txt (line 7)) (2.17.2) Collecting accessible-pygments (from pydata-sphinx-theme==0.13.1->-r requirements/requirements_docs.txt (line 7)) Downloading accessible_pygments-0.0.4-py2.py3-none-any.whl (29 kB) Collecting botocore<1.35.0,>=1.34.39 (from boto3->-r requirements/requirements_docs.txt (line 1)) Downloading botocore-1.34.39-py3-none-any.whl.metadata (5.7 kB) Collecting jmespath<2.0.0,>=0.7.1 (from boto3->-r requirements/requirements_docs.txt (line 1)) Downloading jmespath-1.0.1-py3-none-any.whl (20 kB) Collecting s3transfer<0.11.0,>=0.10.0 (from boto3->-r requirements/requirements_docs.txt (line 1)) Downloading s3transfer-0.10.0-py3-none-any.whl.metadata (1.7 kB) Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/8406/lib/python3.10/site-packages (from Jinja2<3.1->-r requirements/requirements_docs.txt (line 2)) (2.1.5) Collecting six>=1.4.1 (from latexcodec->-r requirements/requirements_docs.txt (line 3)) Downloading six-1.16.0-py2.py3-none-any.whl (11 kB) Requirement already satisfied: sphinxcontrib-applehelp in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/8406/lib/python3.10/site-packages (from Sphinx!=5.0.0,<6,>=4.0->-r requirements/requirements_docs.txt (line 8)) (1.0.8) Requirement already satisfied: sphinxcontrib-devhelp in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/8406/lib/python3.10/site-packages (from Sphinx!=5.0.0,<6,>=4.0->-r requirements/requirements_docs.txt (line 8)) (1.0.6) Requirement already satisfied: sphinxcontrib-jsmath in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/8406/lib/python3.10/site-packages (from Sphinx!=5.0.0,<6,>=4.0->-r requirements/requirements_docs.txt (line 8)) (1.0.1) Requirement already satisfied: sphinxcontrib-htmlhelp>=2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/8406/lib/python3.10/site-packages (from Sphinx!=5.0.0,<6,>=4.0->-r requirements/requirements_docs.txt (line 8)) (2.0.5) Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.5 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/8406/lib/python3.10/site-packages (from Sphinx!=5.0.0,<6,>=4.0->-r requirements/requirements_docs.txt (line 8)) (1.1.10) Requirement already satisfied: sphinxcontrib-qthelp in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/8406/lib/python3.10/site-packages (from Sphinx!=5.0.0,<6,>=4.0->-r requirements/requirements_docs.txt (line 8)) (1.0.7) Collecting docutils!=0.17.0 (from pydata-sphinx-theme==0.13.1->-r requirements/requirements_docs.txt (line 7)) Downloading docutils-0.19-py3-none-any.whl (570 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 570.5/570.5 kB 43.7 MB/s eta 0:00:00 Requirement already satisfied: snowballstemmer>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/8406/lib/python3.10/site-packages (from Sphinx!=5.0.0,<6,>=4.0->-r requirements/requirements_docs.txt (line 8)) (2.2.0) Requirement already satisfied: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/8406/lib/python3.10/site-packages (from Sphinx!=5.0.0,<6,>=4.0->-r requirements/requirements_docs.txt (line 8)) (0.7.16) Requirement already satisfied: imagesize>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/8406/lib/python3.10/site-packages (from Sphinx!=5.0.0,<6,>=4.0->-r requirements/requirements_docs.txt (line 8)) (1.4.1) Requirement already satisfied: requests>=2.5.0 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/8406/lib/python3.10/site-packages (from Sphinx!=5.0.0,<6,>=4.0->-r requirements/requirements_docs.txt (line 8)) (2.31.0) INFO: pip is looking at multiple versions of sphinx-book-theme to determine which version is compatible with other requirements. This could take a while. Collecting sphinx-book-theme (from -r requirements/requirements_docs.txt (line 9)) Downloading sphinx_book_theme-1.0.1-py3-none-any.whl (396 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 396.9/396.9 kB 48.3 MB/s eta 0:00:00 Downloading sphinx_book_theme-1.0.0-py3-none-any.whl (400 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 400.4/400.4 kB 49.6 MB/s eta 0:00:00 Collecting docutils!=0.17.0 (from pydata-sphinx-theme==0.13.1->-r requirements/requirements_docs.txt (line 7)) Downloading docutils-0.17.1-py2.py3-none-any.whl (575 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 575.5/575.5 kB 54.9 MB/s eta 0:00:00 Collecting pybtex>=0.24 (from sphinxcontrib-bibtex->-r requirements/requirements_docs.txt (line 11)) Downloading pybtex-0.24.0-py2.py3-none-any.whl (561 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 561.4/561.4 kB 58.7 MB/s eta 0:00:00 Collecting pybtex-docutils>=1.0.0 (from sphinxcontrib-bibtex->-r requirements/requirements_docs.txt (line 11)) Downloading pybtex_docutils-1.0.3-py3-none-any.whl.metadata (4.3 kB) Collecting python-dateutil<3.0.0,>=2.1 (from botocore<1.35.0,>=1.34.39->boto3->-r requirements/requirements_docs.txt (line 1)) Downloading python_dateutil-2.8.2-py2.py3-none-any.whl (247 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 247.7/247.7 kB 161.8 MB/s eta 0:00:00 Collecting PyYAML>=3.01 (from pybtex>=0.24->sphinxcontrib-bibtex->-r requirements/requirements_docs.txt (line 11)) Downloading PyYAML-6.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (2.1 kB) Requirement already satisfied: charset-normalizer<4,>=2 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/8406/lib/python3.10/site-packages (from requests>=2.5.0->Sphinx!=5.0.0,<6,>=4.0->-r requirements/requirements_docs.txt (line 8)) (3.3.2) Requirement already satisfied: idna<4,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/8406/lib/python3.10/site-packages (from requests>=2.5.0->Sphinx!=5.0.0,<6,>=4.0->-r requirements/requirements_docs.txt (line 8)) (3.6) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/8406/lib/python3.10/site-packages (from requests>=2.5.0->Sphinx!=5.0.0,<6,>=4.0->-r requirements/requirements_docs.txt (line 8)) (2024.2.2) Collecting soupsieve>1.2 (from beautifulsoup4->pydata-sphinx-theme==0.13.1->-r requirements/requirements_docs.txt (line 7)) Downloading soupsieve-2.5-py3-none-any.whl.metadata (4.7 kB) Downloading boto3-1.34.39-py3-none-any.whl (139 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 139.3/139.3 kB 256.1 MB/s eta 0:00:00 Downloading numpy-1.26.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (18.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 18.2/18.2 MB 124.5 MB/s eta 0:00:00 Downloading sphinxcontrib_bibtex-2.6.2-py3-none-any.whl (40 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 41.0/41.0 kB 231.8 MB/s eta 0:00:00 Downloading sphinxext_opengraph-0.9.1-py3-none-any.whl (1.0 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.0/1.0 MB 236.6 MB/s eta 0:00:00 Downloading urllib3-1.26.18-py2.py3-none-any.whl (143 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 143.8/143.8 kB 270.4 MB/s eta 0:00:00 Downloading wrapt-1.16.0-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (80 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 80.3/80.3 kB 270.7 MB/s eta 0:00:00 Downloading botocore-1.34.39-py3-none-any.whl (11.9 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 11.9/11.9 MB 195.9 MB/s eta 0:00:00 Downloading pybtex_docutils-1.0.3-py3-none-any.whl (6.4 kB) Downloading s3transfer-0.10.0-py3-none-any.whl (82 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 82.1/82.1 kB 243.2 MB/s eta 0:00:00 Downloading beautifulsoup4-4.12.3-py3-none-any.whl (147 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 147.9/147.9 kB 288.6 MB/s eta 0:00:00 Downloading PyYAML-6.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (705 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 705.5/705.5 kB 271.3 MB/s eta 0:00:00 Downloading soupsieve-2.5-py3-none-any.whl (36 kB) Installing collected packages: wrapt, urllib3, soupsieve, six, PyYAML, numpy, jmespath, Jinja2, docutils, accessible-pygments, python-dateutil, latexcodec, beautifulsoup4, Sphinx, pybtex, botocore, sphinxext-opengraph, sphinx-copybutton, s3transfer, pydata-sphinx-theme, pybtex-docutils, sphinxcontrib-bibtex, sphinx-book-theme, boto3 Attempting uninstall: urllib3 Found existing installation: urllib3 2.2.0 Uninstalling urllib3-2.2.0: Successfully uninstalled urllib3-2.2.0 Attempting uninstall: Jinja2 Found existing installation: Jinja2 3.1.3 Uninstalling Jinja2-3.1.3: Successfully uninstalled Jinja2-3.1.3 Attempting uninstall: docutils Found existing installation: docutils 0.20.1 Uninstalling docutils-0.20.1: Successfully uninstalled docutils-0.20.1 Attempting uninstall: Sphinx Found existing installation: Sphinx 7.2.6 Uninstalling Sphinx-7.2.6: Successfully uninstalled Sphinx-7.2.6 Successfully installed Jinja2-3.0.3 PyYAML-6.0.1 Sphinx-5.3.0 accessible-pygments-0.0.4 beautifulsoup4-4.12.3 boto3-1.34.39 botocore-1.34.39 docutils-0.17.1 jmespath-1.0.1 latexcodec-2.0.1 numpy-1.26.4 pybtex-0.24.0 pybtex-docutils-1.0.3 pydata-sphinx-theme-0.13.1 python-dateutil-2.8.2 s3transfer-0.10.0 six-1.16.0 soupsieve-2.5 sphinx-book-theme-1.0.0 sphinx-copybutton-0.5.2 sphinxcontrib-bibtex-2.6.2 sphinxext-opengraph-0.9.1 urllib3-1.26.18 wrapt-1.16.0 [rtd-command-info] start-time: 2024-02-12T19:43:52.847632Z, end-time: 2024-02-12T19:43:52.905068Z, 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 re import sys import glob import sphinx_book_theme # 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__ templates_path = ["_templates"] autodoc_mock_imports = [ 'torch', 'torch.nn', 'torch.utils', 'torch.optim', 'torch.utils.data', 'torch.utils.data.sampler', 'torchtext', 'torchvision', 'ruamel.yaml', # ruamel.yaml has ., which is troublesome for this regex 'hydra', # hydra-core in requirements, hydra during import 'dateutil', # part of core python 'transformers.tokenization_bert', # has ., troublesome for this regex 'sklearn', # scikit_learn in requirements, sklearn in import 'nemo_text_processing.inverse_text_normalization', # Not installed automatically 'nemo_text_processing.text_normalization', # Not installed automatically 'attr', # attrdict in requirements, attr in import 'torchmetrics', # inherited from PTL 'lightning_utilities', # inherited from PTL 'lightning_fabric', 'apex', 'megatron.core', 'transformer_engine', 'joblib', # inherited from optional code 'IPython', 'ipadic', 'psutil', 'regex', 'PIL', 'boto3', 'taming', ] _skipped_autodoc_mock_imports = ['wrapt', 'numpy'] for req_path in sorted(list(glob.glob("../../requirements/*.txt"))): if "docs.txt" in req_path: continue req_file = os.path.abspath(os.path.expanduser(req_path)) with open(req_file, 'r') as f: for line in f: line = line.replace("\n", "") req = re.search(r"([a-zA-Z0-9-_]*)", line) if req: req = req.group(1) req = req.replace("-", "_") if req not in autodoc_mock_imports: if req in _skipped_autodoc_mock_imports: print(f"Skipping req : `{req}` (lib {line})") continue autodoc_mock_imports.append(req) print(f"Adding req : `{req}` to autodoc mock requirements (lib {line})") else: print(f"`{req}` already added to autodoc mock requirements (lib {line})") # # -- 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", "sphinx.ext.autosectionlabel", "sphinxcontrib.bibtex", "sphinx_copybutton", "sphinxext.opengraph", ] bibtex_bibfiles = [ 'asr/asr_all.bib', 'nlp/nlp_all.bib', 'nlp/text_normalization/tn_itn_all.bib', 'tools/tools_all.bib', 'tts/tts_all.bib', 'text_processing/text_processing_all.bib', 'core/adapters/adapter_bib.bib', 'multimodal/mm_all.bib', 'vision/vision_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 = "© 2021-2023 NVIDIA Corporation & Affiliates. All rights reserved." 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" ### Previous NeMo theme # # 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" ### from TLT conf.py # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # # html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] html_theme = "sphinx_book_theme" html_logo = os.path.join('nv_logo.png') html_title = 'NVIDIA NeMo' html_theme_options = { 'logo_only': True, 'display_version': True, # 'prev_next_buttons_location': 'bottom', # 'style_external_links': False, # 'style_nav_header_background': '#000000', # Toc options 'collapse_navigation': False, # 'sticky_navigation': False, 'navigation_depth': 10, # 'includehidden': False, # 'titles_only': False, # Sphinx Book theme, 'repository_url': 'https://github.com/NVIDIA/NeMo', 'use_repository_button': True, 'show_navbar_depth': 1, 'show_toc_level': 10, } # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_favicon = 'favicon.ico' html_static_path = ['_static'] html_last_updated_fmt = '' def setup(app): app.add_css_file('css/custom.css') app.add_js_file('js/pk_scripts.js') # html_css_files = [ # './custom.css', # ] # html_js_files = [ # './pk_scripts.js', # ] # OpenGraph settings ogp_site_url = 'https://nvidia.github.io/NeMo/' ogp_image = 'https://docs.nvidia.com/deeplearning/nemo/user-guide/docs/en/main/_static/nv_logo.png' # MathJax CDN mathjax_path = "https://cdn.jsdelivr.net/npm/mathjax@3.2.2/es5/mml-chtml.min.js" ########################################################################### # 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/main/readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl # # Note: this file shouldn't rely on extra dependencies. import importlib import sys import os.path # Borrowed from six. PY3 = sys.version_info[0] == 3 string_types = str if PY3 else basestring 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') # Define this variable in case it's not defined by the user. # It defaults to `alabaster` which is the default from Sphinx. # https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_theme html_theme = globals().get('html_theme', 'alabaster') #Add project information to the template context. context = { 'html_theme': html_theme, 'current_version': "8406", 'version_slug': "8406", 'MEDIA_URL': "https://media.readthedocs.com/media/", 'STATIC_URL': "https://assets.readthedocs.com/", 'PRODUCTION_DOMAIN': "readthedocs.com", 'proxied_static_path': "/deeplearning/nemo/user-guide/docs/_/static/", 'versions': [ ("stable", "/en/stable/"), ("v1.22.0", "/en/v1.22.0/"), ("v1.21.0", "/en/v1.21.0/"), ("v1.20.0", "/en/v1.20.0/"), ("v1.19.1", "/en/v1.19.1/"), ("v1.19.0", "/en/v1.19.0/"), ("v1.18.1", "/en/v1.18.1/"), ("v1.18.0", "/en/v1.18.0/"), ("v1.17.0", "/en/v1.17.0/"), ("v1.16.0", "/en/v1.16.0/"), ("v1.15.0", "/en/v1.15.0/"), ("v1.10.0", "/en/v1.10.0/"), ("v1.0.0", "/en/v1.0.0/"), ("main", "/en/main/"), ], 'downloads': [ ], 'subprojects': [ ], 'slug': 'nvidia-nemo', 'name': u'NeMo', 'rtd_language': u'en', 'programming_language': u'py', 'canonical_url': '', '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': '39e5d5f9bd934c64d053d43022062e745d8472b0', 'display_github': True, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': '39e5d5f9bd934c64d053d43022062e745d8472b0', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': '39e5d5f9bd934c64d053d43022062e745d8472b0', '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': '39e5d5f9', } # 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(): for key in context: if key not in html_context: html_context[key] = context[key] 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") readthedocs_vcs_url = 'https://github.com/NVIDIA/NeMo/pull/8406' readthedocs_build_url = 'https://readthedocs.com/projects/nvidia-nemo/builds/2011392/' 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'])