mirror of
https://github.com/microsoft/mscclpp.git
synced 2026-05-11 17:00:22 +00:00
5acac93dbc
Provides two integration ways for MSCCL++ DSL. 1. Integrate with customized communication group 2. Integrate with NCCL API Introduce new Python APIs to make it work: ```python mscclpp.compile # compile dsl to json based execution plan mscclpp.ExecutionPlanRegistry.register_plan(plan) # register the compiled plan to executionPlanRegistery mscclpp.ExecutionPlanRegistry.set_selector(selector) # set the selector, the selector will return the best execution plan based on collection, message size, world size.... ``` Fix #556 --------- Co-authored-by: Caio Rocha <caiorocha@microsoft.com> Co-authored-by: Changho Hwang <changhohwang@microsoft.com>
77 lines
2.5 KiB
Python
77 lines
2.5 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# For the full list of built-in configuration values, see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
|
|
# -- Path setup --------------------------------------------------------------
|
|
import sys
|
|
import importlib.util
|
|
from pathlib import Path
|
|
|
|
# Add the python package to sys.path so Sphinx can find it
|
|
project_root = Path(__file__).parent.parent
|
|
python_path = project_root / "python"
|
|
sys.path.insert(0, str(python_path))
|
|
|
|
# -- Project version -----------------------------------------------------
|
|
spec = importlib.util.spec_from_file_location("_version", python_path / "mscclpp" / "_version.py")
|
|
version_module = importlib.util.module_from_spec(spec)
|
|
spec.loader.exec_module(version_module)
|
|
version = version_module.__version__
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
|
|
|
project = "mscclpp"
|
|
copyright = "2025, MSCCL++ Team"
|
|
author = "MSCCL++ Team"
|
|
release = "v" + version
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
|
|
extensions = [
|
|
"breathe",
|
|
"myst_parser",
|
|
"sphinxcontrib.mermaid",
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.autosummary",
|
|
"sphinx.ext.napoleon",
|
|
"sphinx.ext.intersphinx",
|
|
"sphinx_autodoc_typehints",
|
|
]
|
|
|
|
autosummary_generate = True
|
|
autodoc_default_options = {
|
|
"members": True,
|
|
"inherited-members": True,
|
|
"show-inheritance": True,
|
|
}
|
|
# only mock the C-extension when using the source tree
|
|
autodoc_mock_imports = ["mscclpp._version", "mscclpp._mscclpp", "blake3", "cupy", "mpi4py", "numpy", "sortedcontainers"]
|
|
autodoc_typehints = "description"
|
|
napoleon_google_docstring = True
|
|
napoleon_numpy_docstring = True
|
|
intersphinx_mapping = {
|
|
"python": ("https://docs.python.org/3", None),
|
|
"numpy": ("https://numpy.org/doc/stable/", None),
|
|
}
|
|
|
|
templates_path = ["_templates"]
|
|
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
|
|
|
|
# Breathe configuration
|
|
breathe_projects = {"mscclpp": "./doxygen/xml"}
|
|
breathe_default_project = "mscclpp"
|
|
|
|
# Mermaid configuration
|
|
mermaid_version = "11.0.0"
|
|
mermaid_init_js = "mermaid.initialize({startOnLoad:true});"
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
|
|
|
html_theme = "sphinx_rtd_theme"
|
|
html_static_path = ["_static"]
|