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
    subtrees:
    - entries:
      - file: about/CHANGELOG.md
        title: Changelog
  - url: https://github.com/ROCm/ROCm/labels/Verified%20Issue
    title: Known issues

- 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
  - file: how-to/deep-learning-rocm.md
    title: Deep learning frameworks

- caption: Compatibility
  entries:
  - file: compatibility/compatibility-matrix.rst
    title: Compatibility matrix
  - url: https://rocm.docs.amd.com/projects/install-on-linux/en/${branch}/reference/system-requirements.html
    title: Linux
  - url: https://rocm.docs.amd.com/projects/install-on-windows/en/${branch}/reference/system-requirements.html
    title: Windows
  - file: compatibility/precision-support.rst
    title: Precision support
  - url: https://rocm.docs.amd.com/projects/install-on-linux/en/${branch}/reference/3rd-party-support-matrix.html
    title: Third-party

- caption: Reference
  entries:
    - file: reference/api-libraries.md
      title: API libraries
    - file: reference/rocm-tools.md
      title: Tools
    - file: reference/gpu-arch-specs.rst
      title: Hardware specifications

- caption: How to
  entries:
  - file: how-to/rocm-for-ai/index.rst
    title: Using 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
      - file: how-to/rocm-for-ai/hugging-face-models.rst
      - file: how-to/rocm-for-ai/deploy-your-model.rst
  - file: how-to/tuning-guides.md
    title: System optimization
    subtrees:
    - entries:
      - file: how-to/tuning-guides/mi100.md
        title: MI100
      - file: how-to/tuning-guides/mi200.md
        title: MI200
      - file: how-to/tuning-guides/w6000-v620.md
        title: RDNA2
  - file: how-to/gpu-enabled-mpi.rst
    title: Using MPI
  - file: conceptual/compiler-topics.md
    title: Using compiler features
    subtrees:
    - entries:
      - file: conceptual/using-gpu-sanitizer.md
        title: Using AddressSanitizer
      - file: conceptual/compiler-disambiguation.md
        title: Compiler disambiguation
      - file: about/compatibility/openmp.md
        title: OpenMP support
  - file: how-to/system-debugging.md
    title: Debugging
  - url: https://github.com/amd/rocm-examples
    title: GitHub 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/setting-cus
    title: Setting the number of CUs
  - 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/ai-migraphx-optimization.md
    title: Inference optimization with MIGraphX

- caption: Contribute
  entries:
  - file: contribute/contributing.md
    title: Contribute to ROCm docs
    subtrees:
    - entries:
      - file: contribute/doc-structure.md
        title: Documentation structure
      - file: contribute/toolchain.md
        title: Documentation toolchain
      - file: contribute/building.md
        title: Build our documentation
  - file: contribute/feedback.md
    title: Provide feedback
  - file: about/license.md
    title: ROCm license