Read the Docs build information Build id: 1971306 Project: cerebras-systems-cerebras-systems-developer-documentation Version: 2.1.1 Commit: b80dd1456e9469ab15d3ba45ab6e497e171253fe Date: 2024-01-24T22:47:28.264913Z State: finished Success: False [rtd-command-info] start-time: 2024-01-24T22:47:29.487920Z, end-time: 2024-01-24T22:47:31.985294Z, duration: 2, exit-code: 0 git clone --depth 1 git@github.com:Cerebras/documentation.git . Cloning into '.'... Warning: Permanently added 'github.com' (ED25519) to the list of known hosts. [rtd-command-info] start-time: 2024-01-24T22:47:32.067806Z, end-time: 2024-01-24T22:47:34.626578Z, duration: 2, exit-code: 0 git fetch origin --force --prune --prune-tags --depth 50 refs/heads/2.1.1:refs/remotes/origin/2.1.1 Warning: Permanently added 'github.com' (ED25519) to the list of known hosts. From github.com:Cerebras/documentation * [new branch] 2.1.1 -> origin/2.1.1 [rtd-command-info] start-time: 2024-01-24T22:47:34.767707Z, end-time: 2024-01-24T22:47:35.008120Z, duration: 0, exit-code: 0 git checkout --force origin/2.1.1 Note: switching to 'origin/2.1.1'. 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 b80dd14 release notes edits [rtd-command-info] start-time: 2024-01-24T22:47:35.082585Z, end-time: 2024-01-24T22:47:35.154460Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2024-01-24T22:47:35.223273Z, end-time: 2024-01-24T22:47:35.282873Z, duration: 0, exit-code: 0 cat .readthedocs.yaml version: 2 build: os: ubuntu-22.04 tools: python: "mambaforge-4.10" conda: environment: external/conda_environment.yml # Build from the docs/ directory with Sphinx sphinx: configuration: external/source/conf.py builder: html [rtd-command-info] start-time: 2024-01-24T22:47:46.668360Z, end-time: 2024-01-24T22:47:46.746202Z, duration: 0, exit-code: 0 asdf global python mambaforge-4.10.3-10 [rtd-command-info] start-time: 2024-01-24T22:47:48.896776Z, end-time: 2024-01-24T22:47:48.954914Z, duration: 0, exit-code: 0 cat external/conda_environment.yml channels: - anaconda - conda-forge - defaults dependencies: - _libgcc_mutex=0.1=main - _openmp_mutex=5.1=1_gnu - alabaster=0.7.12=pyhd3eb1b0_0 - babel=2.9.1=pyhd3eb1b0_0 - brotlipy=0.7.0=py39h27cfd23_1003 - ca-certificates=2022.12.7=ha878542_0 - certifi=2022.12.7=pyhd8ed1ab_0 - cffi=1.15.0=py39hd667e15_1 - charset-normalizer=2.0.4=pyhd3eb1b0_0 - colorama=0.4.4=pyhd3eb1b0_0 - cryptography=37.0.1=py39h9ce1e76_0 - docutils=0.17.1=py39h06a4308_1 - idna=3.3=pyhd3eb1b0_0 - imagesize=1.3.0=pyhd3eb1b0_0 - importlib-metadata=4.11.3=py39h06a4308_0 - jinja2=3.0.3=pyhd3eb1b0_0 - ld_impl_linux-64=2.38=h1181459_1 - libffi=3.3=he6710b0_2 - libgcc-ng=11.2.0=h1234567_1 - libgomp=11.2.0=h1234567_1 - libstdcxx-ng=11.2.0=h1234567_1 - markdown-it-py=2.2.0=pyhd8ed1ab_0 - markupsafe=2.1.1=py39h7f8727e_0 - mdit-py-plugins=0.3.3=pyhd8ed1ab_0 - mdurl=0.1.0=pyhd8ed1ab_0 - myst-parser=0.18.1=pyhd8ed1ab_0 - ncurses=6.3=h7f8727e_2 - openssl=1.1.1t=h7f8727e_0 - packaging=21.3=pyhd3eb1b0_0 - pip=21.2.4=py39h06a4308_0 - pycparser=2.21=pyhd3eb1b0_0 - pygments=2.11.2=pyhd3eb1b0_0 - pyopenssl=22.0.0=pyhd3eb1b0_0 - pyparsing=3.0.4=pyhd3eb1b0_0 - pysocks=1.7.1=py39h06a4308_0 - python=3.9.12=h12debd9_1 - python_abi=3.9=2_cp39 - pytz=2022.1=py39h06a4308_0 - pyyaml=6.0=py39hb9d737c_4 - readline=8.1.2=h7f8727e_1 - requests=2.27.1=pyhd3eb1b0_0 - setuptools=61.2.0=py39h06a4308_0 - snowballstemmer=2.2.0=pyhd3eb1b0_0 - sphinx=4.4.0=pyhd3eb1b0_0 - sphinx-copybutton=0.5.0=pyhd8ed1ab_0 - sphinx-tabs=3.4.1=pyhd8ed1ab_0 - sphinxcontrib-applehelp=1.0.2=pyhd3eb1b0_0 - sphinxcontrib-devhelp=1.0.2=pyhd3eb1b0_0 - sphinxcontrib-htmlhelp=2.0.0=pyhd3eb1b0_0 - sphinxcontrib-jsmath=1.0.1=pyhd3eb1b0_0 - sphinxcontrib-qthelp=1.0.3=pyhd3eb1b0_0 - sphinxcontrib-serializinghtml=1.1.5=pyhd3eb1b0_0 - sqlite=3.38.3=hc218d9a_0 - tk=8.6.12=h1ccaba5_0 - typing-extensions=4.4.0=hd8ed1ab_0 - typing_extensions=4.4.0=pyha770c72_0 - tzdata=2022a=hda174b7_0 - urllib3=1.26.9=py39h06a4308_0 - wheel=0.37.1=pyhd3eb1b0_0 - xz=5.2.5=h7f8727e_1 - yaml=0.2.5=h7f98852_2 - zipp=3.8.0=py39h06a4308_0 - zlib=1.2.12=h7f8727e_2 - pip: - readthedocs-sphinx-ext - beautifulsoup4==4.11.1 - pydata-sphinx-theme==0.8.1 - soupsieve==2.3.2.post1 - sphinx-book-theme==0.3.2 - sphinx-panels==0.6.0 - sphinx name: docs_RTD [rtd-command-info] start-time: 2024-01-24T22:47:49.012404Z, end-time: 2024-01-24T22:49:02.144900Z, duration: 73, exit-code: 0 mamba env create --quiet --name 2.1.1 --file external/conda_environment.yml Package Version Build Channel Size ────────────────────────────────────────────────────────────────────────────────────────────────── Install: ────────────────────────────────────────────────────────────────────────────────────────────────── + _libgcc_mutex 0.1 main anaconda/linux-64 3 KB + _openmp_mutex 5.1 1_gnu anaconda/linux-64 20 KB + alabaster 0.7.12 pyhd3eb1b0_0 anaconda/noarch 16 KB + babel 2.9.1 pyhd3eb1b0_0 anaconda/noarch 6 MB + brotlipy 0.7.0 py39h27cfd23_1003 anaconda/linux-64 349 KB + ca-certificates 2022.12.7 ha878542_0 conda-forge/linux-64 143 KB + certifi 2022.12.7 pyhd8ed1ab_0 conda-forge/noarch 147 KB + cffi 1.15.0 py39hd667e15_1 anaconda/linux-64 226 KB + charset-normalizer 2.0.4 pyhd3eb1b0_0 anaconda/noarch 33 KB + colorama 0.4.4 pyhd3eb1b0_0 anaconda/noarch 21 KB + cryptography 37.0.1 py39h9ce1e76_0 anaconda/linux-64 1 MB + docutils 0.17.1 py39h06a4308_1 anaconda/linux-64 764 KB + idna 3.3 pyhd3eb1b0_0 anaconda/noarch 55 KB + imagesize 1.3.0 pyhd3eb1b0_0 anaconda/noarch 9 KB + importlib-metadata 4.11.3 py39h06a4308_0 anaconda/linux-64 40 KB + jinja2 3.0.3 pyhd3eb1b0_0 anaconda/noarch 99 KB + ld_impl_linux-64 2.38 h1181459_1 anaconda/linux-64 732 KB + libffi 3.3 he6710b0_2 anaconda/linux-64 54 KB + libgcc-ng 11.2.0 h1234567_1 anaconda/linux-64 8 MB + libgomp 11.2.0 h1234567_1 anaconda/linux-64 560 KB + libstdcxx-ng 11.2.0 h1234567_1 anaconda/linux-64 6 MB + markdown-it-py 2.2.0 pyhd8ed1ab_0 conda-forge/noarch 61 KB + markupsafe 2.1.1 py39h7f8727e_0 anaconda/linux-64 22 KB + mdit-py-plugins 0.3.3 pyhd8ed1ab_0 conda-forge/noarch 38 KB + mdurl 0.1.0 pyhd8ed1ab_0 conda-forge/noarch 13 KB + myst-parser 0.18.1 pyhd8ed1ab_0 conda-forge/noarch 48 KB + ncurses 6.3 h7f8727e_2 anaconda/linux-64 1 MB + openssl 1.1.1t h7f8727e_0 anaconda/linux-64 4 MB + packaging 21.3 pyhd3eb1b0_0 anaconda/noarch 35 KB + pip 21.2.4 py39h06a4308_0 anaconda/linux-64 2 MB + pycparser 2.21 pyhd3eb1b0_0 anaconda/noarch 94 KB + pygments 2.11.2 pyhd3eb1b0_0 anaconda/noarch 793 KB + pyopenssl 22.0.0 pyhd3eb1b0_0 anaconda/noarch 49 KB + pyparsing 3.0.4 pyhd3eb1b0_0 anaconda/noarch 78 KB + pysocks 1.7.1 py39h06a4308_0 anaconda/linux-64 31 KB + python 3.9.12 h12debd9_1 anaconda/linux-64 23 MB + python_abi 3.9 2_cp39 conda-forge/linux-64 Cached + pytz 2022.1 py39h06a4308_0 anaconda/linux-64 259 KB + pyyaml 6.0 py39hb9d737c_4 conda-forge/linux-64 178 KB + readline 8.1.2 h7f8727e_1 anaconda/linux-64 423 KB + requests 2.27.1 pyhd3eb1b0_0 anaconda/noarch 52 KB + setuptools 61.2.0 py39h06a4308_0 anaconda/linux-64 1 MB + snowballstemmer 2.2.0 pyhd3eb1b0_0 anaconda/noarch 57 KB + sphinx 4.4.0 pyhd3eb1b0_0 anaconda/noarch 2 MB + sphinx-copybutton 0.5.0 pyhd8ed1ab_0 conda-forge/noarch 15 KB + sphinx-tabs 3.4.1 pyhd8ed1ab_0 conda-forge/noarch 14 KB + sphinxcontrib-applehelp 1.0.2 pyhd3eb1b0_0 anaconda/noarch 29 KB + sphinxcontrib-devhelp 1.0.2 pyhd3eb1b0_0 anaconda/noarch 23 KB + sphinxcontrib-htmlhelp 2.0.0 pyhd3eb1b0_0 anaconda/noarch 33 KB + sphinxcontrib-jsmath 1.0.1 pyhd3eb1b0_0 anaconda/noarch 8 KB + sphinxcontrib-qthelp 1.0.3 pyhd3eb1b0_0 anaconda/noarch 26 KB + sphinxcontrib-serializinghtml 1.1.5 pyhd3eb1b0_0 anaconda/noarch 27 KB + sqlite 3.38.3 hc218d9a_0 anaconda/linux-64 1 MB + tk 8.6.12 h1ccaba5_0 anaconda/linux-64 3 MB + typing-extensions 4.4.0 hd8ed1ab_0 conda-forge/noarch 8 KB + typing_extensions 4.4.0 pyha770c72_0 conda-forge/noarch 29 KB + tzdata 2022a hda174b7_0 anaconda/noarch 121 KB + urllib3 1.26.9 py39h06a4308_0 anaconda/linux-64 177 KB + wheel 0.37.1 pyhd3eb1b0_0 anaconda/noarch 31 KB + xz 5.2.5 h7f8727e_1 anaconda/linux-64 389 KB + yaml 0.2.5 h7f98852_2 conda-forge/linux-64 87 KB + zipp 3.8.0 py39h06a4308_0 anaconda/linux-64 15 KB + zlib 1.2.12 h7f8727e_2 anaconda/linux-64 130 KB Summary: Install: 63 packages Total download: 67 MB ────────────────────────────────────────────────────────────────────────────────────────────────── Preparing transaction: ...working... done Verifying transaction: ...working... done Executing transaction: ...working... done Installing pip dependencies: ...working... done [rtd-command-info] start-time: 2024-01-24T22:49:02.933887Z, end-time: 2024-01-24T22:49:02.991839Z, duration: 0, exit-code: 0 cat external/source/conf.py # Configuration file for the Sphinx documentation builder. # # This file only contains a selection of the most common options. For a full # list see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html # -- Path setup -------------------------------------------------------------- import os import sys sys.path.insert(0, os.path.abspath('.')) sys.path.insert(0, os.path.abspath('source_code/monolith/src/framework/cerebras_pytorch/')) sys.path.insert(0, os.path.abspath('source_code/modelzoo/')) autodoc_mock_imports = [ "PIL", "cerebras_appliance", "datasets", "datasketch", "dill", "ftfy", "git", "grpc", "h5py", "jsonlines", "jsonschema", "keras_preprocessing", "lm_dataformat", "lm_eval", "math", "matplotlib", "more_itertools", "networkit", "nltk", "numpy", "pandas", "pillow", "psutil", "pubmed_parser", "pyarrow", "regex", "sentencepiece", "safetensors", "six", "spacy", "tabulate", "tensorboard", "tensorflow", "tensorflow_addons", "tokenizers", "torch", "torchvision", "tqdm", "transformers", "os", "ujson", "zstandard", ] # Required flag to make `cerebras_pytorch` importable # for auto-documentation generation os.environ["GENERATING_CEREBRAS_PYTORCH_DOCS"] = "1" #from gallery_directive import GalleryDirective import pydata_sphinx_theme # -- Project information ----------------------------------------------------- project = 'Cerebras Developer Documentation' copyright = '2023, Cerebras Systems' author = '' html_title = "Cerebras Developer Documentation" html_logo = "images/CER_logo.svg" html_favicon = 'images/cs-favicon.png' html_last_updated_fmt = '%c' # -- General configuration --------------------------------------------------- # 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_copybutton", "sphinx_panels", "sphinx.ext.extlinks", "sphinx.ext.autodoc", "sphinx.ext.autosectionlabel", "sphinx.ext.napoleon", 'sphinx.ext.autosummary', "sphinx.ext.graphviz", "sphinx.ext.inheritance_diagram", "sphinx.ext.viewcode", "sphinx_tabs.tabs", "myst_parser", ] autoclass_content = 'both' autodoc_class_signature = "separated" add_function_parentheses = False autosummary_ignore_module_all = False # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] copybutton_exclude = '.linenos, .gp, .go' copybutton_copy_empty_lines = False myst_heading_anchors = 4 myst_enable_extensions = ["dollarmath", "amsmath"] html_additional_pages = { # "index": "index.html" } # 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. # Temporarily remove API docs while testing -Raj # exclude_patterns = ["tensorflow-docs/api-rst", "tensorflow-docs/cs-1-tf-user-guide/tf-layers", "tensorflow-docs/cs-1-tf-user-guide/running-a-model/cs-input-analyzer.rst", "tensorflow-docs/getting-started/cs-execution-flow.rst"] exclude_patterns = ["source_code/*"] # -- 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 = "pydata_sphinx_theme" html_theme_path = [] numfig = True panels_add_bootstrap_css = False html_theme_options = { "show_toc_level": 1, "navbar_align": "left", # [left, content, right] For testing that the navbar items align properly } # 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'] html_css_files = [ 'custom.css' ] html_js_files = [ 'feedback.js', ] """ def setup(app): # Add the gallery directive app.add_directive("gallery-grid", GalleryDirective) """ html_sidebars = { "index": [], } extlinks = {'modelzoo': ('https://github.com/Cerebras/modelzoo/tree/main/modelzoo/%s',None)} ########################################################################### # 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': "2.1.1", 'version_slug': "2.1.1", '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/"), ("2.1.1", "/en/2.1.1/"), ("2.1.0", "/en/2.1.0/"), ("2.0.3", "/en/2.0.3/"), ("2.0.2", "/en/2.0.2/"), ("1.9.1", "/en/1.9.1/"), ("1.8.0", "/en/1.8.0/"), ("1.7.1", "/en/1.7.1/"), ("1.7.0", "/en/1.7.0/"), ("1.6.1", "/en/1.6.1/"), ("1.6.0", "/en/1.6.0/"), ("1.5.0", "/en/1.5.0/"), ], 'downloads': [ ], 'subprojects': [ ("cerebras-systems-cerebras-sdk-documentation", "https://docs.cerebras.net/projects/sdk-docs/en/latest/"), ("cerebras-systems-isa-documentation", "https://docs.cerebras.net/projects/isa-docs/en/latest/"), ("cerebras-systems-cerebras-operator-documentation", "https://docs.cerebras.net/projects/operator-docs/en/latest/"), ], 'slug': 'cerebras-systems-cerebras-systems-developer-documentation', 'name': u'Cerebras Systems Developer Documentation', 'rtd_language': u'en', 'programming_language': u'words', 'canonical_url': '', 'analytics_code': 'UA-177830181-2', 'single_version': False, 'conf_py_path': '/external/source/', 'api_host': 'https://readthedocs.com', 'github_user': 'Cerebras', 'proxied_api_host': '/_', 'github_repo': 'documentation', 'github_version': '2.1.1', 'display_github': True, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': '2.1.1', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': '2.1.1', '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-177830181-2', 'global_analytics_code': 'UA-17997319-2', 'commit': 'b80dd145', } # 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 'branch' == 'external': extensions.insert(1, "readthedocs_ext.external_version_warning") readthedocs_vcs_url = 'None' readthedocs_build_url = 'https://readthedocs.com/projects/cerebras-systems-cerebras-systems-developer-documentation/builds/1971306/' 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'])