Files
TheRock/rocm-systems/projects/amdsmi/docs/sphinx/_toc.yml.in
T
derek.holloway 7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
Flatten subprojects into a single base monorepo
2026-09-02 16:34:47 -07:00

77 lines
2.2 KiB
Plaintext

# Variables of the form ${<variable>} are substituted, currently the following
# list is supported:
# - ${branch} (or {branch}) the name of the current branch
# - ${url} (or {url}) github url of the current project
# - ${project:<project_name>} base url of the documentation of <project_name>
# based on intersphinx_mapping.
# These comments will also be removed.
defaults:
numbered: false
root: index
subtrees:
- caption: Install
entries:
- file: install/install.md
title: Install AMD SMI
- file: install/build.md
title: Build from source
- caption: How to
entries:
- file: how-to/amdsmi-cpp-lib.md
title: C/C++ library usage
- file: how-to/amdsmi-py-lib.md
title: Python library usage
- file: how-to/amdsmi-go-lib.md
title: Go library usage
- file: how-to/amdsmi-cli-tool.md
title: CLI tool usage
- file: how-to/amdsmi-nic-integration.md
title: AI NIC integration
- file: how-to/setup-docker-container.md
title: Use AMD SMI in a Docker container
- caption: Reference
entries:
- file: reference/amdsmi-cpp-api/index.md
title: C/C++ API
entries:
- file: reference/amdsmi-cpp-api/functions.md
title: Functions
- file: reference/amdsmi-cpp-api/types.md
title: Types
- file: reference/amdsmi-cpp-api/defines.md
title: Defines
- file: reference/amdsmi-py-api.md
title: Python API
- file: reference/amdsmi-go-api.md
title: Go API
- file: reference/changelog.md
title: Changelog
- caption: Conceptual
entries:
- file: conceptual/partition.md
title: GPU partitioning
- file: conceptual/gpu-reset-behavior.md
title: GPU reset behavior
- file: conceptual/gpu-violations.md
title: GPU violations
- file: conceptual/perf-determinism.md
title: Performance determinism
- file: conceptual/ras.md
title: Reliability, availability, serviceability (RAS)
- file: conceptual/test-design.md
title: Test suite design
- caption: Tutorials
entries:
- url: https://github.com/ROCm/rocm-systems/tree/develop/projects/amdsmi/example
title: AMD SMI examples (GitHub)
- url: https://rocm.blogs.amd.com/software-tools-optimization/amd-smi-overview/README.html
title: AMD SMI CLI walkthrough
- caption: About
entries:
- file: license.md