Read the Docs build information Build id: 1101331 Project: graphcore-ipu-pod128-data-centre-checklist Version: latest Commit: abaca32425f49d5176d0e67e0d745dea665d8584 Date: 2022-09-16T16:00:56.954904Z State: finished Success: True [rtd-command-info] start-time: 2022-09-16T16:24:37.225151Z, end-time: 2022-09-16T16:24:38.777885Z, duration: 1, exit-code: 0 git clone --no-single-branch --depth 50 git@github.com:gc-docs/ipu-pod128-datacentre-checklist.git . Cloning into '.'... Warning: Permanently added 'github.com,192.30.255.112' (ECDSA) to the list of known hosts. [rtd-command-info] start-time: 2022-09-16T16:24:38.980314Z, end-time: 2022-09-16T16:24:39.076231Z, duration: 0, exit-code: 0 git checkout --force origin/master Note: switching to 'origin/master'. 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 abaca32 Fix regex for copybutton_prompt_text [rtd-command-info] start-time: 2022-09-16T16:24:39.266585Z, end-time: 2022-09-16T16:24:39.339671Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2022-09-16T16:24:40.401558Z, end-time: 2022-09-16T16:24:44.741692Z, duration: 4, exit-code: 0 python3.6 -mvirtualenv Using base prefix '/home/docs/.pyenv/versions/3.6.12' New python executable in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/latest/bin/python3.6 Also creating executable in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/latest/bin/python Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2022-09-16T16:24:45.045038Z, end-time: 2022-09-16T16:24:47.087112Z, duration: 2, exit-code: 0 python -m pip install --upgrade --no-cache-dir pip setuptools<58.3.0 Requirement already satisfied: pip in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/latest/lib/python3.6/site-packages (21.3.1) Collecting setuptools<58.3.0 Downloading setuptools-58.2.0-py3-none-any.whl (946 kB) Installing collected packages: setuptools Attempting uninstall: setuptools Found existing installation: setuptools 59.6.0 Uninstalling setuptools-59.6.0: Successfully uninstalled setuptools-59.6.0 Successfully installed setuptools-58.2.0 [rtd-command-info] start-time: 2022-09-16T16:24:47.272912Z, end-time: 2022-09-16T16:24:55.559071Z, duration: 8, exit-code: 0 python -m pip install --upgrade --no-cache-dir pillow==5.4.1 mock==1.0.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.9.1 recommonmark==0.5.0 sphinx sphinx-rtd-theme readthedocs-sphinx-ext<2.2 Collecting pillow==5.4.1 Downloading Pillow-5.4.1-cp36-cp36m-manylinux1_x86_64.whl (2.0 MB) Collecting mock==1.0.1 Downloading mock-1.0.1.zip (861 kB) Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting alabaster!=0.7.5,<0.8,>=0.7 Downloading alabaster-0.7.12-py2.py3-none-any.whl (14 kB) Collecting commonmark==0.9.1 Downloading commonmark-0.9.1-py2.py3-none-any.whl (51 kB) Collecting recommonmark==0.5.0 Downloading recommonmark-0.5.0-py2.py3-none-any.whl (9.8 kB) Collecting sphinx Downloading Sphinx-5.1.1-py3-none-any.whl (3.2 MB) Collecting sphinx-rtd-theme Downloading sphinx_rtd_theme-1.0.0-py2.py3-none-any.whl (2.8 MB) Collecting readthedocs-sphinx-ext<2.2 Downloading readthedocs_sphinx_ext-2.1.9-py2.py3-none-any.whl (11 kB) Collecting docutils>=0.11 Downloading docutils-0.18.1-py2.py3-none-any.whl (570 kB) Collecting sphinxcontrib-htmlhelp>=2.0.0 Downloading sphinxcontrib_htmlhelp-2.0.0-py2.py3-none-any.whl (100 kB) Collecting Jinja2>=2.3 Downloading Jinja2-3.0.3-py3-none-any.whl (133 kB) Collecting snowballstemmer>=1.1 Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB) Collecting babel>=1.3 Downloading Babel-2.10.3-py3-none-any.whl (9.5 MB) Collecting imagesize Downloading imagesize-1.4.1-py2.py3-none-any.whl (8.8 kB) Collecting sphinxcontrib-applehelp Downloading sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl (121 kB) Collecting importlib-metadata>=4.4 Downloading importlib_metadata-4.8.3-py3-none-any.whl (17 kB) Collecting packaging Downloading packaging-21.3-py3-none-any.whl (40 kB) Collecting requests>=2.5.0 Downloading requests-2.27.1-py2.py3-none-any.whl (63 kB) Collecting sphinxcontrib-qthelp Downloading sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl (90 kB) Collecting sphinxcontrib-devhelp Downloading sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl (84 kB) Collecting Pygments>=2.0 Downloading Pygments-2.13.0-py3-none-any.whl (1.1 MB) Collecting sphinxcontrib-jsmath Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB) Collecting sphinxcontrib-serializinghtml>=1.1.5 Downloading sphinxcontrib_serializinghtml-1.1.5-py2.py3-none-any.whl (94 kB) Collecting docutils>=0.11 Downloading docutils-0.17.1-py2.py3-none-any.whl (575 kB) Collecting pytz>=2015.7 Downloading pytz-2022.2.1-py2.py3-none-any.whl (500 kB) Collecting typing-extensions>=3.6.4 Downloading typing_extensions-4.1.1-py3-none-any.whl (26 kB) Collecting zipp>=0.5 Downloading zipp-3.6.0-py3-none-any.whl (5.3 kB) Collecting MarkupSafe>=2.0 Downloading MarkupSafe-2.0.1-cp36-cp36m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl (30 kB) Collecting idna<4,>=2.5 Downloading idna-3.4-py3-none-any.whl (61 kB) Collecting certifi>=2017.4.17 Downloading certifi-2022.9.14-py3-none-any.whl (162 kB) Collecting charset-normalizer~=2.0.0 Downloading charset_normalizer-2.0.12-py3-none-any.whl (39 kB) Collecting urllib3<1.27,>=1.21.1 Downloading urllib3-1.26.12-py2.py3-none-any.whl (140 kB) Collecting pyparsing!=3.0.5,>=2.0.2 Downloading pyparsing-3.0.9-py3-none-any.whl (98 kB) Building wheels for collected packages: mock 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=23773 sha256=788be649606d06d2996867636731017d4af0411d75f59d6d491d1de45051c9c9 Stored in directory: /tmp/pip-ephem-wheel-cache-1m57z08r/wheels/98/4d/ec/1aa935d28cb63b7b16037fc990302a34244ac3b0601a4e0c00 Successfully built mock Installing collected packages: zipp, urllib3, typing-extensions, pytz, pyparsing, MarkupSafe, idna, charset-normalizer, certifi, sphinxcontrib-serializinghtml, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, snowballstemmer, requests, Pygments, packaging, Jinja2, importlib-metadata, imagesize, docutils, babel, alabaster, sphinx, commonmark, sphinx-rtd-theme, recommonmark, readthedocs-sphinx-ext, pillow, mock Successfully installed Jinja2-3.0.3 MarkupSafe-2.0.1 Pygments-2.13.0 alabaster-0.7.12 babel-2.10.3 certifi-2022.9.14 charset-normalizer-2.0.12 commonmark-0.9.1 docutils-0.17.1 idna-3.4 imagesize-1.4.1 importlib-metadata-4.8.3 mock-1.0.1 packaging-21.3 pillow-5.4.1 pyparsing-3.0.9 pytz-2022.2.1 readthedocs-sphinx-ext-2.1.9 recommonmark-0.5.0 requests-2.27.1 snowballstemmer-2.2.0 sphinx-5.1.1 sphinx-rtd-theme-1.0.0 sphinxcontrib-applehelp-1.0.2 sphinxcontrib-devhelp-1.0.2 sphinxcontrib-htmlhelp-2.0.0 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.3 sphinxcontrib-serializinghtml-1.1.5 typing-extensions-4.1.1 urllib3-1.26.12 zipp-3.6.0 [rtd-command-info] start-time: 2022-09-16T16:24:55.801754Z, end-time: 2022-09-16T16:25:03.075092Z, duration: 7, exit-code: 0 python -m pip install --exists-action=w --no-cache-dir -r requirements.txt Requirement already satisfied: jinja2<3.1.0 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/latest/lib/python3.6/site-packages (from -r requirements.txt (line 1)) (3.0.3) Collecting Sphinx==4.5.0 Downloading Sphinx-4.5.0-py3-none-any.whl (3.1 MB) Requirement already satisfied: sphinx_rtd_theme==1.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/latest/lib/python3.6/site-packages (from -r requirements.txt (line 3)) (1.0.0) Collecting breathe==4.33.1 Downloading breathe-4.33.1-py3-none-any.whl (92 kB) Collecting docutils==0.16 Downloading docutils-0.16-py2.py3-none-any.whl (548 kB) Collecting sphinxcontrib-bibtex==2.4.2 Downloading sphinxcontrib_bibtex-2.4.2-py3-none-any.whl (39 kB) Collecting m2r==0.2.1 Downloading m2r-0.2.1.tar.gz (16 kB) Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting sphinx-copybutton==0.5.0 Downloading sphinx_copybutton-0.5.0-py3-none-any.whl (12 kB) Collecting cloud_sptheme==1.10.1.post20200504175005 Downloading cloud_sptheme-1.10.1.post20200504175005-py2.py3-none-any.whl (91 kB) Collecting regex==2022.3.15 Downloading regex-2022.3.15-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (749 kB) Collecting mistune<2.0.0 Downloading mistune-0.8.4-py2.py3-none-any.whl (16 kB) Collecting beautifulsoup4==4.10.0 Downloading beautifulsoup4-4.10.0-py3-none-any.whl (97 kB) Collecting sphinx-argparse==0.3.1 Downloading sphinx_argparse-0.3.1-py2.py3-none-any.whl (12 kB) Collecting sphinx-notfound-page==0.8 Downloading sphinx_notfound_page-0.8-py3-none-any.whl (15 kB) Collecting sphinx-tabs==3.2.0 Downloading sphinx_tabs-3.2.0-py3-none-any.whl (9.8 kB) Collecting sphinx_lfs_content==1.1.0 Downloading sphinx_lfs_content-1.1.0.tar.gz (3.7 kB) Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Requirement already satisfied: packaging in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/latest/lib/python3.6/site-packages (from Sphinx==4.5.0->-r requirements.txt (line 2)) (21.3) Requirement already satisfied: imagesize in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/latest/lib/python3.6/site-packages (from Sphinx==4.5.0->-r requirements.txt (line 2)) (1.4.1) Requirement already satisfied: Pygments>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/latest/lib/python3.6/site-packages (from Sphinx==4.5.0->-r requirements.txt (line 2)) (2.13.0) Requirement already satisfied: sphinxcontrib-devhelp in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/latest/lib/python3.6/site-packages (from Sphinx==4.5.0->-r requirements.txt (line 2)) (1.0.2) Requirement already satisfied: snowballstemmer>=1.1 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/latest/lib/python3.6/site-packages (from Sphinx==4.5.0->-r requirements.txt (line 2)) (2.2.0) Requirement already satisfied: sphinxcontrib-qthelp in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/latest/lib/python3.6/site-packages (from Sphinx==4.5.0->-r requirements.txt (line 2)) (1.0.3) Requirement already satisfied: babel>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/latest/lib/python3.6/site-packages (from Sphinx==4.5.0->-r requirements.txt (line 2)) (2.10.3) Requirement already satisfied: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/latest/lib/python3.6/site-packages (from Sphinx==4.5.0->-r requirements.txt (line 2)) (0.7.12) Requirement already satisfied: importlib-metadata>=4.4 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/latest/lib/python3.6/site-packages (from Sphinx==4.5.0->-r requirements.txt (line 2)) (4.8.3) Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.5 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/latest/lib/python3.6/site-packages (from Sphinx==4.5.0->-r requirements.txt (line 2)) (1.1.5) Requirement already satisfied: sphinxcontrib-applehelp in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/latest/lib/python3.6/site-packages (from Sphinx==4.5.0->-r requirements.txt (line 2)) (1.0.2) Requirement already satisfied: sphinxcontrib-htmlhelp>=2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/latest/lib/python3.6/site-packages (from Sphinx==4.5.0->-r requirements.txt (line 2)) (2.0.0) Requirement already satisfied: sphinxcontrib-jsmath in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/latest/lib/python3.6/site-packages (from Sphinx==4.5.0->-r requirements.txt (line 2)) (1.0.1) Requirement already satisfied: requests>=2.5.0 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/latest/lib/python3.6/site-packages (from Sphinx==4.5.0->-r requirements.txt (line 2)) (2.27.1) Collecting pybtex>=0.24 Downloading pybtex-0.24.0-py2.py3-none-any.whl (561 kB) Collecting pybtex-docutils>=1.0.0 Downloading pybtex_docutils-1.0.2-py3-none-any.whl (6.3 kB) Collecting dataclasses Downloading dataclasses-0.8-py3-none-any.whl (19 kB) Collecting soupsieve>1.2 Downloading soupsieve-2.3.2.post1-py3-none-any.whl (37 kB) Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/latest/lib/python3.6/site-packages (from jinja2<3.1.0->-r requirements.txt (line 1)) (2.0.1) Requirement already satisfied: pytz>=2015.7 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/latest/lib/python3.6/site-packages (from babel>=1.3->Sphinx==4.5.0->-r requirements.txt (line 2)) (2022.2.1) Requirement already satisfied: zipp>=0.5 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/latest/lib/python3.6/site-packages (from importlib-metadata>=4.4->Sphinx==4.5.0->-r requirements.txt (line 2)) (3.6.0) Requirement already satisfied: typing-extensions>=3.6.4 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/latest/lib/python3.6/site-packages (from importlib-metadata>=4.4->Sphinx==4.5.0->-r requirements.txt (line 2)) (4.1.1) Collecting PyYAML>=3.01 Downloading PyYAML-6.0-cp36-cp36m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl (603 kB) Collecting latexcodec>=1.0.4 Downloading latexcodec-2.0.1-py2.py3-none-any.whl (18 kB) Collecting six Downloading six-1.16.0-py2.py3-none-any.whl (11 kB) Requirement already satisfied: idna<4,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/latest/lib/python3.6/site-packages (from requests>=2.5.0->Sphinx==4.5.0->-r requirements.txt (line 2)) (3.4) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/latest/lib/python3.6/site-packages (from requests>=2.5.0->Sphinx==4.5.0->-r requirements.txt (line 2)) (2022.9.14) Requirement already satisfied: charset-normalizer~=2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/latest/lib/python3.6/site-packages (from requests>=2.5.0->Sphinx==4.5.0->-r requirements.txt (line 2)) (2.0.12) Requirement already satisfied: urllib3<1.27,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/latest/lib/python3.6/site-packages (from requests>=2.5.0->Sphinx==4.5.0->-r requirements.txt (line 2)) (1.26.12) Requirement already satisfied: pyparsing!=3.0.5,>=2.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/envs/latest/lib/python3.6/site-packages (from packaging->Sphinx==4.5.0->-r requirements.txt (line 2)) (3.0.9) Building wheels for collected packages: m2r, sphinx-lfs-content Building wheel for m2r (setup.py): started Building wheel for m2r (setup.py): finished with status 'done' Created wheel for m2r: filename=m2r-0.2.1-py3-none-any.whl size=10477 sha256=b97507933191140fae9d5ce4843782cdfca9987c8f97ecb0c2f59cf6ce62325e Stored in directory: /tmp/pip-ephem-wheel-cache-xalspw5p/wheels/19/5d/39/418a1e8bfe6c4259fa80fb882a2e4c28d940eebbc44ebd1c63 Building wheel for sphinx-lfs-content (setup.py): started Building wheel for sphinx-lfs-content (setup.py): finished with status 'done' Created wheel for sphinx-lfs-content: filename=sphinx_lfs_content-1.1.0-py3-none-any.whl size=4082 sha256=befa80f1da23c835575b7eb0dd02b4973b422141e5a73c8ece972bb4bcb3a9b9 Stored in directory: /tmp/pip-ephem-wheel-cache-xalspw5p/wheels/de/02/58/1e90cc0f3fb6798d5c6cc02883b6b2edf62a0795aa1f9800b2 Successfully built m2r sphinx-lfs-content Installing collected packages: six, PyYAML, latexcodec, pybtex, docutils, Sphinx, soupsieve, pybtex-docutils, mistune, dataclasses, sphinxcontrib-bibtex, sphinx-tabs, sphinx-notfound-page, sphinx-lfs-content, sphinx-copybutton, sphinx-argparse, regex, m2r, cloud-sptheme, breathe, beautifulsoup4 Attempting uninstall: docutils Found existing installation: docutils 0.17.1 Uninstalling docutils-0.17.1: Successfully uninstalled docutils-0.17.1 Attempting uninstall: Sphinx Found existing installation: Sphinx 5.1.1 Uninstalling Sphinx-5.1.1: Successfully uninstalled Sphinx-5.1.1 Successfully installed PyYAML-6.0 Sphinx-4.5.0 beautifulsoup4-4.10.0 breathe-4.33.1 cloud-sptheme-1.10.1.post20200504175005 dataclasses-0.8 docutils-0.16 latexcodec-2.0.1 m2r-0.2.1 mistune-0.8.4 pybtex-0.24.0 pybtex-docutils-1.0.2 regex-2022.3.15 six-1.16.0 soupsieve-2.3.2.post1 sphinx-argparse-0.3.1 sphinx-copybutton-0.5.0 sphinx-lfs-content-1.1.0 sphinx-notfound-page-0.8 sphinx-tabs-3.2.0 sphinxcontrib-bibtex-2.4.2 [rtd-command-info] start-time: 2022-09-16T16:25:04.736244Z, end-time: 2022-09-16T16:25:04.811994Z, duration: 0, exit-code: 0 cat conf.py # Configuration file for the Sphinx documentation builder. # Copyright (c) 2021 Graphcore Ltd. All rights reserved. # # -- Path setup -------------------------------------------------------------- # 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. # import os import re import sys import glob import shutil import datetime from docutils import nodes from docutils.parsers.rst import roles sys.path.insert(0, os.path.abspath(".")) # Used for generating links to Tutorials repo and other version specific URLs SDK_RELEASE="2.6" # TensorFlow versions used for generating version-specific links to GitHub TF2_VER="r2.6" TF1_VER="r1.15" # -- Operations to perform when building on Read The Docs -------------------- if os.environ.get("READTHEDOCS", False): # Get version set by RTD from the environment version = os.environ.get("READTHEDOCS_VERSION", "") # This will be substituted by the script that publishes to RTD project = ( "IPU-POD128 Data Centre Checklist" # Need double quotes because title might include apostrophe ) # If the document uses doxygen, run it now if os.path.isfile("Doxyfile"): if os.system("doxygen"): # Quit if doxygen processing failed exit(1) # Copy the generated html to a directory where it will be # uploaded to Read the Docs so we can link to it in future. src = "doxygen/html" if os.path.exists(src): dst = os.path.join("_html/doxygen") if os.path.exists(dst): shutil.rmtree(dst) # os.makedirs(dst, exist_ok=True) shutil.copytree(src, dst) # , dirs_exist_ok=True) else: # Defined in the local build script version = os.environ.get("VERSION", "0.0.0") project = os.environ.get("DOC_TITLE", "Title") # -- Local extensions -------------------------------------------------------- # PDF display role. In the .rst file, use it as follows: # :pdf:`Document Title ` # Then put the pdf file in the directory `pdf` # This generates a link to the pdf, which will be displayed in the browser def pdf_role(name, rawtext, text, lineno, inliner, options={}, content=[]): title = text link = text m = re.search(r"([^<]+)<([^>]+)>", text) if m: title = m.group(1).strip() link = "_static/" + m.group(2) node = nodes.reference(rawtext, title, refuri=link, **options) return [node, nodes.inline("", " (pdf)")], [] # Mark the text with the class "strike" defined in the stylesheet as strikethorugh text def strikethrough(_role, rawtext, text, _lineno, _inliner, options={}, _content=[]): roles.set_classes(options) options.setdefault("classes", []).append("strike") return [nodes.inline(rawtext, text, **options)], [] def setup(app): app.add_role("pdf", pdf_role) app.add_role("strike", strikethrough) # -- Other project information ----------------------------------------------------- author = "Graphcore Ltd" release = version version_date = f"{version} ({datetime.date.today().isoformat()})" # Projects can define a custom localconf.py file which we import here. This lets # projects define their own configuration, such as nitpicks to ignore. project_conf_file = os.environ.get("PROJECT_CONF_PATH", "") if project_conf_file: print("Exec'ing project conf file:", project_conf_file) with open(project_conf_file, "r") as f: exec(f.read()) # -- General configuration --------------------------------------------------- suppress_warnings = [ "autosectionlabel.*", ] master_doc = "index" today_fmt = "%d %b %Y" autodoc_typehints = "description" autodoc_typehints_format = "short" autodoc_default_options = { "members": None, } # 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.graphviz", "sphinx.ext.ifconfig", "sphinx.ext.napoleon", "breathe", "sphinx.ext.intersphinx", "sphinx.ext.autosectionlabel", "sphinx_copybutton", "cloud_sptheme.ext.table_styling", "sphinx.ext.extlinks", "sphinxarg.ext", "sphinx_tabs.tabs", ] # After installing git-lfs and fetching files, check if there are any wheels to install # The TensorFlow wheels need to be installed in order (so we can't just "pip install *.whl") lfs_content_post_commands = [ 'set -- poptorch*.whl; if [ -f "$1" ] ; then pip install "$1"; fi', 'set -- tensorflow*intel*.whl; if [ "-f" $1 ] ; then pip install "$1"; fi', 'set -- keras*.whl; if [ "-f" $1 ] ; then pip install --force-reinstall --no-deps "$1"; fi', 'set -- ipu_tensorflow_addons*.whl; if [ -f "$1" ] ; then pip install "$1"; fi', ] if os.environ.get("READTHEDOCS", False): extensions.append("notfound.extension") extensions.append("sphinx_lfs_content") sphinx_tabs_disable_tab_closing = True bibtex_bibfiles = ["refs.bib"] if os.path.isfile(bibtex_bibfiles[0]): extensions.append("sphinxcontrib.bibtex") extlinks = { # Link to arXiv abstracts; e.g. :arxiv:`2103.16737` or :arxiv:`Mansfield & Seligman, 2021 <2103.16737>` "arxiv": ("https://arxiv.org/abs/%s", "arXiv %s"), # Link to ONNX operators; e.g. :onnxop:`Add` "onnxop": ("https://github.com/onnx/onnx/blob/main/docs/Operators.md#%s", "ONNX %s"), # Link to docs on Graphcore doc portal; e.g. :gcdoc:`graphcore-glossary` # This is not really necessary now as we have the intersphinx mappings defined below "gcdoc": ("https://docs.graphcore.ai/projects/%s", ""), # Link to Graphcore tutorials on GitHub; e.g. :tutorial:`tutorials/tensorflow2/tensorboard` or :tutorial:`simple_applications/tensorflow/mnist/mnist.py` "tutorials-repo": (f"https://github.com/graphcore/tutorials/blob/sdk-release-{SDK_RELEASE}/", "%s"), # Link to TensorFlow 2 on GitHub "github-tf2": (f"https://github.com/graphcore/tensorflow/tree/{TF2_VER}/sdk-release-{SDK_RELEASE}/", "%s"), # Link to TensorFlow 1 on GitHub "github-tf1": (f"https://github.com/graphcore/tensorflow/tree/{TF1_VER}/sdk-release-{SDK_RELEASE}/", "%s"), # Link to Keras on GitHub "github-keras": (f"https://github.com/graphcore/keras/tree/{TF2_VER}/sdk-release-{SDK_RELEASE}/", "%s"), # Link to TensorFlow 2 add-ons on GitHub "github-tf2-addons": (f"https://github.com/graphcore/ipu_tensorflow_addons/tree/{TF2_VER}/sdk-release-{SDK_RELEASE}/", "%s"), # Link to TensorFlow 1 add-ons on GitHub "github-tf1-addons": (f"https://github.com/graphcore/ipu_tensorflow_addons/tree/{TF1_VER}/sdk-release-{SDK_RELEASE}/", "%s"), # Link to PopTorch on GitHub "github-poptorch": (f"https://github.com/graphcore/poptorch/tree/sdk-release-{SDK_RELEASE}/", "%s"), # Link to PopART on GitHub "github-popart": (f"https://github.com/graphcore/popart/tree/sdk-release-{SDK_RELEASE}/", "%s"), # Link to PopLibs on GitHub "github-poplibs": (f"https://github.com/graphcore/poplibs/tree/sdk-release-{SDK_RELEASE}/", "%s"), # Link to Poprithms on GitHub "github-poprithms": (f"https://github.com/graphcore/poprithms/tree/sdk-release-{SDK_RELEASE}/", "%s"), } copybutton_prompt_text = r">>> |\.\.\. |\$ " copybutton_prompt_is_regexp = True copybutton_only_copy_prompt_lines = True copybutton_line_continuation_character = "\\" # Intersphinx mapping: keep this in alphabetical order for ease of updating intersphinx_mapping = { # Third party documents "numpy": ("https://numpy.org/doc/stable/", None), "python": ("https://docs.python.org/3", None), "pytorch": ("https://pytorch.org/docs/stable/", None), "pytorch-cpp": ("https://pytorch.org/cppdocs/", None), # Graphcore docs: with the exception of tensorflow1 and tensorflow2, these # are the same as the relevant part of the URL for the document. # (I shortened the TensorFlow ones for ... well, you know, brevity.) # The last URL in each definition is a "fall-back" in case the documentation # has not been published yet: this will have no useful information but will # prevent a 404 error that can break some doc builds. "ai-float-white-paper": ( "https://docs.graphcore.ai/projects/ai-float-white-paper/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "approved-server-list": ( "https://docs.graphcore.ai/projects/graphcore-approved-server-list/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "assembly-programming": ( "https://docs.graphcore.ai/projects/assembly-programming/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "available-memory": ( "https://docs.graphcore.ai/projects/available-memory/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "bert-training": ( "https://docs.graphcore.ai/projects/bert-training/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "bmc-user-guide": ( "https://docs.graphcore.ai/projects/bmc-user-guide/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "bow-2000-datasheet": ( "https://docs.graphcore.ai/projects/bow-2000-datasheet/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "bow-pod-expansion-guide": ( "https://docs.graphcore.ai/projects/bow-pod-expansion-guide/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "bow-pod-getting-started": ( "https://docs.graphcore.ai/projects/bow-pod-getting-started/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "bow-pod16-datasheet": ( "https://docs.graphcore.ai/projects/bow-pod16-datasheet/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "bow-pod256-datasheet": ( "https://docs.graphcore.ai/projects/bow-pod256-datasheet/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), #"bow-pod16-build-and-test": ( # "https://docs.graphcore.ai/projects/bow-pod16-build-and-test/en/latest/", # (None, "https://docs.graphcore.ai/en/latest/objects.inv") #), "bow-podda-build-test": ( "https://docs.graphcore.ai/projects/bow-podda-build-test/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "bow-pod64-build-and-test": ( "https://docs.graphcore.ai/projects/bow-pod64-build-and-test/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "bow-pod256-build-and-test": ( "https://docs.graphcore.ai/projects/bow-pod256-build-and-test/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "bow-pod64-datasheet": ( "https://docs.graphcore.ai/projects/bow-pod64-datasheet/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "cloud-native-ipu-pod-systems": ( "https://docs.graphcore.ai/projects/cloud-native-ipu-pod-systems/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "cla": ( "https://docs.graphcore.ai/projects/cla/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "command-line-tools": ( "https://docs.graphcore.ai/projects/command-line-tools/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "custom-ops": ( "https://docs.graphcore.ai/projects/custom-ops/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "eula": ( "https://docs.graphcore.ai/projects/eula/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "dynamic-sparsity": ( "https://docs.graphcore.ai/projects/dynamic-sparsity/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "gcl-api": ( "https://docs.graphcore.ai/projects/gcl-api/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "gcipuinfo": ( "https://docs.graphcore.ai/projects/gcipuinfo/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "glossary": ( "https://docs.graphcore.ai/projects/graphcore-glossary/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "graph-analyser-userguide": ( "https://docs.graphcore.ai/projects/graph-analyser-userguide/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "g-core-labs-cloud-getting-started": ( "https://docs.graphcore.ai/projects/g-core-labs-cloud-getting-started/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "paperspace-getting-started": ( "https://docs.graphcore.ai/projects/paperspace-getting-started/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "graphcloud-getting-started": ( "https://docs.graphcore.ai/projects/graphcloud-getting-started/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "graphcloud-about-quick-start": ( "https://docs.graphcore.ai/projects/graphcloud-about-quick-start/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "graphcloud-access-quick-start": ( "https://docs.graphcore.ai/projects/graphcloud-access-quick-start/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "graphcloud-monitoring-hardware-quick-start": ( "https://docs.graphcore.ai/projects/graphcloud-monitoring-hardware-quick-start/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "graphcloud-jupyter-notebook-quick-start": ( "https://docs.graphcore.ai/projects/graphcloud-jupyter-notebook-quick-start/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "graphcloud-popart-quick-start": ( "https://docs.graphcore.ai/projects/graphcloud-popart-quick-start/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "graphcloud-poplar-quick-start": ( "https://docs.graphcore.ai/projects/graphcloud-poplar-quick-start/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "graphcloud-pytorch-quick-start": ( "https://docs.graphcore.ai/projects/graphcloud-pytorch-quick-start/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "graphcloud-monitoring-programs-quick-start": ( "https://docs.graphcore.ai/projects/graphcloud-monitoring-programs-quick-start/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "graphcloud-setup-quick-start": ( "https://docs.graphcore.ai/projects/graphcloud-setup-quick-start/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "graphcloud-tensorflow1-quick-start": ( "https://docs.graphcore.ai/projects/graphcloud-tensorflow1-quick-start/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "graphcloud-tensorflow2-quick-start": ( "https://docs.graphcore.ai/projects/graphcloud-tensorflow2-quick-start/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "ipu-m2000-datasheet": ( "https://docs.graphcore.ai/projects/graphcore-ipu-m2000-datasheet/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "icu-recovery-mode": ( "https://docs.graphcore.ai/projects/icu-recovery-mode/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "ipu-pod-da-getting-started": ( "https://docs.graphcore.ai/projects/ipu-pod-da-getting-started/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "ipu-pod-getting-started": ( "https://docs.graphcore.ai/projects/ipu-pod-getting-started/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "ipu-pod16-datasheet": ( "https://docs.graphcore.ai/projects/ipu-pod16-datasheet/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "ipu-pod64-build-test": ( "https://docs.graphcore.ai/projects/ipu-pod64-build-test/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "ipu-pod64-datacentre-checklist": ( "https://docs.graphcore.ai/projects/ipu-pod64-datacentre-checklist/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "ipu-pod64-datasheet": ( "https://docs.graphcore.ai/projects/ipu-pod64-datasheet/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "ipu-pod64-integration": ( "https://docs.graphcore.ai/projects/ipu-pod64-integration/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "ipu-pod128-build-test": ( "https://docs.graphcore.ai/projects/ipu-pod128-build-test/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "ipu-pod128-datacentre-checklist": ( "https://docs.graphcore.ai/projects/ipu-pod128-datacentre-checklist/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "ipu-pod128-datasheet": ( "https://docs.graphcore.ai/projects/ipu-pod128-datasheet/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "ipu-pod-expansion-guide": ( "https://docs.graphcore.ai/projects/ipu-pod-expansion-guide/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "ipu-podda-build-test": ( "https://docs.graphcore.ai/projects/ipu-podda-build-test/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "ipu-programmers-guide": ( "https://docs.graphcore.ai/projects/ipu-programmers-guide/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "isa": ( "https://docs.graphcore.ai/projects/isa/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "libpva": ( "https://docs.graphcore.ai/projects/libpva/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "libpvti": ( "https://docs.graphcore.ai/projects/libpvti/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "memory-performance-optimisation": ( "https://docs.graphcore.ai/projects/memory-performance-optimisation/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "model-runtime": ( "https://docs.graphcore.ai/projects/model-runtime/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "openstack-ref-design": ( "https://docs.graphcore.ai/projects/openstack-ref-design/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "pod-deployment-datacentre-checklist": ( "https://docs.graphcore.ai/projects/pod-deployment-datacentre-checklist/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "pod-maintenance-guide": ( "https://docs.graphcore.ai/projects/pod-maintenance-guide/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "popart-cpp-api": ( "https://docs.graphcore.ai/projects/popart-cpp-api/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "popart-python-api": ( "https://docs.graphcore.ai/projects/popart-python-api/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "popart-user-guide": ( "https://docs.graphcore.ai/projects/popart-user-guide/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "popef": ( "https://docs.graphcore.ai/projects/popef/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "poplar-api": ( "https://docs.graphcore.ai/projects/poplar-api/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "poplar-triton-backend": ( "https://docs.graphcore.ai/projects/poplar-triton-backend/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "poplar-docker": ( "https://docs.graphcore.ai/projects/poplar-docker/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "poplar-user-guide": ( "https://docs.graphcore.ai/projects/poplar-user-guide/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "poprun-user-guide": ( "https://docs.graphcore.ai/projects/poprun-user-guide/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "poptorch-user-guide": ( "https://docs.graphcore.ai/projects/poptorch-user-guide/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "popvision-user-guide": ( "https://docs.graphcore.ai/projects/graphcore-popvision-user-guide/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "popxl": ( "https://docs.graphcore.ai/projects/popxl/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "porting-tf-models": ( "https://docs.graphcore.ai/projects/porting-tf-models/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "porting-tf2-models-quick-start": ( "https://docs.graphcore.ai/projects/porting-tf2-models-quick-start/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "profile-data": ( "https://docs.graphcore.ai/projects/profile-data/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "pure-storage-ref-design": ( "https://docs.graphcore.ai/projects/pure-storage-ref-design/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "weka-data-platform": ( "https://docs.graphcore.ai/projects/weka-data-platform/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "ddn-storage": ( "https://docs.graphcore.ai/projects/ddn-storage/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "rack-tool": ( "https://docs.graphcore.ai/projects/rack-tool/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "release-notes": ( "https://docs.graphcore.ai/projects/release-notes/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "sdk-overview": ( "https://docs.graphcore.ai/projects/sdk-overview/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "system-analyser-userguide": ( "https://docs.graphcore.ai/projects/system-analyser-userguide/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "switched-gwlinks": ( "https://docs.graphcore.ai/projects/switched-gwlinks/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "tensorflow1": ( "https://docs.graphcore.ai/projects/tensorflow1-user-guide/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "tensorflow2": ( "https://docs.graphcore.ai/projects/tensorflow-user-guide/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "tensorflow-serving1": ( "https://docs.graphcore.ai/projects/tensorflow-serving1/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "tensorflow-serving2": ( "https://docs.graphcore.ai/projects/tensorflow-serving2/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "tf-model-parallelism": ( "https://docs.graphcore.ai/projects/tf-model-parallelism/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "tf-recompilation": ( "https://docs.graphcore.ai/projects/tf-recompilation/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "vipu-admin": ( "https://docs.graphcore.ai/projects/vipu-admin/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), "vipu-user": ( "https://docs.graphcore.ai/projects/vipu-user/en/latest/", (None, "https://docs.graphcore.ai/en/latest/objects.inv"), ), } # Content for the 404 notfound extension on Read The Docs notfound_context = { "title": "Page not found", "body": """

Page not found

Sorry, we could find the page you were looking for.

Try returning to the documentation home page and searching from there.

""", } # Use the root project for resources and links (see T45222) notfound_urls_prefix = "/en/latest/" napoleon_google_docstring = True breathe_projects = { "project": "doxygen/xml", } breathe_default_project = "project" breathe_show_enumvalue_initializer = True breathe_default_members = ("members", "undoc-members") cpp_index_common_prefix = [ "poplar::core::", "poplar::detail::", "poplar::layout::", "poplar::traits::", "poplar::program::", "poplin::fc::", "poplin::matmul::", "poplin::multiconv::", "popnn::bn::", "popnn::gn::", "popnn::gru::", "popnn::in::", "popnn::ln::", "popnn::lstm::", "popnn::matmul::", "popnn::pooling::", "popnn::rnn::", "popops::architecture::", "popops::embedding::", "popops::expr::", "popops::rearrange::", "popsparse::dynamic::", "popsparse::experimental::", "poputil::graphfn::", "popef::", "poplar::", "poplin::", "popnn::", "popops::", "poprand::", "popsparse::", "poputil::", "poplibs::", "popart::", "popdist::", "gcl::", "pva::preview::", "pva::", "pvti::", "gcipuinfo::", "IPUAttributeLabels::", ] modindex_common_prefix = [ "tensorflow.python.ipu", "tensorflow.python.", "tensorflow.", "popart.", "poptorch.", "popdist.", "pva.", ] # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. exclude_patterns = [] default_role = "code" # Internationalization gettext_uuid = True gettext_compact = False locale_dirs = ["locales"] # Define abbreviations for IPU-PODn names with subscripts # These use non-breaking hyphens & spaces, so be careful if editing or adding new definitions pod_sizes = [2**i for i in range(2, 14)] + ["N"] pod_definitions = [ f".. |POD{i}| replace:: IPU‑POD\\ :subscript:`{i}`" for i in pod_sizes ] bow_definitions = [ f".. |BOW{i}| replace:: Bow Pod\\ :subscript:`{i}`" for i in pod_sizes ] rst_epilog = ( "\n".join(pod_definitions) + "\n" + "\n".join(bow_definitions) + r""" .. role:: raw-html(raw) :format: html .. |POD| replace:: IPU‑POD .. |BOW| replace:: Bow Pod .. |newpage| raw:: latex \newpage .. |LEGAL:EULA| replace:: This software is made available under the terms of the `Graphcore End User License Agreement (EULA) `__. Please ensure you have read and accept the terms of the license before using the software. .. |LEGAL:TRADEMARkS| replace:: Graphcloud®, Graphcore® and Poplar® are registered trademarks of Graphcore Ltd. :raw-html:`

` Bow™, Bow-2000™, Bow Pod™, Colossus™, In-Processor-Memory™, IPU-Core™, IPU-Exchange™, IPU-Fabric™, IPU-Link™, IPU-M2000™, IPU-Machine™, IPU-POD™, IPU-Tile™, PopART™, PopDist™, PopLibs™, PopRun™, PopVision™, PopTorch™, Streaming Memory™ and Virtual-IPU™ are trademarks of Graphcore Ltd. :raw-html:`

` All other trademarks are the property of their respective owners. """ + f".. |YEAR| replace:: {datetime.date.today().year}" + "\n" + f".. |SDK_RELEASE| replace:: {SDK_RELEASE}" "\n" ) # f".. |date| replace:: {datetime.date.today().isoformat()}" + # "\n" + # f".. |datetime| replace:: {datetime.datetime.today().isoformat(timespec='seconds')}" + # "\n" # f".. |title| replace:: {project}" + # "\n" # -- 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 = "sphinx_rtd_theme" html_theme_options = { "logo_only": False, "navigation_depth": 5, "collapse_navigation": False, } html_favicon = "_static/favicon.png" # Enable numbered figures and cross references numfig = True numfig_format = { "section": "Section {number}, {name}", "figure": "Fig. %s", "table": "Table %s", "code-block": "Listing %s", } # Path to custom robots.txt etc if os.path.isdir("_html"): html_extra_path = ["_html"] # 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_static_path = ["_static"] if os.path.isdir("pdf"): html_static_path.append("pdf") # CSS file to create the Graphcore style plus optional css local to each document html_css_files = ["css/custom_rtd.css"] if os.path.isfile("_static/css/local.css"): html_css_files.append("css/local.css") html_js_files = [ "js/graphcore.js", ] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". html_title = project # The name of an image file (relative to this directory) to place at the top # of the sidebar. html_logo = "_static/graphcorelogo-html.png" # If true, convert quotes and dashes to # typographically correct entities. smartquotes = True # If true, links to the reST sources are added to the pages. html_show_sourcelink = False # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. html_show_sphinx = False # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. html_show_copyright = False # -- Options for LaTeX output --------------------------------------------- # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_class = "manual" latex_documents = [ ("index", "doc.tex", os.environ.get("DOC_TITLE"), author, latex_class), ] # The name of an image file (relative to this directory) to place at the top of # the title page. latex_logo = "_static/graphcorelogo.pdf" latex_additional_files = [ "_static/graphcoresymbol.pdf", ] latex_show_pagerefs = False latex_show_urls = "no" latex_elements = { # Reduce code block font size as we have some very long lines "fvset": r"\fvset{fontsize=\footnotesize}", # Options to pass to packages "passoptionstopackages": r"\PassOptionsToPackage{dvipsnames, table, xcdraw}{xcolor}", # Set up margins for geometry "sphinxsetup": """ hmargin={19mm, 19mm}, vmargin={26mm, 26mm}, warningBorderColor={HTML}{FF6F79}, noteBorderColor={HTML}{D9D9D9}, VerbatimBorderColor={HTML}{D9D9D9}, TitleColor={HTML}{292C31}, """, # The paper size ('letterpaper' or 'a4paper'). "papersize": "a4paper", # Save paper and screen space "extraclassoptions": "openany,oneside", # Keep figures where they are placed "figure_align": "H", "releasename": "Version", # The font size ('10pt', '11pt' or '12pt'). "pointsize": "10pt", # API docs have a problem with the default depth "maxlistdepth": "20", # Make text in index smaller to account for the unreasonably long entries "printindex": r"\footnotesize\raggedright\printindex", # Additional stuff for the LaTeX preamble. "preamble": r""" %% Set maximum depth of numbered headings \setcounter{tocdepth}{2} \setcounter{secnumdepth}{2} %% Experimental: Optionally add list of figures, list of tables, etc to TOC \usepackage{etoolbox} \providebool{include-toc} \booltrue{include-toc} \providebool{include-lot} \providebool{include-lof} \makeatletter \renewcommand{\sphinxtableofcontents}{% % % before resetting page counter, let's do the right thing. \if@openright\cleardoublepage\else\clearpage\fi \pagenumbering{roman}% \ifbool{include-toc} { \begingroup \parskip \z@skip \tableofcontents \endgroup }{} % %% Additional lists \ifbool{include-lof} { \if@openright\cleardoublepage\else\clearpage\fi \addcontentsline{toc}{chapter}{List of Figures}% \listoffigures }{} % \ifbool{include-lot} { \if@openright\cleardoublepage\else\clearpage\fi \addcontentsline{toc}{chapter}{List of tables}% \listoftables }{} % \if@openright\cleardoublepage\else\clearpage\fi \pagenumbering{arabic}% } \makeatother %% Table captions and headers \makeatletter \definecolor{gcgrey}{HTML}{FAF8F9} \usepackage[font=bf]{caption} \protected\def\sphinxstyletheadfamily{\cellcolor{gcgrey} \py@HeaderFamily \py@TitleColor} \renewcommand{\arraystretch}{1.5} %% Set fonts \renewcommand{\familydefault}{\sfdefault} \usepackage{charter} \usepackage[defaultsans]{lato} \usepackage{inconsolata} %% One-column index to cope with long, fully resolved names \renewenvironment{theindex}{ \chapter*{\indexname} \markboth{\MakeUppercase\indexname}{\MakeUppercase\indexname} \setlength{\parskip}{0.1em} \relax \let\item\@idxitem }{} \makeatother %% Set up page headers and footers \usepackage{fancyhdr} \pagestyle{fancy} \setlength\headheight{45pt} \fancypagestyle{normal}{ \fancyhf{} \fancyhead[L]{\includegraphics[width=10mm]{graphcoresymbol}} \fancyhead[R]{\large """ + project + r""" \\ } \fancyfoot[L]{Version: """ + version_date + r"""} \fancyfoot[R]{\thepage} \renewcommand{\headrulewidth}{0.5pt} \renewcommand{\footrulewidth}{0.5pt} } \fancypagestyle{plain}{% \fancyhf{} \fancyfoot[L]{Version: """ + version_date + r"""} \fancyfoot[R]{\thepage} \renewcommand{\headrulewidth}{0pt} \renewcommand{\footrulewidth}{0.5pt} } """, } ########################################################################### # 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') # 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': "latest", 'version_slug': "latest", 'MEDIA_URL': "https://media.readthedocs.com/media/", 'STATIC_URL': "https://assets.readthedocs.com/", 'PRODUCTION_DOMAIN': "readthedocs.com", 'proxied_static_path': "/_/static/", 'versions': [ ("latest", "/en/latest/"), ("1.0.0", "/en/1.0.0/"), ], 'downloads': [ ], 'subprojects': [ ], 'slug': 'graphcore-ipu-pod128-data-centre-checklist', 'name': u'IPU-POD128 Data Centre Checklist', 'rtd_language': u'en', 'programming_language': u'words', 'canonical_url': 'https://docs.graphcore.ai/projects/ipu-pod128-datacentre-checklist/en/latest/', 'analytics_code': 'UA-82396948-1', 'single_version': False, 'conf_py_path': '/', 'api_host': 'https://readthedocs.com', 'github_user': 'gc-docs', 'proxied_api_host': '/_', 'github_repo': 'ipu-pod128-datacentre-checklist', 'github_version': 'master', 'display_github': True, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': 'master', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': 'master', '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': 'UA-82396948-1', 'global_analytics_code': 'UA-17997319-2', 'commit': 'abaca324', } # 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/graphcore-ipu-pod128-data-centre-checklist/builds/1101331/' 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: 2022-09-16T16:25:05.075389Z, end-time: 2022-09-16T16:25:10.436698Z, duration: 5, exit-code: 0 python -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html Running Sphinx v4.5.0 loading translations [en]... done making output directory... done Updated Git hooks. Git LFS initialized. fetch: Fetching reference HEAD loading intersphinx inventory from https://numpy.org/doc/stable/objects.inv... loading intersphinx inventory from https://docs.python.org/3/objects.inv... loading intersphinx inventory from https://pytorch.org/docs/stable/objects.inv... loading intersphinx inventory from https://pytorch.org/cppdocs/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ai-float-white-paper/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/graphcore-approved-server-list/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/assembly-programming/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/available-memory/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/bert-training/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/bmc-user-guide/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/bow-2000-datasheet/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/bow-pod-expansion-guide/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/bow-pod-getting-started/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/bow-pod16-datasheet/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/bow-pod256-datasheet/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/bow-podda-build-test/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/bow-pod64-build-and-test/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/bow-pod256-build-and-test/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/bow-pod64-datasheet/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/cloud-native-ipu-pod-systems/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/cla/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/command-line-tools/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/custom-ops/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/eula/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/dynamic-sparsity/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/gcl-api/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/gcipuinfo/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/graphcore-glossary/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/graph-analyser-userguide/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/g-core-labs-cloud-getting-started/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/paperspace-getting-started/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/graphcloud-getting-started/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/graphcloud-about-quick-start/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/graphcloud-access-quick-start/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/graphcloud-monitoring-hardware-quick-start/en/latest/objects.inv... intersphinx inventory has moved: https://docs.graphcore.ai/projects/gcl-api/en/latest/objects.inv -> https://readthedocs.com/cas/login?service=https%3A%2F%2Fdocs.graphcore.ai%2Fprojects%2Fgcl-api%2Fen%2Flatest%2Fobjects.inv%3Fnext%3Dhttps%253A%252F%252Fdocs.graphcore.ai%252Fprojects%252Fgcl-api%252Fen%252Flatest%252Fobjects.inv&subproject=gcl-api loading intersphinx inventory from https://docs.graphcore.ai/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/graphcloud-jupyter-notebook-quick-start/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/graphcloud-popart-quick-start/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/graphcloud-poplar-quick-start/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/graphcloud-pytorch-quick-start/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/graphcloud-monitoring-programs-quick-start/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/graphcloud-setup-quick-start/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/graphcloud-tensorflow1-quick-start/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/graphcloud-tensorflow2-quick-start/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/graphcore-ipu-m2000-datasheet/en/latest/objects.inv... encountered some issues with some of the inventories, but they had working alternatives: intersphinx inventory 'https://docs.graphcore.ai/projects/gcl-api/en/latest/objects.inv' not readable due to ValueError: unknown or unsupported inventory version: ValueError('invalid inventory header: ',) loading intersphinx inventory from https://docs.graphcore.ai/projects/icu-recovery-mode/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod-da-getting-started/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod-getting-started/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod16-datasheet/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod64-build-test/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod64-datacentre-checklist/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod64-datasheet/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod64-integration/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod128-build-test/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod128-datacentre-checklist/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod128-datasheet/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-pod-expansion-guide/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-podda-build-test/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ipu-programmers-guide/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/isa/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/libpva/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/libpvti/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/memory-performance-optimisation/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/model-runtime/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/openstack-ref-design/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/pod-deployment-datacentre-checklist/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/pod-maintenance-guide/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/popart-cpp-api/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/popart-python-api/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/popart-user-guide/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/popef/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/poplar-api/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/poplar-triton-backend/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/poplar-docker/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/poplar-user-guide/en/latest/objects.inv... intersphinx inventory has moved: https://docs.graphcore.ai/projects/model-runtime/en/latest/objects.inv -> https://readthedocs.com/cas/login?service=https%3A%2F%2Fdocs.graphcore.ai%2Fprojects%2Fmodel-runtime%2Fen%2Flatest%2Fobjects.inv%3Fnext%3Dhttps%253A%252F%252Fdocs.graphcore.ai%252Fprojects%252Fmodel-runtime%252Fen%252Flatest%252Fobjects.inv&subproject=model-runtime loading intersphinx inventory from https://docs.graphcore.ai/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/poprun-user-guide/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/poptorch-user-guide/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/graphcore-popvision-user-guide/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/popxl/en/latest/objects.inv... encountered some issues with some of the inventories, but they had working alternatives: intersphinx inventory 'https://docs.graphcore.ai/projects/model-runtime/en/latest/objects.inv' not readable due to ValueError: unknown or unsupported inventory version: ValueError('invalid inventory header: ',) loading intersphinx inventory from https://docs.graphcore.ai/projects/porting-tf-models/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/porting-tf2-models-quick-start/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/profile-data/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/pure-storage-ref-design/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/weka-data-platform/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/ddn-storage/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/rack-tool/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/release-notes/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/sdk-overview/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/system-analyser-userguide/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/switched-gwlinks/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/tensorflow1-user-guide/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/tensorflow-user-guide/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/tensorflow-serving1/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/tensorflow-serving2/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/tf-model-parallelism/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/tf-recompilation/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/vipu-admin/en/latest/objects.inv... loading intersphinx inventory from https://docs.graphcore.ai/projects/vipu-user/en/latest/objects.inv... building [mo]: targets for 0 po files that are out of date building [html]: targets for 2 source files that are out of date updating environment: [new config] 2 added, 0 changed, 0 removed reading sources... [ 50%] index reading sources... [100%] legal looking for now-outdated files... none found pickling environment... done checking consistency... /home/docs/checkouts/readthedocs.org/user_builds/graphcore-ipu-pod128-data-centre-checklist/checkouts/latest/legal.rst: WARNING: document isn't included in any toctree done preparing documents... done writing output... [ 50%] index writing output... [100%] legal generating indices... genindex done writing additional pages... search done copying static files... done copying extra files... done dumping search index in English (code: en)... done dumping object inventory... done build succeeded, 1 warning. The HTML pages are in _build/html. Updating searchtools for Read the Docs search...