Deployed 4814fde with MkDocs version: 1.6.1

_generator/api/conf.py

@@ -0,0 +1,248 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- 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 sys
+import re
+
+sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath('_ext'))
+sys.path.insert(0, os.path.abspath('.'))
+
+# -- Project information -----------------------------------------------------
+
+project = u'Collective Mind (CM)'
+copyright = u'2022-2024 MLCommons'
+author = u'Grigori Fursin'
+
+version=''
+release=version
+
+edit_on_github_url='https://github.com'
+edit_on_github_project = 'mlcommons/ck/tree/master/docs/'
+
+kernel_file=os.path.join('..', '..', '..', 'cm', 'cmind', '__init__.py')
+
+with open(kernel_file, encoding="utf-8") as f:
+    search = re.search(r'__version__ = ["\']([^"\']+)', f.read())
+
+    if not search:
+       raise ValueError("We can't find the Collective Mind version in cmind/__init__.py")
+
+    version = search.group(1)
+
+
+# -- 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.autosummary',
+    'sphinx.ext.doctest',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.githubpages',
+    'recommonmark',
+    'sphinx.ext.napoleon',
+    'sphinx_markdown_tables'
+]
+
+autosummary_generate = True
+
+# Napoleon settings
+napoleon_google_docstring = True
+napoleon_numpy_docstring = False
+napoleon_include_init_with_doc = False
+napoleon_include_private_with_doc = False
+napoleon_include_special_with_doc = True
+napoleon_use_admonition_for_examples = True
+napoleon_use_admonition_for_notes = True
+napoleon_use_admonition_for_references = True
+napoleon_use_ivar = False
+napoleon_use_param = False
+napoleon_use_rtype = False
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+source_suffix = ['.rst', '.md', '.html']
+#source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# 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 = 
+
+# 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 = [u'_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# -- 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_show_sourcelink = False
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+html_theme_options = {
+ 'style_nav_header_background': 'black',
+ 'collapse_navigation': False, 
+ 'style_external_links': True,
+ 'analytics_id': 'UA-5727962-14',  #  Provided by Google in your dashboard
+}
+
+html_context = {
+    "display_github": True,
+    "github_user": "mlcommons",
+    "github_repo": "ck",
+    "github_version": "master/docs/",
+}
+
+html_logo = 'static/logo.png'
+
+# 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']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'CMindDoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    'papersize': 'a4paper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'cmind.tex', u'Collective Mind',
+     u'Grigori Fursin', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'cmind.tex', u'Collective Mind',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'cmind.tex', u'Collective Mind',
+     author, 'CM', 'common-research-languge', 'reusability', 'automation', 'mlops2devops', 'mlops', 'devops'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for intersphinx extension ---------------------------------------
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'https://docs.python.org/': None}
+
+# -- Options for todo extension ----------------------------------------------
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+autoclass_content = 'both'
+
+def setup(app):
+#    app.add_stylesheet('css/custom.css') 
+    app.add_css_file('css/custom.css')

_generator/api/generate.bat

@@ -0,0 +1,16 @@
+@ECHO OFF
+
+rd /Q /S api
+
+sphinx-apidoc -f -T -o api ../../../cm/cmind
+
+cm replace_string_in_file utils --input=api/cmind.rst --string="cmind package" --replacement="CM python package API"
+
+sphinx-build -M html . api
+
+cd api/html
+tar cf api.tar *
+bzip2 api.tar
+
+move api.tar.bz2 ../..
+

_generator/api/generate.sh

@@ -0,0 +1,11 @@
+rm -rf api
+
+sphinx-apidoc -H "CM python package API" -f -T -o api ../../../cm/cmind
+
+sphinx-build -M html . api
+
+cd api/html
+tar cf api.tar *
+bzip2 api.tar
+
+move api.tar.bz2 ../..

_generator/api/index.rst

@@ -0,0 +1,13 @@
+.. Copyright 2021-2024 MLCommons
+
+.. CM documentation master file
+
+.. toctree::
+   :maxdepth: 2
+
+   api/cmind
+
+Index
+=====
+
+* :ref:`genindex`

_generator/api/static/css/custom.css

@@ -0,0 +1,6 @@
+/* adds scrollbar to sidenav */
+.wy-side-scroll {
+  width: auto;
+  scrollbar-width:thin;
+  overflow-y: auto;
+}

_generator/generate_api.bat

@@ -0,0 +1,4 @@
+pip install sphinx recommonmark sphinx_markdown_tables sphinx_rtd_theme
+
+cd api
+generate.bat

_generator/generate_api.sh

@@ -0,0 +1,4 @@
+pip install sphinx recommonmark sphinx_markdown_tables sphinx_rtd_theme
+
+cd api
+./generate.sh

_generator/generate_toc.cmd

@@ -0,0 +1,38 @@
+cd ../tutorials
+
+cm create-toc-from-md utils --input=scc23-mlperf-inference-bert.md
+cm create-toc-from-md utils --input=sc22-scc-mlperf.md
+cm create-toc-from-md utils --input=sc22-scc-mlperf-part2.md
+cm create-toc-from-md utils --input=sc22-scc-mlperf-part3.md
+cm create-toc-from-md utils --input=mlperf-inference-submission.md
+cm create-toc-from-md utils --input=concept.md
+cm create-toc-from-md utils --input=reproduce-mlperf-tiny.md
+cm create-toc-from-md utils --input=automate-mlperf-tiny.md
+cm create-toc-from-md utils --input=reproduce-mlperf-training.md
+cm create-toc-from-md utils --input=common-interface-to-reproduce-research-projects.md
+
+cd ../artifact-evaluation
+
+cm create-toc-from-md utils --input=faq.md
+
+cd ../
+
+cm create-toc-from-md utils --input=taskforce.md
+cm create-toc-from-md utils --input=installation.md
+cm create-toc-from-md utils --input=faq.md
+cm create-toc-from-md utils --input=README.md
+cm create-toc-from-md utils --input=getting-started.md
+
+cd mlperf/inference
+
+cm create-toc-from-md utils --input=README.md
+
+cd ../../../
+cd cm-mlops/project/mlperf-inference-v3.0-submissions/docs
+cm create-toc-from-md utils --input=crowd-benchmark-mlperf-bert-inference-cuda.md
+
+cd ../../../automation/script
+cm create-toc-from-md utils --input=README-extra.md
+
+cd ../experiment
+cm create-toc-from-md utils --input=README-extra.md

_generator/list_automations.cmd

@@ -0,0 +1 @@
+cm doc automation --output_dir=..

_generator/list_scripts.cmd

@@ -0,0 +1 @@
+cm doc script --output_dir=..

_generator/list_scripts_test.cmd

@@ -0,0 +1 @@
+cm doc script app-loadgen-generic-python --output_dir=..