ROCm/docs/sphinx/_toc.yml.in

# Anywhere {branch} is used, the branch name will be substituted.
# These comments will also be removed.
defaults:
  numbered: False
  maxdepth: 6
root: index
subtrees:
- entries:
  - file: what-is-rocm.rst
  - file: about/release-notes.md
    title: Release notes
  - file: compatibility/compatibility-matrix.rst
    title: Compatibility matrix
    entries:
    - url: https://rocm.docs.amd.com/projects/install-on-linux/en/${branch}/reference/system-requirements.html
      title: Linux system requirements
    - url: https://rocm.docs.amd.com/projects/install-on-windows/en/${branch}/reference/system-requirements.html
      title: Windows system requirements

- caption: Install
  entries:
  - url: https://rocm.docs.amd.com/projects/install-on-linux/en/${branch}/
    title: ROCm on Linux
  - url: https://rocm.docs.amd.com/projects/install-on-windows/en/${branch}/
    title: HIP SDK on Windows
  - url: https://rocm.docs.amd.com/projects/radeon/en/latest/index.html
    title: ROCm on Radeon GPUs
  - file: how-to/deep-learning-rocm.md
    title: Deep learning frameworks
  - file: how-to/build-rocm.rst
    title: Build ROCm from source

- caption: How to
  entries:
  - file: how-to/programming_guide.rst
    title: Programming guide
  - file: how-to/rocm-for-ai/index.rst
    title: Use ROCm for AI
    subtrees:
    - entries:
      - file: how-to/rocm-for-ai/install.rst
        title: Installation
      - file: how-to/rocm-for-ai/train-a-model.rst
        title: Train a model
      - file: how-to/rocm-for-ai/hugging-face-models.rst
        title: Run models from Hugging Face
      - file: how-to/rocm-for-ai/deploy-your-model.rst
        title: Deploy your model
  - file: how-to/rocm-for-hpc/index.rst
    title: Use ROCm for HPC
  - file: how-to/llm-fine-tuning-optimization/index.rst
    title: Fine-tune LLMs and inference optimization
    subtrees:
    - entries:
      - file: how-to/llm-fine-tuning-optimization/overview.rst
        title: Conceptual overview
      - file: how-to/llm-fine-tuning-optimization/fine-tuning-and-inference.rst
        subtrees:
        - entries:
          - file: how-to/llm-fine-tuning-optimization/single-gpu-fine-tuning-and-inference.rst
            title: Use a single accelerator
          - file: how-to/llm-fine-tuning-optimization/multi-gpu-fine-tuning-and-inference.rst
            title: Use multiple accelerators
      - file: how-to/llm-fine-tuning-optimization/model-quantization.rst
      - file: how-to/llm-fine-tuning-optimization/model-acceleration-libraries.rst
      - file: how-to/llm-fine-tuning-optimization/llm-inference-frameworks.rst
      - file: how-to/llm-fine-tuning-optimization/optimizing-with-composable-kernel.md
        title: Optimize with Composable Kernel
      - file: how-to/llm-fine-tuning-optimization/optimizing-triton-kernel.rst
        title: Optimize Triton kernels
      - file: how-to/llm-fine-tuning-optimization/profiling-and-debugging.rst
        title: Profile and debug
  - file: how-to/system-optimization/index.rst
    title: System optimization
    subtrees:
    - entries:
      - file: how-to/system-optimization/mi300x.rst
        title: AMD Instinct MI300X
      - file: how-to/system-optimization/mi300a.rst
        title: AMD Instinct MI300A
      - file: how-to/system-optimization/mi200.md
        title: AMD Instinct MI200
      - file: how-to/system-optimization/mi100.md
        title: AMD Instinct MI100
      - file: how-to/system-optimization/w6000-v620.md
        title: AMD RDNA 2
  - file: how-to/tuning-guides/mi300x/index.rst
    title: AMD MI300X performance validation and tuning
    subtrees:
    - entries:
      - file: how-to/performance-validation/mi300x/vllm-benchmark.rst
        title: Performance validation
      - file: how-to/tuning-guides/mi300x/system.rst
        title: System tuning
      - file: how-to/tuning-guides/mi300x/workload.rst
        title: Workload tuning
  - url: https://rocm.docs.amd.com/projects/gpu-cluster-networking/en/${branch}/index.html
    title: GPU cluster networking
  - file: how-to/gpu-enabled-mpi.rst
    title: Use MPI
  - file: how-to/system-debugging.md
  - file: conceptual/compiler-topics.md
    title: Use advanced compiler features
    subtrees:
    - entries:
      - url: https://rocm.docs.amd.com/projects/llvm-project/en/latest/index.html
        title: ROCm compiler infrastructure
      - url: https://rocm.docs.amd.com/projects/llvm-project/en/latest/conceptual/using-gpu-sanitizer.html
        title: Use AddressSanitizer
      - url: https://rocm.docs.amd.com/projects/llvm-project/en/latest/conceptual/openmp.html
        title: OpenMP support
  - file: how-to/setting-cus
    title: Set the number of CUs  
  - url: https://github.com/amd/rocm-examples
    title: ROCm examples

- caption: Conceptual
  entries:
  - file: conceptual/gpu-arch.md
    title: GPU architecture overview
    subtrees:
    - entries:
      - file: conceptual/gpu-arch/mi300.md
        title: MI300 microarchitecture
        subtrees:
        - entries:
          - url: https://www.amd.com/content/dam/amd/en/documents/instinct-tech-docs/instruction-set-architectures/amd-instinct-mi300-cdna3-instruction-set-architecture.pdf
            title: AMD Instinct MI300/CDNA3 ISA
          - url: https://www.amd.com/content/dam/amd/en/documents/instinct-tech-docs/white-papers/amd-cdna-3-white-paper.pdf
            title: White paper
          - file: conceptual/gpu-arch/mi300-mi200-performance-counters.rst
            title: MI300 and MI200 Performance counter
      - file: conceptual/gpu-arch/mi250.md
        title: MI250 microarchitecture
        subtrees:
        - entries:
          - url: https://www.amd.com/system/files/TechDocs/instinct-mi200-cdna2-instruction-set-architecture.pdf
            title: AMD Instinct MI200/CDNA2 ISA
          - url: https://www.amd.com/system/files/documents/amd-cdna2-white-paper.pdf
            title: White paper
      - file: conceptual/gpu-arch/mi100.md
        title: MI100 microarchitecture
        subtrees:
        - entries:
          - url: https://www.amd.com/system/files/TechDocs/instinct-mi100-cdna1-shader-instruction-set-architecture%C2%A0.pdf
            title: AMD Instinct MI100/CDNA1 ISA
          - url: https://www.amd.com/system/files/documents/amd-cdna-whitepaper.pdf
            title: White paper
  - file: conceptual/gpu-memory.md
    title: GPU memory
  - file: conceptual/file-reorg.md
    title: File structure (Linux FHS)
  - file: conceptual/gpu-isolation.md
    title: GPU isolation techniques
  - file: conceptual/cmake-packages.rst
    title: Using CMake
  - file: conceptual/More-about-how-ROCm-uses-PCIe-Atomics.rst
    title: ROCm & PCIe atomics
  - file: conceptual/ai-pytorch-inception.md
    title: Inception v3 with PyTorch
  - file: conceptual/oversubscription.rst
    title: Oversubscription of hardware resources

- caption: Reference
  entries:
    - file: reference/api-libraries.md
      title: ROCm libraries
    - file: reference/rocm-tools.md
      title: ROCm tools, compilers, and runtimes
    - file: reference/gpu-arch-specs.rst
      title: Hardware specifications
    - file: reference/precision-support.rst
      title: Precision support

- caption: Contribute
  entries:
  - file: contribute/contributing.md
    title: Contributing to the ROCm docmentation
    subtrees:
    - entries:
      - file: contribute/toolchain.md
        title: ROCm documentation toolchain
      - file: contribute/building.md
  - file: contribute/feedback.md
    title: Providing feedback about the ROCm documentation
  - file: about/license.md
    title: ROCm licenses