mirror of
https://github.com/ROCm/ROCm.git
synced 2026-01-09 06:38:00 -05:00
7b883f3af4
* Add MI300X tuning guides Add mi300x doc (pandoc conversion) fix headings add metadata move images to shared/ move images to shared/ convert tuning-guides.md to rst using pandoc add mi300x to tuning-guides.rst landing page update h1s, toc, and landing page fix spelling fix fmt format code blocks add tensilelite imgs fix formatting fix formatting some more fix formatting more formatting spelling remove --enforce-eager note satisfy spellcheck linter more spelling add fixes from hongxia fix env var in D5 add fixes to PyTorch inductor section fix fix Update docs/how-to/tuning-guides/mi300x.rst Co-authored-by: Hongxia Yang <62075498+hongxiayang@users.noreply.github.com> Update docs/how-to/tuning-guides/mi300x.rst Co-authored-by: Hongxia Yang <62075498+hongxiayang@users.noreply.github.com> Update docs/how-to/tuning-guides/mi300x.rst Co-authored-by: Hongxia Yang <62075498+hongxiayang@users.noreply.github.com> Update docs/how-to/tuning-guides/mi300x.rst Co-authored-by: Hongxia Yang <62075498+hongxiayang@users.noreply.github.com> Update docs/how-to/tuning-guides/mi300x.rst Co-authored-by: Hongxia Yang <62075498+hongxiayang@users.noreply.github.com> Update docs/how-to/tuning-guides/mi300x.rst Co-authored-by: Hongxia Yang <62075498+hongxiayang@users.noreply.github.com> Update docs/how-to/tuning-guides/mi300x.rst Co-authored-by: Hongxia Yang <62075498+hongxiayang@users.noreply.github.com> Update docs/how-to/tuning-guides/mi300x.rst Co-authored-by: Hongxia Yang <62075498+hongxiayang@users.noreply.github.com> Update docs/how-to/tuning-guides/mi300x.rst Co-authored-by: Hongxia Yang <62075498+hongxiayang@users.noreply.github.com> Update docs/how-to/tuning-guides/mi300x.rst Co-authored-by: Hongxia Yang <62075498+hongxiayang@users.noreply.github.com> Update docs/how-to/tuning-guides/mi300x.rst Co-authored-by: Hongxia Yang <62075498+hongxiayang@users.noreply.github.com> Update docs/how-to/tuning-guides/mi300x.rst Co-authored-by: Hongxia Yang <62075498+hongxiayang@users.noreply.github.com> Update 'torch_compile_debug' suggestion based on Hongxia's feedback fix PyTorch inductor env vars minor formatting fixes Apply suggestions from code review Co-authored-by: Hongxia Yang <62075498+hongxiayang@users.noreply.github.com> Update vllm path Co-authored-by: Hongxia Yang <62075498+hongxiayang@users.noreply.github.com> disable numfig in Sphinx configuration fix formatting and capitalization add words to wordlist update index update wordlist update optimizing-triton-kernel convert cards to table fix link in index.md add @lpaoletti's feedback Add system tuning guide add images add system section add os settings and sys management remove pcie=noats recommendation reorg add blurb to developer section impr formatting remove windows os from tuning guides pages in conf.py add suggestions from review fix typo and link remove os windows from relevant pages in conf mi300x add suggestions from review fix toc fix index links reorg update vLLM vars Co-authored-by: Hongxia Yang <62075498+hongxiayang@users.noreply.github.com> update vLLM vars Co-authored-by: Hongxia Yang <62075498+hongxiayang@users.noreply.github.com> reorganize add warnings add text to system tuning add filler text on index pages reorg tuning pages fix links fix vars * rm old pages fix toc * add suggestions from review small change add more suggestions rewrite intro * add 'workload tuning philosophy' * refactor * fix broken links * black format conf.py * simplify cmd and update doc structure * add higher-level heading for consistency (mi300x.rst) * add fixes from review fix url add fixes fix formatting fix fmt fix hipBLASLt section change words fix tensilelite section fix fix fix fmt * style guide * fix some formatting * satisfy spellcheck linter * update wordlist * fix bad conflict resolution
109 lines
3.9 KiB
Python
109 lines
3.9 KiB
Python
# 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
|
|
|
|
import shutil
|
|
|
|
# Keep capitalization due to similar linking on GitHub's markdown preview.
|
|
shutil.copy2("../RELEASE.md", "./about/release-notes.md")
|
|
shutil.copy2("../CHANGELOG.md", "./about/changelog.md")
|
|
|
|
latex_engine = "xelatex"
|
|
latex_elements = {
|
|
"fontpkg": r"""
|
|
\usepackage{tgtermes}
|
|
\usepackage{tgheros}
|
|
\renewcommand\ttdefault{txtt}
|
|
"""
|
|
}
|
|
|
|
# configurations for PDF output by Read the Docs
|
|
project = "ROCm Documentation"
|
|
author = "Advanced Micro Devices, Inc."
|
|
copyright = "Copyright (c) 2024 Advanced Micro Devices, Inc. All rights reserved."
|
|
version = "6.1.2"
|
|
release = "6.1.2"
|
|
setting_all_article_info = True
|
|
all_article_info_os = ["linux", "windows"]
|
|
all_article_info_author = ""
|
|
|
|
# pages with specific settings
|
|
article_pages = [
|
|
{"file": "about/release-notes", "os": ["linux", "windows"], "date": "2024-06-04"},
|
|
{"file": "about/changelog", "os": ["linux", "windows"], "date": "2024-06-04"},
|
|
{"file": "how-to/deep-learning-rocm", "os": ["linux"]},
|
|
{"file": "how-to/rocm-for-ai/index", "os": ["linux"]},
|
|
{"file": "how-to/rocm-for-ai/install", "os": ["linux"]},
|
|
{"file": "how-to/rocm-for-ai/train-a-model", "os": ["linux"]},
|
|
{"file": "how-to/rocm-for-ai/deploy-your-model", "os": ["linux"]},
|
|
{"file": "how-to/rocm-for-ai/hugging-face-models", "os": ["linux"]},
|
|
{"file": "how-to/rocm-for-hpc/index", "os": ["linux"]},
|
|
{"file": "how-to/llm-fine-tuning-optimization/index", "os": ["linux"]},
|
|
{"file": "how-to/llm-fine-tuning-optimization/overview", "os": ["linux"]},
|
|
{
|
|
"file": "how-to/llm-fine-tuning-optimization/fine-tuning-and-inference",
|
|
"os": ["linux"],
|
|
},
|
|
{
|
|
"file": "how-to/llm-fine-tuning-optimization/single-gpu-fine-tuning-and-inference",
|
|
"os": ["linux"],
|
|
},
|
|
{
|
|
"file": "how-to/llm-fine-tuning-optimization/multi-gpu-fine-tuning-and-inference",
|
|
"os": ["linux"],
|
|
},
|
|
{
|
|
"file": "how-to/llm-fine-tuning-optimization/llm-inference-frameworks",
|
|
"os": ["linux"],
|
|
},
|
|
{
|
|
"file": "how-to/llm-fine-tuning-optimization/model-acceleration-libraries",
|
|
"os": ["linux"],
|
|
},
|
|
{"file": "how-to/llm-fine-tuning-optimization/model-quantization", "os": ["linux"]},
|
|
{
|
|
"file": "how-to/llm-fine-tuning-optimization/optimizing-with-composable-kernel",
|
|
"os": ["linux"],
|
|
},
|
|
{
|
|
"file": "how-to/llm-fine-tuning-optimization/optimizing-triton-kernel",
|
|
"os": ["linux"],
|
|
},
|
|
{
|
|
"file": "how-to/llm-fine-tuning-optimization/profiling-and-debugging",
|
|
"os": ["linux"],
|
|
},
|
|
{"file": "how-to/system-optimization/index", "os": ["linux"]},
|
|
{"file": "how-to/system-optimization/mi300x", "os": ["linux"]},
|
|
{"file": "how-to/system-optimization/mi200", "os": ["linux"]},
|
|
{"file": "how-to/system-optimization/mi100", "os": ["linux"]},
|
|
{"file": "how-to/system-optimization/w6000-v620", "os": ["linux"]},
|
|
{"file": "how-to/tuning-guides/mi300x/index", "os": ["linux"]},
|
|
{"file": "how-to/tuning-guides/mi300x/system", "os": ["linux"]},
|
|
{"file": "how-to/tuning-guides/mi300x/workload", "os": ["linux"]},
|
|
{"file": "how-to/system-debugging", "os": ["linux"]},
|
|
{"file": "how-to/gpu-enabled-mpi", "os": ["linux"]},
|
|
]
|
|
|
|
external_toc_path = "./sphinx/_toc.yml"
|
|
|
|
extensions = ["rocm_docs", "sphinx_reredirects"]
|
|
|
|
external_projects_current_project = "rocm"
|
|
|
|
html_theme = "rocm_docs_theme"
|
|
html_theme_options = {"flavor": "rocm-docs-home"}
|
|
|
|
html_static_path = ["sphinx/static/css"]
|
|
html_css_files = ["rocm_custom.css"]
|
|
|
|
html_title = "ROCm Documentation"
|
|
|
|
html_theme_options = {"link_main_doc": False}
|
|
|
|
redirects = {"reference/openmp/openmp": "../../about/compatibility/openmp.html"}
|
|
|
|
numfig = False
|