github/ROCm
1
1
Fork 0
mirror of https://github.com/ROCm/ROCm.git synced 2026-01-09 22:58:17 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: clean up (#2143)

Browse Source
This commit is contained in:
Nara
2023-05-16 15:27:27 +02:00
committed by GitHub
parent df32eed823
commit 494ba37d87
11 changed files with 130 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
.github/workflows/linting.yml vendored
View File

@@ -2,8 +2,13 @@ name: Linting
on: on:
push: push:
branches:
- develop
- main
pull_request: pull_request:
branches: [develop, main] branches:
- develop
- main
concurrency: concurrency:
group: ${{ github.ref }}-${{ github.workflow }} group: ${{ github.ref }}-${{ github.workflow }}
@@ -30,7 +35,7 @@ jobs:
- name: Use markdownlint - name: Use markdownlint
uses: actionshub/markdownlint@v3.1.3 uses: actionshub/markdownlint@v3.1.3
with: with:
filesToIgnoreRegex: "CHANGELOG.md|RELEASE.md|tools\\/autotag\\/templates\\/." filesToIgnoreRegex: CHANGELOG.md|(docs\/)?(RELEASE|release).md|tools\/autotag\/templates\/.
spelling: spelling:
name: "Spelling" name: "Spelling"

12
.wordlist.txt
View File

@@ -15,3 +15,15 @@ UCX
ib_core ib_core
# isv_deployment_win # isv_deployment_win
ABI ABI
# tuning_guides
BMC
DGEMM
HPCG
IOPM
HPL
# linear algebra
LAPACK
MMA
backends
cuSOLVER
cuSPARSE

3
RELEASE.md
View File

@@ -8,6 +8,9 @@
<!-- markdownlint-disable no-blanks-blockquote --> <!-- markdownlint-disable no-blanks-blockquote -->
<!-- markdownlint-disable ul-indent --> <!-- markdownlint-disable ul-indent -->
<!-- markdownlint-disable no-trailing-spaces --> <!-- markdownlint-disable no-trailing-spaces -->
<!-- spellcheck-disable -->
The release notes for the ROCm platform. The release notes for the ROCm platform.
------------------- -------------------

6
docs/.sphinx/_toc.yml.in
View File

@@ -9,16 +9,16 @@ subtrees:
- file: rocm - file: rocm
- caption: Deploy ROCm - caption: Deploy ROCm
entries: entries:
- file: deploy/linux/quick_start
title: Linux Quick Start
- file: deploy/linux/index - file: deploy/linux/index
title: Linux title: Linux Overview
subtrees: subtrees:
- entries: - entries:
- file: deploy/linux/install_overview.md - file: deploy/linux/install_overview.md
title: Installation Overview title: Installation Overview
- file: deploy/linux/prerequisites - file: deploy/linux/prerequisites
title: Prerequisites title: Prerequisites
- file: deploy/linux/quick_start
title: Quick Start
- file: deploy/linux/install - file: deploy/linux/install
title: Installation title: Installation
- file: deploy/linux/upgrade - file: deploy/linux/upgrade

18
docs/deploy/linux/quick_start.md
View File

@@ -33,8 +33,8 @@ sudo yum install kernel-headers kernel-devel
::: :::
:::{tab-item} SUSE Linux Enterprise Server 15 :::{tab-item} SUSE Linux Enterprise Server
:sync: SLES15 :sync: SLES
```shell ```shell
sudo zypper install kernel-default-devel sudo zypper install kernel-default-devel
@@ -205,14 +205,14 @@ sudo yum clean all
::::: :::::
:::::{tab-item} SUSE Linux Enterprise Server 15 :::::{tab-item} SUSE Linux Enterprise Server
:sync: SLES15 :sync: SLES
::::{rubric} 1. Add the repositories ::::{rubric} 1. Add the repositories
:::: ::::
::::{tab-set} ::::{tab-set}
:::{tab-item} Service Pack 4 :::{tab-item} SLES 15 SP4
:sync: SLES15-SP4 :sync: SLES15-SP4
```shell ```shell
@@ -275,8 +275,8 @@ sudo yum install amdgpu-dkms
::: :::
:::{tab-item} SUSE Linux Enterprise Server 15 :::{tab-item} SUSE Linux Enterprise Server
:sync: SLES15 :sync: SLES
```shell ```shell
sudo zypper install amdgpu-dkms sudo zypper install amdgpu-dkms
@@ -310,8 +310,8 @@ sudo yum install rocm-hip-libraries
::: :::
:::{tab-item} SUSE Linux Enterprise Server 15 :::{tab-item} SUSE Linux Enterprise Server
:sync: SLES15 :sync: SLES
```console shell ```console shell
sudo zypper install rocm-hip-libraries sudo zypper install rocm-hip-libraries

2
docs/how_to/tuning_guides/index.md
View File

@@ -33,7 +33,7 @@ systems (for example, OEM-specific BIOS settings). This document also provides
suggestions on items that should be the initial focus of additional, suggestions on items that should be the initial focus of additional,
application-specific tuning. application-specific tuning.
This document is based on the AMD EYPC™ 7003-series processor family (former This document is based on the AMD EPYC™ 7003-series processor family (former
codename "Milan"). codename "Milan").
While this guide is a good starting point, developers are encouraged to perform While this guide is a good starting point, developers are encouraged to perform

38
docs/how_to/tuning_guides/mi100.md
View File

@@ -83,97 +83,97 @@ available as listed in {numref}`mi100-bios`.
- AMD CBS / NBIO Common Options - AMD CBS / NBIO Common Options
- IOMMU - IOMMU
- Disable - Disable
- - -
* *
- AMD CBS / NBIO Common Options - AMD CBS / NBIO Common Options
- PCIe Ten Bit Tag Support - PCIe Ten Bit Tag Support
- Enable - Enable
- - -
* *
- AMD CBS / NBIO Common Options - AMD CBS / NBIO Common Options
- Preferred IO - Preferred IO
- Manual - Manual
- - -
* *
- AMD CBS / NBIO Common Options - AMD CBS / NBIO Common Options
- Preferred IO Bus - Preferred IO Bus
- "Use lspci to find pci device id" - "Use lspci to find pci device id"
- - -
* *
- AMD CBS / NBIO Common Options - AMD CBS / NBIO Common Options
- Enhanced Preferred IO Mode - Enhanced Preferred IO Mode
- Enable - Enable
- - -
* *
- AMD CBS / NBIO Common Options / SMU Common Options - AMD CBS / NBIO Common Options / SMU Common Options
- Determinism Control - Determinism Control
- Manual - Manual
- - -
* *
- AMD CBS / NBIO Common Options / SMU Common Options - AMD CBS / NBIO Common Options / SMU Common Options
- Determinism Slider - Determinism Slider
- Power - Power
- - -
* *
- AMD CBS / NBIO Common Options / SMU Common Options - AMD CBS / NBIO Common Options / SMU Common Options
- cTDP Control - cTDP Control
- Manual - Manual
- - -
* *
- AMD CBS / NBIO Common Options / SMU Common Options - AMD CBS / NBIO Common Options / SMU Common Options
- cTDP - cTDP
- 240 - 240
- - -
* *
- AMD CBS / NBIO Common Options / SMU Common Options - AMD CBS / NBIO Common Options / SMU Common Options
- Package Power Limit Control - Package Power Limit Control
- Manual - Manual
- - -
* *
- AMD CBS / NBIO Common Options / SMU Common Options - AMD CBS / NBIO Common Options / SMU Common Options
- Package Power Limit - Package Power Limit
- 240 - 240
- - -
* *
- AMD CBS / NBIO Common Options / SMU Common Options - AMD CBS / NBIO Common Options / SMU Common Options
- xGMI Link Width Control - xGMI Link Width Control
- Manual - Manual
- - -
* *
- AMD CBS / NBIO Common Options / SMU Common Options - AMD CBS / NBIO Common Options / SMU Common Options
- xGMI Force Link Width - xGMI Force Link Width
- 2 - 2
- - -
* *
- AMD CBS / NBIO Common Options / SMU Common Options - AMD CBS / NBIO Common Options / SMU Common Options
- xGMI Force Link Width Control - xGMI Force Link Width Control
- Force - Force
- - -
* *
- AMD CBS / NBIO Common Options / SMU Common Options - AMD CBS / NBIO Common Options / SMU Common Options
- APBDIS - APBDIS
- 1 - 1
- - -
* *
- AMD CBS / NBIO Common Options / SMU Common Options - AMD CBS / NBIO Common Options / SMU Common Options
- DF C-states - DF C-states
- Auto - Auto
- - -
* *
- AMD CBS / NBIO Common Options / SMU Common Options - AMD CBS / NBIO Common Options / SMU Common Options
- Fixed SOC P-state - Fixed SOC P-state
- P0 - P0
- - -
* *
- AMD CBS / UMC Common Options / DDR4 Common Options - AMD CBS / UMC Common Options / DDR4 Common Options
- Enforce POR - Enforce POR
- Accept - Accept
- - -
* *
- AMD CBS / UMC Common Options / DDR4 Common Options / Enforce POR - AMD CBS / UMC Common Options / DDR4 Common Options / Enforce POR
- Overclock - Overclock
- Enabled - Enabled
- - -
* *
- AMD CBS / UMC Common Options / DDR4 Common Options / Enforce POR - AMD CBS / UMC Common Options / DDR4 Common Options / Enforce POR
- Memory Clock Speed - Memory Clock Speed

34
docs/how_to/tuning_guides/mi200.md
View File

@@ -82,37 +82,37 @@ Table 2: Recommended settings for the system BIOS in a GIGABYTE platform.
- AMD CBS / NBIO Common Options - AMD CBS / NBIO Common Options
- IOMMU - IOMMU
- Disable - Disable
- - -
* *
- AMD CBS / NBIO Common Options - AMD CBS / NBIO Common Options
- PCIe Ten Bit Tag Support - PCIe Ten Bit Tag Support
- Auto - Auto
- - -
* *
- AMD CBS / NBIO Common Options - AMD CBS / NBIO Common Options
- Preferred IO - Preferred IO
- Bus - Bus
- - -
* *
- AMD CBS / NBIO Common Options - AMD CBS / NBIO Common Options
- Preferred IO Bus - Preferred IO Bus
- "Use lspci to find pci device id" - "Use lspci to find pci device id"
- - -
* *
- AMD CBS / NBIO Common Options - AMD CBS / NBIO Common Options
- Enhanced Preferred IO Mode - Enhanced Preferred IO Mode
- Enable - Enable
- - -
* *
- AMD CBS / NBIO Common Options / SMU Common Options - AMD CBS / NBIO Common Options / SMU Common Options
- Determinism Control - Determinism Control
- Manual - Manual
- - -
* *
- AMD CBS / NBIO Common Options / SMU Common Options - AMD CBS / NBIO Common Options / SMU Common Options
- Determinism Slider - Determinism Slider
- Power - Power
- - -
* *
- AMD CBS / NBIO Common Options / SMU Common Options - AMD CBS / NBIO Common Options / SMU Common Options
- cTDP Control - cTDP Control
@@ -122,7 +122,7 @@ Table 2: Recommended settings for the system BIOS in a GIGABYTE platform.
- AMD CBS / NBIO Common Options / SMU Common Options - AMD CBS / NBIO Common Options / SMU Common Options
- cTDP - cTDP
- 280 - 280
- - -
* *
- AMD CBS / NBIO Common Options / SMU Common Options - AMD CBS / NBIO Common Options / SMU Common Options
- Package Power Limit Control - Package Power Limit Control
@@ -132,7 +132,7 @@ Table 2: Recommended settings for the system BIOS in a GIGABYTE platform.
- AMD CBS / NBIO Common Options / SMU Common Options - AMD CBS / NBIO Common Options / SMU Common Options
- Package Power Limit - Package Power Limit
- 280 - 280
- - -
* *
- AMD CBS / NBIO Common Options / SMU Common Options - AMD CBS / NBIO Common Options / SMU Common Options
- xGMI Link Width Control - xGMI Link Width Control
@@ -142,37 +142,37 @@ Table 2: Recommended settings for the system BIOS in a GIGABYTE platform.
- AMD CBS / NBIO Common Options / SMU Common Options - AMD CBS / NBIO Common Options / SMU Common Options
- xGMI Force Link Width - xGMI Force Link Width
- 2 - 2
- - -
* *
- AMD CBS / NBIO Common Options / SMU Common Options - AMD CBS / NBIO Common Options / SMU Common Options
- xGMI Force Link Width Control - xGMI Force Link Width Control
- Force - Force
- - -
* *
- AMD CBS / NBIO Common Options / SMU Common Options - AMD CBS / NBIO Common Options / SMU Common Options
- APBDIS - APBDIS
- 1 - 1
- - -
* *
- AMD CBS / NBIO Common Options / SMU Common Options - AMD CBS / NBIO Common Options / SMU Common Options
- DF C-states - DF C-states
- Enabled - Enabled
- - -
* *
- AMD CBS / NBIO Common Options / SMU Common Options - AMD CBS / NBIO Common Options / SMU Common Options
- Fixed SOC P-state - Fixed SOC P-state
- P0 - P0
- - -
* *
- AMD CBS / UMC Common Options / DDR4 Common Options - AMD CBS / UMC Common Options / DDR4 Common Options
- Enforce POR - Enforce POR
- Accept - Accept
- - -
* *
- AMD CBS / UMC Common Options / DDR4 Common Options / Enforce POR - AMD CBS / UMC Common Options / DDR4 Common Options / Enforce POR
- Overclock - Overclock
- Enabled - Enabled
- - -
* *
- AMD CBS / UMC Common Options / DDR4 Common Options / Enforce POR - AMD CBS / UMC Common Options / DDR4 Common Options / Enforce POR
- Memory Clock Speed - Memory Clock Speed
@@ -234,7 +234,7 @@ network. To disable power-gating on all cores run the following on Linux
systems: systems:
```shell ```shell
cpupower idle-set -d 2 cpupower idle-set -d 2
``` ```
Note that the `cpupower` tool must be installed, as it is not part of the base Note that the `cpupower` tool must be installed, as it is not part of the base

6
docs/reference/framework_compatibility/framework_compatibility.md
View File

@@ -18,11 +18,11 @@ This section contains the latest release notes for each framework compatible wit
The ROCm 5.4 platform supports the following frameworks: The ROCm 5.4 platform supports the following frameworks:
• PyTorch v1.12.1 - PyTorch v1.12.1
• MAGMA v2.5.4 - MAGMA v2.5.4
• TensorFlow v2.10.0 - TensorFlow v2.10.0
### PyTorch ### PyTorch

58
docs/reference/gpu_libraries/linear_algebra.md
View File

@@ -6,7 +6,7 @@ ROCm libraries for linear algebra are as follows:
:gutter: 1 :gutter: 1
:::{grid-item-card} [rocBLAS](https://rocmdocs.amd.com/projects/rocBLAS/en/develop/) :::{grid-item-card} [rocBLAS](https://rocmdocs.amd.com/projects/rocBLAS/en/develop/)
rocBLAS is an AMD GPU optimized library for BLAS. `rocBLAS` is an AMD GPU optimized library for BLAS (Basic Linear Algebra Subprograms).
- [Documentation](https://rocmdocs.amd.com/projects/rocBLAS/en/develop/) - [Documentation](https://rocmdocs.amd.com/projects/rocBLAS/en/develop/)
- [Changelog](https://github.com/ROCmSoftwarePlatform/rocBLAS/blob/develop/CHANGELOG.md) - [Changelog](https://github.com/ROCmSoftwarePlatform/rocBLAS/blob/develop/CHANGELOG.md)
@@ -15,8 +15,8 @@ rocBLAS is an AMD GPU optimized library for BLAS.
::: :::
:::{grid-item-card} [hipBLAS](https://rocmdocs.amd.com/projects/hipBLAS/en/develop/) :::{grid-item-card} [hipBLAS](https://rocmdocs.amd.com/projects/hipBLAS/en/develop/)
hipBLAS is a compatibility layer for GPU accelerated BLAS optimized for AMD GPUs `hipBLAS` is a compatibility layer for GPU accelerated BLAS optimized for AMD GPUs
via rocBLAS and rocSOLVER. hipBLAS allows for a common interface for other GPU via `rocBLAS` and `rocSOLVER`. `hipBLAS` allows for a common interface for other GPU
BLAS libraries. BLAS libraries.
- [Documentation](https://rocmdocs.amd.com/projects/hipBLAS/en/develop/) - [Documentation](https://rocmdocs.amd.com/projects/hipBLAS/en/develop/)
@@ -25,7 +25,10 @@ BLAS libraries.
::: :::
:::{grid-item-card} [hipBLASLt](https://rocmdocs.amd.com/projects/hipBLASLt/en/develop/) :::{grid-item-card} [hipBLASLt](https://rocmdocs.amd.com/projects/hipBLASLt/en/develop/)
hipBLASLt is a library that provides general matrix-matrix operations with a flexible API and extends functionalities beyond traditional BLAS library. hipBLASLt is exposed APIs in HIP programming language with an underlying optimized generator as a back-end kernel provider. `hipBLASLt` is a library that provides general matrix-matrix operations with a
flexible API and extends functionalities beyond traditional BLAS library.
`hipBLASLt` is exposed APIs in HIP programming language with an underlying
optimized generator as a back-end kernel provider.
- [Documentation](https://rocmdocs.amd.com/projects/hipBLASLt/en/develop/) - [Documentation](https://rocmdocs.amd.com/projects/hipBLASLt/en/develop/)
- [Changelog](https://github.com/ROCmSoftwarePlatform/hipBLASLt/blob/develop/CHANGELOG.md) - [Changelog](https://github.com/ROCmSoftwarePlatform/hipBLASLt/blob/develop/CHANGELOG.md)
@@ -33,11 +36,56 @@ hipBLASLt is a library that provides general matrix-matrix operations with a fle
::: :::
:::{grid-item-card} [rocALUTION](https://rocmdocs.amd.com/projects/rocALUTION/en/develop/) :::{grid-item-card} [rocALUTION](https://rocmdocs.amd.com/projects/rocALUTION/en/develop/)
rocALUTION is a sparse linear algebra library with focus on exploring fine-grained parallelism on top of AMD’s Radeon Open Compute ROCm runtime and toolchains, targeting modern CPU and GPU platforms. `rocALUTION` is a sparse linear algebra library with focus on exploring
fine-grained parallelism on top of AMD's ROCm runtime and toolchains, targeting
modern CPU and GPU platforms.
- [Documentation](https://rocmdocs.amd.com/projects/rocALUTION/en/develop/) - [Documentation](https://rocmdocs.amd.com/projects/rocALUTION/en/develop/)
- [Changelog](https://github.com/ROCmSoftwarePlatform/rocALUTION/blob/develop/CHANGELOG.md) - [Changelog](https://github.com/ROCmSoftwarePlatform/rocALUTION/blob/develop/CHANGELOG.md)
::: :::
:::{grid-item-card} [rocWMMA](https://rocmdocs.amd.com/projects/rocWMMA/en/develop/)
`rocWMMA` provides an API to break down mixed precision matrix multiply-accumulate
(MMA) problems into fragments and distributes these over GPU wavefronts.
- [Documentation](https://rocmdocs.amd.com/projects/rocWMMA/en/develop/)
- [Changelog](https://github.com/ROCmSoftwarePlatform/rocWMMA/blob/develop/CHANGELOG.md)
:::
:::{grid-item-card} [rocSOLVER](https://rocmdocs.amd.com/projects/rocSOLVER/en/develop/)
`rocSOLVER` provides a subset of LAPACK (Linear Algebra Package) functionality on the ROCm platform.
- [Documentation](https://rocmdocs.amd.com/projects/rocSOLVER/en/develop/)
- [Changelog](https://github.com/ROCmSoftwarePlatform/rocSOLVER/blob/develop/CHANGELOG.md)
:::
:::{grid-item-card} [hipSOLVER](https://rocmdocs.amd.com/projects/hipSOLVER/en/develop/)
`hipSOLVER` is a LAPACK marshalling library supporting both `rocSOLVER` and `cuSOLVER`
as backends whilst exporting a unified interface.
- [Documentation](https://rocmdocs.amd.com/projects/hipSOLVER/en/develop/)
- [Changelog](https://github.com/ROCmSoftwarePlatform/hipSOLVER/blob/develop/CHANGELOG.md)
:::
:::{grid-item-card} [rocSPARSE](https://rocmdocs.amd.com/projects/rocSOLVER/en/develop/)
`rocSPARSE` is a library to provide BLAS for sparse computations.
- [Documentation](https://rocmdocs.amd.com/projects/rocSOLVER/en/develop/)
- [Changelog](https://github.com/ROCmSoftwarePlatform/rocSOLVER/blob/develop/CHANGELOG.md)
:::
:::{grid-item-card} [hipSPARSE](https://rocmdocs.amd.com/projects/hipSOLVER/en/develop/)
`hipSPARSE` is a marshalling library to provide sparse BLAS functionality,
supporting both `rocSPARSE` and `cuSPARSE` as backends.
- [Documentation](https://rocmdocs.amd.com/projects/hipSOLVER/en/develop/)
- [Changelog](https://github.com/ROCmSoftwarePlatform/hipSOLVER/blob/develop/CHANGELOG.md)
:::
::::: :::::

3
tools/autotag/templates/changelog.jinja
View File

@@ -13,6 +13,9 @@
<!-- markdownlint-disable reference-links-images --> <!-- markdownlint-disable reference-links-images -->
<!-- markdownlint-disable no-missing-space-atx --> <!-- markdownlint-disable no-missing-space-atx -->
#} #}
<!-- spellcheck-disable -->
The release notes for the ROCm platform. The release notes for the ROCm platform.
{%- for version, release in releases %} {%- for version, release in releases %}