Files
rocm-systems/docs/sphinx/_toc.yml.in
T
Istvan Kiss 3d60bd3a64 SWDEV-490062 - Update documentation
Change-Id: Ib5297fdda2e05795b3b20436cc1de962e310b08b
2024-10-30 06:03:47 -04:00

115 wiersze
4.6 KiB
Plaintext

# Anywhere {branch} is used, the branch name will be substituted.
# These comments will also be removed.
defaults:
numbered: False
maxdepth: 6
root: index
subtrees:
- caption: Install
entries:
- file: install/install
title: Installing HIP
- file: install/build
title: Building HIP from source
- caption: Conceptual
entries:
- file: understand/programming_model
- file: understand/hardware_implementation
- file: understand/amd_clr
- file: understand/texture_fetching
title: Texture fetching
- caption: How to
entries:
- file: how-to/programming_manual
- file: how-to/hip_porting_guide
- file: how-to/hip_porting_driver_api
- file: how-to/hip_rtc
- file: how-to/performance_guidelines
- file: how-to/debugging
- file: how-to/logging
- file: how-to/cooperative_groups
- file: how-to/unified_memory
title: Unified memory
- file: how-to/virtual_memory
title: Virtual memory
- file: how-to/stream_ordered_allocator
- file: how-to/hipgraph
title: HIP graphs
- file: how-to/faq
- caption: Reference
entries:
- file: reference/hip_runtime_api_reference
subtrees:
- entries:
- file: reference/hip_runtime_api/modules
subtrees:
- entries:
- file: reference/hip_runtime_api/modules/initialization_and_version
- file: reference/hip_runtime_api/modules/device_management
- file: reference/hip_runtime_api/modules/execution_control
- file: reference/hip_runtime_api/modules/error_handling
- file: reference/hip_runtime_api/modules/stream_management
- file: reference/hip_runtime_api/modules/stream_memory_operations
- file: reference/hip_runtime_api/modules/event_management
- file: reference/hip_runtime_api/modules/memory_management
subtrees:
- entries:
- file: reference/hip_runtime_api/modules/memory_management/memory_management_deprecated
- file: reference/hip_runtime_api/modules/memory_management/external_resource_interoperability
- file: reference/hip_runtime_api/modules/memory_management/stream_ordered_memory_allocator
- file: reference/hip_runtime_api/modules/memory_management/unified_memory_reference
- file: reference/hip_runtime_api/modules/memory_management/virtual_memory_reference
- file: reference/hip_runtime_api/modules/memory_management/texture_management
- file: reference/hip_runtime_api/modules/memory_management/texture_management_deprecated
- file: reference/hip_runtime_api/modules/memory_management/surface_object
- file: reference/hip_runtime_api/modules/peer_to_peer_device_memory_access
- file: reference/hip_runtime_api/modules/context_management
- file: reference/hip_runtime_api/modules/module_management
- file: reference/hip_runtime_api/modules/occupancy
- file: reference/hip_runtime_api/modules/profiler_control
- file: reference/hip_runtime_api/modules/launch_api
- file: reference/hip_runtime_api/modules/runtime_compilation
- file: reference/hip_runtime_api/modules/callback_activity_apis
- file: reference/hip_runtime_api/modules/graph_management
- file: reference/hip_runtime_api/modules/opengl_interoperability
- file: reference/hip_runtime_api/modules/cooperative_groups_reference
- file: reference/hip_runtime_api/global_defines_enums_structs_files
subtrees:
- entries:
- file: reference/hip_runtime_api/global_defines_enums_structs_files/global_enum_and_defines
- file: reference/hip_runtime_api/global_defines_enums_structs_files/driver_types
- file: doxygen/html/annotated
- file: doxygen/html/files
- file: reference/virtual_rocr
- file: reference/cpp_language_extensions
title: C++ language extensions
- file: reference/cpp_language_support
title: C++ language support
- file: reference/math_api
- file: reference/terms
title: Comparing syntax for different APIs
- file: reference/deprecated_api_list
title: List of deprecated APIs
- file: reference/fp8_numbers
title: FP8 numbers in HIP
- caption: Tutorials
entries:
- url: https://github.com/ROCm/rocm-examples/tree/develop/HIP-Basic
title: HIP basic examples
- url: https://github.com/ROCm/HIP-Examples
title: HIP examples
- url: https://github.com/ROCm/hip-tests/tree/develop/samples
title: HIP test samples
- file: tutorial/saxpy
- file: tutorial/reduction
- file: tutorial/cooperative_groups_tutorial
- caption: About
entries:
- file: license.md