Skip to content

Commit

Permalink
Squash and apply doc/config updates to rocm-rel-6.2
Browse files Browse the repository at this point in the history
Consolidate updates from amd-master to release/rocm-rel-6.2 branch.

Change-Id: I60c2d94a447b71ca0ce26a87b7f55b055b8bef9e
  • Loading branch information
abhimeda authored and ShwetakAMD committed Jul 18, 2024
1 parent d1efacb commit 6c8d92d
Show file tree
Hide file tree
Showing 17 changed files with 722 additions and 2 deletions.
6 changes: 4 additions & 2 deletions .azuredevops/rocm-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ trigger:
batch: true
branches:
include:
- master
- amd-staging
- amd-master
paths:
exclude:
- .github
Expand All @@ -31,7 +32,8 @@ pr:
autoCancel: true
branches:
include:
- master
- amd-staging
- amd-master
paths:
exclude:
- .github
Expand Down
6 changes: 6 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
* @dayatsin-amd @shwetagkhatri
# Documentation files
docs/* @ROCm/rocm-documentation @dayatsin-amd @shwetagkhatri
*.md @ROCm/rocm-documentation @dayatsin-amd @shwetagkhatri
*.rst @ROCm/rocm-documentation @dayatsin-amd @shwetagkhatri
.readthedocs.yaml @ROCm/rocm-documentation @dayatsin-amd @shwetagkhatri
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
179 changes: 179 additions & 0 deletions .github/ISSUE_TEMPLATE/issue_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,179 @@
name: Issue Report
description: File a report for ROCm related issues on Linux and Windows. For issues pertaining to documentation or non-bug related, please open a blank issue located below.
title: "[Issue]: "

body:
- type: markdown
attributes:
value: |
Thank you for taking the time to fill out this report!
You can acquire your OS, CPU, GPU (for filling out this report) with the following commands:
Linux:
echo "OS:" && cat /etc/os-release | grep -E "^(NAME=|VERSION=)";
echo "CPU: " && cat /proc/cpuinfo | grep "model name" | sort --unique;
echo "GPU:" && /opt/rocm/bin/rocminfo | grep -E "^\s*(Name|Marketing Name)";
Windows:
(Get-WmiObject Win32_OperatingSystem).Version
(Get-WmiObject win32_Processor).Name
(Get-WmiObject win32_VideoController).Name
- type: textarea
attributes:
label: Problem Description
description: Describe the issue you encountered.
validations:
required: true
- type: input
attributes:
label: Operating System
description: What is the name and version number of the OS?
placeholder: "e.g. Ubuntu 22.04.3 LTS (Jammy Jellyfish)"
validations:
required: true
- type: input
attributes:
label: CPU
description: What CPU did you encounter the issue on?
placeholder: "e.g. AMD Ryzen 9 5900HX with Radeon Graphics"
validations:
required: true
- type: dropdown
attributes:
label: GPU
description: What GPU(s) did you encounter the issue on (you can select multiple GPUs from the list)
multiple: true
options:
- AMD Instinct MI300
- AMD Instinct MI300A
- AMD Instinct MI300X
- AMD Instinct MI250X
- AMD Instinct MI250
- AMD Instinct MI210
- AMD Instinct MI100
- AMD Instinct MI50
- AMD Instinct MI25
- AMD Radeon Pro V620
- AMD Radeon Pro VII
- AMD Radeon RX 7900 XTX
- AMD Radeon VII
- AMD Radeon Pro W7900
- AMD Radeon Pro W7800
- AMD Radeon Pro W6800
- AMD Radeon Pro W6600
- AMD Radeon Pro W5500
- AMD Radeon RX 7900 XT
- AMD Radeon RX 7600
- AMD Radeon RX 6950 XT
- AMD Radeon RX 6900 XT
- AMD Radeon RX 6800 XT
- AMD Radeon RX 6800
- AMD Radeon RX 6750
- AMD Radeon RX 6700 XT
- AMD Radeon RX 6700
- AMD Radeon RX 6650 XT
- AMD Radeon RX 6600 XT
- AMD Radeon RX 6600
- Other
validations:
required: true
- type: input
attributes:
label: Other
description: If you selected Other, please specify
- type: dropdown
attributes:
label: ROCm Version
description: What version(s) of ROCm did you encounter the issue on?
multiple: true
options:
- ROCm 6.0.0
- ROCm 5.7.1
- ROCm 5.7.0
- ROCm 5.6.0
- ROCm 5.5.1
- ROCm 5.5.0
validations:
required: true
- type: dropdown
attributes:
label: ROCm Component
description: (Optional) If this issue relates to a specific ROCm component, it can be mentioned here.
options:
- Other
- AMDMIGraphX
- amdsmi
- aomp
- aomp-extras
- clang-ocl
- clr
- composable_kernel
- flang
- half
- HIP
- hipBLAS
- HIPCC
- hipCUB
- HIP-Examples
- hipFFT
- hipfort
- HIPIFY
- hipSOLVER
- hipSPARSE
- hipTensor
- llvm-project
- MIOpen
- MIVisionX
- rccl
- rdc
- rocALUTION
- rocBLAS
- ROCdbgapi
- rocFFT
- ROCgdb
- ROCK-Kernel-Driver
- ROCm
- rocm_bandwidth_test
- rocm_smi_lib
- rocm-cmake
- ROCm-CompilerSupport
- rocm-core
- ROCm-Device-Libs
- rocminfo
- rocMLIR
- ROCmValidationSuite
- rocPRIM
- rocprofiler
- rocr_debug_agent
- rocRAND
- ROCR-Runtime
- rocSOLVER
- rocSPARSE
- rocThrust
- roctracer
- ROCT-Thunk-Interface
- rocWMMA
- rpp
- Tensile
default: 39
- type: textarea
attributes:
label: Steps to Reproduce
description: (Optional) Detailed steps to reproduce the issue.
validations:
required: false

- type: textarea
attributes:
label: (Optional for Linux users) Output of /opt/rocm/bin/rocminfo --support
description: The output of rocminfo --support could help to better address the problem.
validations:
required: false

- type: textarea
attributes:
label: Additional Information
description: (Optional) Any additional information that is relevant, e.g. relevant environment variables, dockerfiles, log files, dmesg output (on Linux), etc.
validations:
required: false
17 changes: 17 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates

version: 2
updates:
- package-ecosystem: "pip" # See documentation for possible values
directory: "/docs/sphinx" # Location of package manifests
open-pull-requests-limit: 10
schedule:
interval: "daily"
labels:
- "documentation"
- "dependencies"
reviewers:
- "samjwu"
18 changes: 18 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

version: 2

sphinx:
configuration: docs/conf.py

formats: [htmlzip, pdf, epub]

python:
install:
- requirements: docs/sphinx/requirements.txt

build:
os: ubuntu-22.04
tools:
python: "3.10"
1 change: 1 addition & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
_build/
29 changes: 29 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

import re


html_theme = "rocm_docs_theme"
html_theme_options = {"flavor": "rocm"}

extensions = ["rocm_docs"]
external_toc_path = "./sphinx/_toc.yml"

with open('../CMakeLists.txt', encoding='utf-8') as f:
match = re.search(r'get_package_version_number\(\"?([0-9.]+)[^0-9.]+', f.read())
if not match:
raise ValueError("VERSION not found!")
version_number = match[1]

version = version_number
release = version_number
html_title = f"rocminfo {version} Documentation"
project = "rocminfo"
author = "Advanced Micro Devices, Inc."
copyright = (
"Copyright (c) 2024 Advanced Micro Devices, Inc. All rights reserved."
)
22 changes: 22 additions & 0 deletions docs/how-to/use-rocm-agent-enumerator.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
.. meta::
:description: agent, enumerator ROCmInfo
:keywords: install, rocminfo, AMD, ROCm, ROCmInfo


Using ROCm agent enumerator
-----------------------------

The rocm_agent_enumerator tool prints the list of available AMD GCN ISA or acthitecture names. With the option ‘-name’, it prints out available architecture names that can be used by third-party scripts to determine which ISAs are needed to execute code on all GPUs in the system.

See the following example output of the rocm_agent_enumerator command on a system with an MI-300X installation,

.. code-block::
gfx000
gfx941
.. Note::

The gfx000 represents the CPU agent.

Loading

0 comments on commit 6c8d92d

Please sign in to comment.