# 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.md
  - file: about/whats-new/whats-new.md

- caption: Installation
  entries:
  - file: install/windows/install-quick.md
    title: Quick start (Windows)
  - file: install/windows/install.md
    title: Windows install guide
    subtrees:
    - entries:
      - file: install/windows/windows-app-deployment-guidelines.md
        title: Application deployment guidelines
  - file: install/docker.md
    title: ROCm Docker containers
  - file: install/pytorch-install.md
    title: PyTorch for ROCm
  - file: install/tensorflow-install.md
    title: Tensorflow for ROCm
  - file: install/magma-install.md
    title: MAGMA for ROCm
  - file: install/spack-intro.md
    title: ROCm & Spack

- caption: Compatibility & support
  entries:
  - file: about/compatibility/linux-support.md
    title: Linux (GPU & OS)
  - file: about/compatibility/windows-support.md
    title: Windows (GPU & OS)
  - file: about/compatibility/3rd-party-support-matrix.md
    title: Third-party
  - file: about/compatibility/user-kernel-space-compat-matrix.md
    title: User/kernel space support
  - file: about/compatibility/docker-image-support-matrix.rst
    title: Docker
  - file: about/compatibility/openmp.md
    title: OpenMP

- caption: Release information
  entries:
  - file: about/release-notes.md
    title: Release notes
  - file: about/CHANGELOG.md
    title: Changelog
  - file: about/release-history.md
    title: Release history
  - url: https://github.com/RadeonOpenCompute/ROCm/labels/Verified%20Issue
    title: Known issues

- caption: How-to
  entries:
  - file: how-to/deep-learning-rocm.md
    title: Deep learning
  - file: how-to/gpu-enabled-mpi.md
    title: Using MPI
  - file: how-to/system-debugging.md
    title: Debugging
  - file: how-to/tuning-guides.md
    title: Tuning guides
    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
  - url: https://github.com/amd/rocm-examples
    title: GitHub examples

- caption: Reference
  entries:
    - file: reference/library-index.md
      title: API libraries & tools
      subtrees:
      - entries:
        - url: ${project:composable_kernel}
          title: Composable kernel
        - url: ${project:hipblas}
          title: hipBLAS
        - url: ${project:hipblaslt}
          title: hipBLASLt
        - url: ${project:hipcc}
          title: hipCC
        - url: ${project:hipcub}
          title: hipCUB
        - url: ${project:hipfft}
          title: hipFFT
        - url: ${project:hipify}
          title: HIPIFY
        - url: ${project:hiprand}
          title: hipRAND
        - url: ${project:hip}
          title: HIP runtime
        - url: ${project:hipsolver}
          title: hipSOLVER
        - url: ${project:hipsparse}
          title: hipSPARSE
        - url: ${project:hipsparselt}
          title: hipSPARSELt
        - url: ${project:hiptensor}
          title: hipTensor
        - url: ${project:miopen}
          title: MIOpen
        - url: ${project:amdmigraphx}
          title: MIGraphX
        - url: ${project:rccl}
          title: RCCL
        - url: ${project:rocalution}
          title: rocALUTION
        - url: ${project:rocblas}
          title: rocBLAS
        - url: ${project:rocdbgapi}
          title: ROCdbgapi
        - url: ${project:rocfft}
          title: rocFFT
        - file: reference/rocmcc.md
          title: ROCmCC
        - url: ${project:rdc}
          title: ROCm Data Center Tool
        - url: ${project:rocm_smi_lib}
          title: ROCm SMI LIB
        - url: ${project:rocmvalidationsuite}
          title: ROCm validation suite
        - url: ${project:rocprim}
          title: rocPRIM
        - url: ${project:rocprofiler}
          title: ROCProfiler
        - url: ${project:rocrand}
          title: rocRAND
        - url: ${project:rocsolver}
          title: rocSOLVER
        - url: ${project:rocsparse}
          title: rocSPARSE
        - url: ${project:rocthrust}
          title: rocThrust
        - url: ${project:roctracer}
          title: rocTracer
        - url: ${project:rocwmma}
          title: rocWMMA
        - url: ${project:transferbench}
          title: TransferBench

- caption: Conceptual
  entries:
  - file: conceptual/gpu-arch.md
    title: GPU architectures
    subtrees:
    - entries:
      - 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/mi200-performance-counters.md
            title: Performance counter
      - 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/compiler-disambiguation.md
    title: Compiler disambiguation
  - file: conceptual/file-reorg.md
    title: File structure (Linux FHS)
  - file: conceptual/gpu-isolation.md
    title: GPU isolation techniques
  - file: conceptual/using-gpu-sanitizer.md
    title: LLVN ASan
  - 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/index.md
    title: Contribute to ROCm docs
    subtrees:
    - entries:
      - file: contribute/toolchain.md
        title: Documentation tools
      - file: contribute/building.md
        title: Building documentation
      - file: contribute/feedback.md
        title: Providing feedback
  - file: about/license.md
    title: ROCm license