Compare commits

...

500 Commits

Author SHA1 Message Date
Sam Wu
fdfd9187d7 Update documentation requirements 2024-09-16 10:12:18 -08:00
Sam Wu
1659e6e8a0 Update documentation requirements 2024-06-06 16:58:20 -06:00
Sam Wu
9a496d97d5 Fix RTD config 2024-05-02 08:53:40 -06:00
Sam Wu
7dd2b6f12c Update documentation requirements 2024-05-01 16:58:39 -06:00
Sam Wu
7e53ad4f9c Update documentation requirements 2024-05-01 16:50:38 -06:00
Sam Wu
a1f0050f6b add version to html title 2023-08-04 17:15:18 -06:00
Sam Wu
bc8686a20c rocm-docs-core v0.18.3 2023-06-30 09:34:05 -06:00
dependabot[bot]
12ad0c6c8b Bump rocm-docs-core from 0.18.0 to 0.18.1 in /docs/sphinx (#2280)
Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.18.0 to 0.18.1.
- [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases)
- [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v0.18.0...v0.18.1)

---
updated-dependencies:
- dependency-name: rocm-docs-core
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-06-27 19:34:34 -06:00
Sam Wu
eaf98b0001 rocm_smi_lib 2023-06-21 17:00:38 -06:00
Sam Wu
6dcbf4b594 edit instructions, logs, and notes for 5.1.3 2023-06-21 15:25:13 -06:00
Sam Wu
ca426a3821 edit instructions, logs, and notes for 5.1.1 2023-06-21 15:18:20 -06:00
Máté Ferenc Nagy-Egri
0e54cd2ec6 Downgrade license notice to 5.2.0 2023-06-15 13:04:48 +02:00
Máté Ferenc Nagy-Egri
e8ad3843bf Downgrade changelog to 5.2.0 2023-06-15 13:04:48 +02:00
Máté Ferenc Nagy-Egri
daab3058b0 Downgrade install instructions to 5.2.0 2023-06-15 13:04:48 +02:00
Máté Ferenc Nagy-Egri
16be156acc Downgrade release notes to 5.2.0 2023-06-15 13:04:48 +02:00
Máté Ferenc Nagy-Egri
279fa18f5a Downgrade support matrices to 5.2.3 2023-06-15 13:04:48 +02:00
Máté Ferenc Nagy-Egri
746cc7fe57 Downgrade license notice to 5.2.3 2023-06-15 13:04:47 +02:00
Máté Ferenc Nagy-Egri
9e5263ebca Downgrade changelog to 5.2.3 2023-06-15 13:04:47 +02:00
Máté Ferenc Nagy-Egri
95281a4570 Downgrade install instructions to 5.2.3 2023-06-15 13:04:29 +02:00
Máté Ferenc Nagy-Egri
f5e2c6640d Downgrade release notes to 5.2.3 2023-06-14 15:08:19 +02:00
Máté Ferenc Nagy-Egri
d9173e132e Downgrade license notice to 5.3.0 2023-06-14 15:08:19 +02:00
Máté Ferenc Nagy-Egri
cf8a084f47 Downgrade changelog to 5.3.0 2023-06-14 15:08:19 +02:00
Máté Ferenc Nagy-Egri
e69f4bd470 Downgrade install instructions to 5.3.0 2023-06-14 15:08:19 +02:00
Máté Ferenc Nagy-Egri
2044d16f32 Downgrade release notes to 5.3.0 2023-06-14 15:08:19 +02:00
Máté Ferenc Nagy-Egri
6029cf7fff Downgrade license notice to 5.3.2 2023-06-14 15:08:19 +02:00
Máté Ferenc Nagy-Egri
4cbce8a0eb Downgrade changelog to 5.3.2 2023-06-14 15:08:19 +02:00
Máté Ferenc Nagy-Egri
00a448f25d Downgrade install instructions to 5.3.2 2023-06-14 15:08:18 +02:00
Máté Ferenc Nagy-Egri
5f11e96b89 Downgrade release notes to 5.3.2 2023-06-14 15:08:18 +02:00
Máté Ferenc Nagy-Egri
0b60d6c54d Downgrade support matrices to 5.3.3 2023-06-14 15:06:35 +02:00
Máté Ferenc Nagy-Egri
aeb750208f Downgrade license notice to 5.3.3 2023-06-14 14:04:06 +02:00
Máté Ferenc Nagy-Egri
fba1e09deb Downgrade changelog to 5.3.3 2023-06-14 14:04:06 +02:00
Máté Ferenc Nagy-Egri
d6990e32f3 Downgrade install instructions to 5.3.3 2023-06-14 14:04:06 +02:00
Máté Ferenc Nagy-Egri
01d12821fe Downgrade release notes to 5.3.3 2023-06-14 10:59:36 +02:00
Máté Ferenc Nagy-Egri
070a7db8a2 Downgrade license notice to 5.4.0 2023-06-13 14:46:19 +02:00
Máté Ferenc Nagy-Egri
911f18c6c6 Downgrade changelog to 5.4.0 2023-06-13 14:46:10 +02:00
Máté Ferenc Nagy-Egri
9a5d323b01 Downgrade install instructions to 5.4.0 2023-06-13 14:46:02 +02:00
Máté Ferenc Nagy-Egri
ab0e1fd625 Downgrade release notes to 5.4.0 2023-06-13 14:45:50 +02:00
Máté Ferenc Nagy-Egri
a635018505 Downgrade license notice to 5.4.1 2023-06-13 14:24:12 +02:00
Máté Ferenc Nagy-Egri
d2070c1b4a Downgrade changelog to 5.4.1 2023-06-13 14:23:59 +02:00
Máté Ferenc Nagy-Egri
12c9158880 Downgrade install instructions to 5.4.1 2023-06-13 14:23:51 +02:00
Máté Ferenc Nagy-Egri
9a55d71cec Downgrade release notes to 5.4.1 2023-06-13 14:23:38 +02:00
Máté Ferenc Nagy-Egri
9a9df83a77 Downgrade license notice to 5.4.2 2023-06-13 14:21:39 +02:00
Máté Ferenc Nagy-Egri
395e607525 Downgrade changelog to 5.4.2 2023-06-13 14:21:39 +02:00
Máté Ferenc Nagy-Egri
561c304e10 Downgrade install instructions to 5.4.2 2023-06-13 14:21:39 +02:00
Máté Ferenc Nagy-Egri
778db160eb Downgrade release notes to 5.4.2 2023-06-13 14:16:46 +02:00
Máté Ferenc Nagy-Egri
60a3065399 Downgrade support matrices to 5.4.3 2023-06-12 14:38:40 +02:00
Máté Ferenc Nagy-Egri
3c360627bd Downgrade changelog to 5.4.3 2023-06-12 14:37:41 +02:00
Máté Ferenc Nagy-Egri
e1151d4dbb Downgrade install instructions to 5.4.3 2023-06-12 14:37:25 +02:00
Máté Ferenc Nagy-Egri
616a09c442 Downgrade release notes to 5.4.3 2023-06-12 14:37:06 +02:00
Máté Ferenc Nagy-Egri
082fbb9d44 Downgrade changelog to 5.5.0 2023-06-12 14:27:40 +02:00
Máté Ferenc Nagy-Egri
1971584024 Downgrade install instructions to 5.5.0 2023-06-12 14:27:40 +02:00
Máté Ferenc Nagy-Egri
71e52a1c84 Downgrade release notes to 5.5.0 2023-06-12 14:17:26 +02:00
Gergely Meszaros
a471e8debe Add instructions for adding extra repositories in RHEL and SLES
The hip-devel package depends on perl modules not distributed by default
on RHEL and SLES distriubutions, these can be installed from EPEL and
the `devel:languages:perl` repository respectively.

Ideally in the future these dependencies would be replaced with packages
available from default repositories, but in the meanwhile this should
be at least documented.
2023-06-08 09:37:00 -06:00
dependabot[bot]
8c86526f98 Bump rocm-docs-core from 0.13.3 to 0.13.4 in /docs/sphinx (#2226)
Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.13.3 to 0.13.4.
- [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases)
- [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v0.13.3...v0.13.4)

---
updated-dependencies:
- dependency-name: rocm-docs-core
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-06-08 09:18:23 -06:00
Mészáros Gergely
a42fae5140 Install fixes (#2228)
* Remove install instructions for unsuported RHEL 8.8 and 9.2

Current ROCm release does not support these versions of RHEL

* Centralize disclaimers and perquisites for installation

- Move the single-version to multi-version diclaimer to the install
  overview page where single vs multi installs are discussed.
- Move the installation of kernel-headers and development packages
  to the install preparation page. Unify it mainly from the quick start
  content.

* s/Name/name/ in repository config files for RHEL

The repository name can be set as `name=><name>` instead of `Name`,
otherwise yum complains about the repo not having a name, e.g:
```output
Repository 'ROCm-5.3.3' is missing name in configuration, using id.
```

This is fixed with this commit.

* Clean up render/video group section on prerequisites

* Installation and Upgrade restructuring & fixes

- Fix the rocm package urls for RHEL in the install & upgrade guides
  - RHEL8 and 9 have different URLs, add a tab-set similar to ubuntu
    for them.
- Fix the package URL in the upgrade guide for SLES (previously pointed
  to the amdgpu url)
- Change the apt-signing key download and conversion to the method used
  in the quick start guide, which is the recommended by ubuntu maintainers
- Change the install steps from list items to rubrics with numbered entries
  which is more readable and matches the style in the quick start guide
- Do not pass `--append` to `tee` in the upgrade guide, because it is
  meant to overwrite.
- Split the one long tab-set to multiple tab-sets in the upgrade guide
  to improve readability
2023-06-08 09:17:51 -06:00
Saad Rahim
bcb3dd3b4a PCIe Atomics (#2223)
Co-authored-by: Nagy-Egri Máté Ferenc <beiktatas+github@outlook.hu>
2023-06-06 21:52:18 -06:00
Mészáros Gergely
8784fe3fba Install updates (#2221)
* Install updates

- revert distro command installation -> package manager installation
- move description of installer script to common section
- updates to the installer script installation page
- other misc fixes

* Fix spelling
2023-06-06 07:06:06 -06:00
Saad Rahim
6e79d204b8 Further installation fixes (#2219)
Co-authored-by: Sam Wu <sjwu@ualberta.ca>
2023-06-04 11:33:27 -06:00
Sam Wu
7076bc18ca Standardize install instructions (#2220)
* standardize install instructions

* use rocm-5.5.1 in install instructions
2023-06-04 10:49:11 -06:00
Saad Rahim
519df7a51f Refactoring installation documentation (#2202)
Co-authored-by: Sam Wu <sam.wu2@amd.com>
2023-06-02 14:35:24 -06:00
dependabot[bot]
90c697b6d3 Bump rocm-docs-core from 0.13.2 to 0.13.3 in /docs/sphinx (#2214)
Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.13.2 to 0.13.3.
- [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases)
- [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v0.13.2...v0.13.3)

---
updated-dependencies:
- dependency-name: rocm-docs-core
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-06-01 11:52:50 -06:00
Nara
125cc37981 Update changelog for 5.5.1 (#2199)
* docs(changelog): update changelog for 5.5.1

Signed-off-by: Nara Prasetya <nara@streamhpc.com>

* docs(changelog): Improve continuity in release notes

* docs(changelog): Add changelog to TOC

---------

Signed-off-by: Nara Prasetya <nara@streamhpc.com>
2023-06-01 09:40:51 -06:00
Nagy-Egri Máté Ferenc
5752b5986c Remove links to docs.amd.com (#2200)
* Remove links to docs.amd.com

* Fix linking to list item (not possible)
2023-06-01 08:16:38 -06:00
dependabot[bot]
2829c088c2 Bump rocm-docs-core from 0.13.1 to 0.13.2 in /docs/sphinx (#2201)
Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.13.1 to 0.13.2.
- [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases)
- [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v0.13.1...v0.13.2)

---
updated-dependencies:
- dependency-name: rocm-docs-core
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-05-31 11:49:43 -06:00
dependabot[bot]
3b9fb62600 Bump rocm-docs-core from 0.13.0 to 0.13.1 in /docs/sphinx (#2190)
Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.13.0 to 0.13.1.
- [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases)
- [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v0.13.0...v0.13.1)

---
updated-dependencies:
- dependency-name: rocm-docs-core
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Sam Wu <sam.wu2@amd.com>
2023-05-30 10:20:18 -06:00
Mészáros Gergely
b7222caed2 Replace incorrect em-dashes with dashes in code-blocks (#2192)
Replace em-dash('–') with dash('-') in code blocks where the latter was
meant.
2023-05-30 07:26:23 -06:00
Nagy-Egri Máté Ferenc
c285dd729f Team-feedback (#2193)
* Fix hipRAND copy-paste error

* Remove superflous table reference
2023-05-30 07:06:06 -06:00
Mészáros Gergely
0c93636d23 Replace links to subprojects docs with intersphinx links (#2181) 2023-05-29 12:33:46 -06:00
Sam Wu
3fa5f1fddc Update doc requirements and suppress duplicate main doc link (#2189)
* update to rocm-docs-core v0.13.0

also suppress main doc link

* rename home link to ROCm Documentation Home
2023-05-29 12:32:50 -06:00
Saad Rahim
17b029b885 Changing title (#2183) 2023-05-25 22:32:59 -06:00
Saad Rahim
460f46c3be Adding repo priority for Ubuntu 22.04 (#2178)
* Adding repo priority for Ubuntu 22.04

* removed unnecessary apt-update
2023-05-25 14:46:43 -06:00
Mészáros Gergely
6feca81dd0 docs: fix bios settings tables in mi100/mi200 tuning guides (#2179)
Add empty cells to list tables to make them uniform (all rows have the
same number of cells), before this the tables errored out with:

> ERROR: Error parsing content block for the "list-table" directive:
> uniform two-level bullet list expected, but row 13 does not contain
> the same number of items as row 1 (3 vs 4)

and the table did not show up.
2023-05-25 09:54:40 -06:00
Mészáros Gergely
ec8496041a ci: change markdown linting to use the NodeJs markdownlint (#2180)
* ci: change markdown linting to use the NodeJs markdownlint

The original ruby based markdownlint has a few shortcomings not known
when it was introduced:
- no support for myst extensions
- no support for disabling specific rules for specific files or regions

These two combined make it very hard to use when used for this project
when it has false positives around myst extensions.

Luckily there's a NodeJS based version of markdownlint [1] supporting the
same ruleset that is more configurable:
- seems to support myst extensions better
- has an html comment based syntax to disable specific rules

The library seem to be better maintained too and with better tooling:
e.g. there's a vscode extension using the engine for local use:
markdownlint (DavidAnson.vscode-markdownlint).

[1]: https://github.com/DavidAnson/markdownlint

* docs: hotfix empty links

There are missing links in the docs, these should get fixed, but for now
they are just monkey patched to make CI happy.

* docs: fix links

---------

Co-authored-by: Nara Prasetya <nara@streamhpc.com>
2023-05-25 09:51:19 -06:00
Edgar Gabriel
c7350c08ab update the gpu-aware-mpi page (#2176)
* update the gpu-aware-mpi page

Three changes:
 - add the ucx compatibility table
 - add the --with-rocm=/opt/rocm option to the compilation of Open MPI
 - add a section about how to compile and use UCC for collective
operations.

* Changing link to relative

* Update gpu_aware_mpi.md

---------

Co-authored-by: Saad Rahim <44449863+saadrahim@users.noreply.github.com>
2023-05-24 16:42:45 -06:00
Sam Wu
c1809766e6 Link fixes (#2177)
* fix rocmcc link

* remove unused link

* remove unused linkcheck configs

* update amd smi section

add link to ami smi github

---------

Co-authored-by: Saad Rahim <44449863+saadrahim@users.noreply.github.com>
2023-05-24 16:14:23 -06:00
Saad Rahim
61df1ec8c6 Updating link to new dev hub (#2174) 2023-05-24 16:11:14 -06:00
Li Li
983987aab5 Update deep learning guide (#2124)
* add deep learning guide

* seperate out oprimization, reference, and troubleshooting as standalone sections.

* resolve lint errors

* delete introduction to DL

* correct syntax highlights and filename

* remove out-of-date QAs

* Renaming and cleanup

* Spelling

* Fixup TOC

---------

Co-authored-by: Nara Prasetya <nara@streamhpc.com>
Co-authored-by: Saad Rahim <44449863+saadrahim@users.noreply.github.com>
2023-05-24 16:04:30 -06:00
zhang2amd
914b62e219 Update default.xml for 5.5.1 release 2023-05-24 13:17:55 -07:00
Saad Rahim
faac45772c Broken Links (#2172) 2023-05-24 11:11:40 -06:00
dependabot[bot]
d206494272 Bump rocm-docs-core from 0.11.1 to 0.12.0 in /docs/sphinx (#2171)
Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.11.1 to 0.12.0.
- [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases)
- [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v0.11.1...v0.12.0)

---
updated-dependencies:
- dependency-name: rocm-docs-core
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-05-24 10:19:34 -06:00
Saad Rahim
26c73a3986 Fixing GPU support tables (#2170)
* Fixing GPU support tables

* Linting
2023-05-24 10:06:12 -06:00
Nagy-Egri Máté Ferenc
dc74008ac6 Fix-landing-pages (#2167) 2023-05-24 07:27:50 -06:00
dependabot[bot]
108287dcd7 Bump rocm-docs-core from 0.11.0 to 0.11.1 in /docs/sphinx (#2164)
Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.11.0 to 0.11.1.
- [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases)
- [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v0.11.0...v0.11.1)

---
updated-dependencies:
- dependency-name: rocm-docs-core
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-05-24 07:08:10 -06:00
Nagy-Egri Máté Ferenc
38440915ef Finish-compat-section (#2166)
* User/Kernel-Space compat

* Update ML compat at 5.5.0

* Fix spelling of user and kernel space
2023-05-24 07:02:43 -06:00
srawat
d9c434881a Update openmp.md (#2163)
Updated the link for supported GPUs from absolute to relative "(../../release/gpu_os_support.md#gpu-support-table)"
2023-05-23 07:05:18 -06:00
Nagy-Egri Máté Ferenc
4c795d45f6 Typo and link style fixes (#2158)
* CMake package config filename format

* No links as text
2023-05-22 17:27:59 -06:00
Saad Rahim
ef0a88ea0e Navigation improvement (#2151)
* Reorganized Ref Grid card and ROCm intro

* MIGraphX link

* openmp header cleanup

* Fixing durationN

* Syncing grid cards to left nav
2023-05-19 15:07:46 -06:00
Nagy-Egri Máté Ferenc
34578f0193 Compatibility pages review (#2134) 2023-05-19 07:38:14 -06:00
Saad Rahim
6d32125543 Merge pull request #2150 from saadrahim/further_fixes
Additional fixes
2023-05-18 16:22:03 -06:00
Saad Rahim
f4a481e58b URL change and nav cleanup 2023-05-18 14:42:03 -06:00
zhozha
081a2948ff Update manifest for v5.5 release 2023-05-18 11:49:10 -06:00
Nagy-Egri Máté Ferenc
6c1fff6692 RDNA2 Virtualization Guide (#2149) 2023-05-18 09:39:37 -06:00
dependabot[bot]
0b249ff088 Bump rocm-docs-core from 0.10.3 to 0.11.0 in /docs/sphinx (#2148)
Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.10.3 to 0.11.0.
- [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases)
- [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v0.10.3...v0.11.0)

---
updated-dependencies:
- dependency-name: rocm-docs-core
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Saad Rahim <44449863+saadrahim@users.noreply.github.com>
2023-05-17 22:34:23 -06:00
Saad Rahim
49d4d1b6bc Navigation cleanup (#2147) 2023-05-17 22:32:07 -06:00
Sam Wu
f953a99298 Update links to new docs and rename .sphinx dir to sphinx (#2141)
* update links to new docs and rename .sphinx dir to sphinx

* fix spelling and formatting
add new words to wordlist
remove empty headers
remove version number for ROCm in conf.py

fix typos

* add more formats to rtd config
2023-05-17 11:40:18 -06:00
Nagy-Egri Máté Ferenc
4096b867d8 CMake HIP language support (#2104) 2023-05-17 07:07:22 -06:00
Nara
494ba37d87 docs: clean up (#2143) 2023-05-16 07:27:27 -06:00
dependabot[bot]
df32eed823 Bump rocm-docs-core from 0.10.2 to 0.10.3 in /docs/.sphinx (#2140)
Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.10.2 to 0.10.3.
- [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases)
- [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v0.10.2...v0.10.3)

---
updated-dependencies:
- dependency-name: rocm-docs-core
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-05-15 07:24:05 -06:00
dependabot[bot]
b173f6b226 Bump rocm-docs-core from 0.10.1 to 0.10.2 in /docs/.sphinx (#2139)
Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.10.1 to 0.10.2.
- [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases)
- [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v0.10.1...v0.10.2)

---
updated-dependencies:
- dependency-name: rocm-docs-core
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-05-14 21:17:04 -06:00
dependabot[bot]
09423f1e4e Bump rocm-docs-core from 0.10.0 to 0.10.1 in /docs/.sphinx (#2129)
Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.10.0 to 0.10.1.
- [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases)
- [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v0.10.0...v0.10.1)

---
updated-dependencies:
- dependency-name: rocm-docs-core
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-05-11 10:47:27 -06:00
Nagy-Egri Máté Ferenc
d9f272a505 MI100 and MI200 extra content (#2112) 2023-05-11 09:34:11 -06:00
Saad Rahim
ba14589a9a Grammar and other typos (#2123) 2023-05-10 13:25:40 -06:00
dependabot[bot]
f8fe609302 Bump rocm-docs-core from 0.9.2 to 0.10.0 in /docs/.sphinx (#2125)
Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.9.2 to 0.10.0.
- [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases)
- [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v0.9.2...v0.10.0)

---
updated-dependencies:
- dependency-name: rocm-docs-core
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-05-09 18:58:04 -06:00
dependabot[bot]
fd9ae73706 Bump rocm-docs-core from 0.9.1 to 0.9.2 in /docs/.sphinx (#2118)
Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.9.1 to 0.9.2.
- [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases)
- [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v0.9.1...v0.9.2)

---
updated-dependencies:
- dependency-name: rocm-docs-core
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-05-05 13:40:17 -06:00
Michael E. Rowan
58481f3b83 update file_reorg.md (#2117) 2023-05-05 13:28:05 -06:00
Sam Wu
012e4c542b Set article info for pages (#2090) 2023-05-05 07:32:44 -06:00
Mészáros Gergely
55b5b66901 Add GPU isolation (#2114)
* Add GPU isolation guide

* Add hover text expansion of DKMS in linux quick start guide
2023-05-04 11:44:09 -06:00
Nagy-Egri Máté Ferenc
62ed404058 Initial GPU-aware MPI port (#2086)
* Initial GPU-aware MPI port

* Remove trailing spaces

* Allowlist word in gpu_aware_mpi
2023-05-04 09:42:22 -06:00
Saad Rahim
66ed6adf6c Adding release notes (#2113) 2023-05-04 08:40:56 -06:00
Nara
e04c646088 Update openmp documentation (#2103)
* docs(openmp): updated openmp documentation

* style(openmp): 80 column widths
2023-05-03 09:55:54 -06:00
dependabot[bot]
fcc6283748 Bump rocm-docs-core from 0.7.1 to 0.8.0 in /docs/.sphinx (#2102)
Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.7.1 to 0.8.0.
- [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases)
- [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v0.7.1...v0.8.0)

---
updated-dependencies:
- dependency-name: rocm-docs-core
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-05-02 17:12:45 -06:00
Saad Rahim
28a4b8d477 What is ROCm? - Overview (#2096) 2023-05-01 22:02:16 -06:00
Nara
2aec75e201 Release notes for ROCm 5.5.0 (#2094)
* docs(release_notes): added release notes for ROCm 5.5.0

* ci(linting): Add RELEASE.md to ignore RegEx.
2023-05-01 21:53:54 -06:00
doscherda
2072f82761 Update docker.md (#2067)
* Update docker.md

add --security-opt seccomp=unconfined info

* ci fixups

---------

Co-authored-by: Nara Prasetya <nara@streamhpc.com>
2023-05-01 08:25:47 -06:00
Sam Wu
5c4ab7d675 update supported python versions for documentation (#2092)
rocm-docs-core dependencies requires python>=3.8 and python<3.9
2023-04-28 08:44:59 -06:00
Saad Rahim
d5eb2b25f2 Changing version number (#2091) 2023-04-27 11:27:43 -06:00
dependabot[bot]
bcc1432d83 Bump rocm-docs-core from 0.6.0 to 0.7.1 in /docs/.sphinx (#2088)
Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.6.0 to 0.7.1.
- [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases)
- [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v0.6.0...v0.7.1)

---
updated-dependencies:
- dependency-name: rocm-docs-core
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-04-26 11:12:16 -06:00
Saad Rahim
776605266c Removing Windows Documentation (#2085) 2023-04-25 21:34:30 -06:00
Sam Wu
4c62bb74ff remove linkcheck step from rtd (#2081) 2023-04-24 15:54:23 -06:00
Sam Wu
57c601262b HPC cleanup - Clean up the deployment related pages (#2080)
* Clean up the deployment related pages

- Add an index page for the linux deployment submenu
- Remove deployment options that are not yet completed (i.e. spack,
from source installation)
- remove the general deployment index page
- various cleanups and clarifications in the rest of the pages

* Move all deploy pages to deploy folder

---------

Co-authored-by: Gergely Meszaros <gergely@streamhpc.com>
2023-04-24 12:07:17 -06:00
Sam Wu
b897bddf38 Linkcheck and prepare alpha (#2078) 2023-04-24 11:25:31 -06:00
Nara
48db1eea8d Spell checking (#2070)
* ci: cleanup linters and add spelling checker

* docs: fix spelling and styling issues
2023-04-24 07:09:09 -06:00
Saad Rahim
08821f1098 fixing links for HIP (#2068) 2023-04-20 10:21:40 -06:00
dependabot[bot]
3a93ce8fc9 Bump rocm-docs-core from 0.5.0 to 0.6.0 in /docs/.sphinx (#2062)
Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.5.0 to 0.6.0.
- [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases)
- [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v0.5.0...v0.6.0)

---
updated-dependencies:
- dependency-name: rocm-docs-core
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-04-18 07:38:46 -06:00
dependabot[bot]
a167088d41 Bump rocm-docs-core from 0.4.0 to 0.5.0 in /docs/.sphinx (#2050)
Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.4.0 to 0.5.0.
- [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases)
- [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v0.4.0...v0.5.0)

---
updated-dependencies:
- dependency-name: rocm-docs-core
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-04-16 17:53:55 -06:00
Saad Rahim
85dd6e4234 Fixing GPU list (#2049) 2023-04-14 11:59:39 -06:00
Nara
507530aeb5 Ignore markdown linting in autotag template folder (#2047) 2023-04-14 08:14:00 -06:00
Nara
2de2059feb Fix some linting issues (#2046) 2023-04-14 15:17:21 +02:00
Nara
b81a27c2a2 Modify AutoTag to generate changelog (#2004) 2023-04-14 07:11:08 -06:00
Saad Rahim
19c0ba1150 Readme Cleanup (#2037) 2023-04-13 20:14:51 -06:00
dependabot[bot]
043427989f Bump rocm-docs-core from 0.2.0 to 0.4.0 in /docs/.sphinx (#2042)
Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.2.0 to 0.4.0.
- [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases)
- [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/commits/v0.4.0)

---
updated-dependencies:
- dependency-name: rocm-docs-core
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-04-13 16:47:47 -06:00
Nagy-Egri Máté Ferenc
21033eb98b 1908 install upgrade uninstall guide (#2039) 2023-04-13 11:24:19 -06:00
Sam Wu
c3298b5944 add python versions known to build docs (#2040) 2023-04-13 10:25:38 -06:00
Ehud Sharlin
7bbd5bc79d Deep Learning Training - Troubleshooting & References (#2033) 2023-04-12 07:37:52 -06:00
Saad Rahim
b1a971b432 Updating version string to include alpha(#2035) 2023-04-11 09:52:50 -06:00
Saad Rahim
41dc33d95d Fixing openmp link (#2029) 2023-04-06 13:49:24 -06:00
Saad Rahim
97339ffe33 lab notes added to navigation (#2026) 2023-04-06 13:45:45 -06:00
Brian Cornille
47688609af Updated outdated OpenMP information on flags and example locations and fixed some typos. (#2027)
Co-authored-by: Brian Cornille <Brian.Cornille@amd.com>
2023-04-06 13:45:21 -06:00
Justin Chang
1533f5edb6 Added reference to AMD lab notes (#2025) 2023-04-06 10:46:43 -06:00
Nagy-Egri Máté Ferenc
1ec7e1c933 Port installation guide (#2018) 2023-04-06 09:42:07 -06:00
Mészáros Gergely
64a243fc29 build(deps): Pin rocm-docs-core based on the pypi version (#2024)
Dependabot should keep this up-to-date, so we can now actually pin
a version to avoid breaking when it is updated.
2023-04-06 09:37:17 -06:00
Mészáros Gergely
fa298efcbb ci(deps): Fix dependabot config (#2023)
The manifests are in the docs/.sphinx directory.
2023-04-06 09:11:42 -06:00
Nagy-Egri Máté Ferenc
08d8d2612a Comment triage (#2022)
- Unify code block style (indent vs. fence)
- Mark code languages
- Increase heading level one at a time
- No extra newlines between paragraphs
- List for header reorg stages
- Shrink ascii table (mobile friendlyness)
- 80-column width
2023-04-06 09:11:09 -06:00
Sam Wu
fc3f2ccb38 Add dependabot configuration (#2016)
* add dependabot config

* change bot pr target branch

* set bot interval to daily
2023-04-05 12:31:12 -06:00
Lauren Wrubleski
9683d6f776 Include autotag script as generic ROCm tool (#1949) 2023-04-03 07:09:01 -06:00
Sam Wu
9833748ff0 Doc update (#2011)
* add url to ROCgdb-docs

update reqs and gitignore

* add validation tools section for RVS and TransferBench

* stub in links for validation/mgmt tools

* populate compilers page

* add cards for ai libs and computer vision pages

* add content to math lib pages

* reorg hip and math libs

* update index

* consolidate linear algebra libs

* fix release info order in toc

* fix links and content cards for libraries

* update mdl ignored files

* update understand rocm section

* fix formatting errors

* add link to openmp

* ignore md041
2023-03-31 18:04:21 -06:00
searlmc1
e83512605d Update openmp.md (#2010)
Fix typo
2023-03-31 14:31:12 -06:00
Saad Rahim
e7ed560520 Cleanup Navigation for C++ Primitives (#2009) 2023-03-31 08:45:11 -06:00
Saad Rahim
110e2444e9 Navigation Links Updated (#2008) 2023-03-31 08:13:36 -06:00
nunnikri
71c16c4b96 Adding ROCm File Reorganization White Paper (#1951)
* Adding ROCm File Reorganization White Paper

* Applying formatting

* Reorganizing file structure

* Update file_reorg.md

Correcting spelling mistakes

* Update file_reorg.md

* Update file_reorg.md

---------

Co-authored-by: Saad Rahim <44449863+saadrahim@users.noreply.github.com>
Co-authored-by: Saad Rahim <saad.rahim@amd.com>
2023-03-31 07:54:50 -06:00
Nagy-Egri Máté Ferenc
2e7266c829 1908-uninstall-guide-linux (#2000) 2023-03-31 07:33:22 -06:00
Sam Wu
80778f173f Update API Refs (#2006)
* add url to ROCgdb-docs

update reqs and gitignore

* add validation tools section for RVS and TransferBench

* stub in links for validation/mgmt tools

* populate compilers page

* add cards for ai libs and computer vision pages

* add content to math lib pages

* reorg hip and math libs

* update index

* consolidate linear algebra libs
2023-03-30 15:14:43 -06:00
Ehud Sharlin
415f3b93ad Inception V3 Example, Deep Learning Guide Decomposed and OpenMP Guide (#1937) 2023-03-30 08:01:06 -06:00
Saad Rahim
63b3b55ed5 Enabling markdown lint on PRs (#2005)
* Enabling markdown lint on PRs

* Fix syntax
2023-03-29 11:05:20 -06:00
Nagy-Egri Máté Ferenc
286f120d9a MI100 architecture guide (#1994)
* Initial MI100 docs

* Try changing style to fix MD004

* Disable MD004

* Disable MD005

* Move to {table} from {list-table}

* Don't disable few MD styles
2023-03-29 07:14:23 -06:00
Aswin John Mathews
519707db4f Added support matrices (#1991)
* Added support matrices

* bullets
2023-03-28 08:45:13 -06:00
Saad Rahim
b213d94dd6 Updates to navigation organization for AI Libraries (#1993) 2023-03-25 11:33:02 -06:00
Saad Rahim
875e07b801 Figure update to figure-md (#1980) 2023-03-24 11:05:52 -06:00
Nagy-Egri Máté Ferenc
ac42cbc97b Initial ReST linting (#1979) 2023-03-24 08:34:27 -06:00
Nara
20f8185e0d ROCmCC & Win Install: Table & Figures Cleanup (#1984)
* Use MyST style table headers

* Fixup win install page

* Use option directives for args

* Revert list-tables
2023-03-24 08:32:22 -06:00
Saad Rahim
934cc718b1 Pulling libraries out in the navigation tree (#1989)
* Pulling libraries out

* add libraries listed in left sidebar to index page

* Adding all

* Updating nav tree

* fix link to rocm-examples in toc

* update TOC

---------

Co-authored-by: Sam Wu <sam.wu2@amd.com>
2023-03-24 08:08:30 -06:00
Saad Rahim
5534e47b16 License updates (#1985) 2023-03-23 09:28:56 -06:00
Saad Rahim
ca10bba2c3 Updating the contribution guide (#1982) 2023-03-22 15:53:01 -06:00
Nagy-Egri Máté Ferenc
8702d500ad Initial Markdown linting (#1978) 2023-03-22 15:45:50 +01:00
Nagy-Egri Máté Ferenc
e9ee6b9874 Initial MI250 Guide (#1976)
* Initial MI250 Guide

* Limit line length to 80 columns

* References using MyST

* Move to figure-md and numref

* Add MI250 to TOC
2023-03-22 15:45:00 +01:00
Roopa Malavally
2f51e147f2 Update licensing.md (#1981) 2023-03-21 14:36:52 -06:00
Nagy-Egri Máté Ferenc
01422a3cc4 Initial contributing guide (#1961) 2023-03-21 11:38:03 -06:00
Saad Rahim
903aae3321 Adding stub for management tools (#1971)
* Adding stub for management tools

* spelling
2023-03-20 07:15:00 -06:00
Nara
d76b9b2fbf Update about section with MyST information (#1975)
* added myst section

* US spelling
2023-03-20 07:08:32 -06:00
Saad Rahim
7f4b69c3a0 Demonstrating figure and table caption standard (#1974)
* Adding figure formatting

* Adding tables
2023-03-19 13:51:11 -06:00
Saad Rahim
e65c857ad2 Adding rocALUTION (#1970) 2023-03-17 20:47:14 -06:00
Saad Rahim
b951a2bef8 Updating HIP landing page (#1969) 2023-03-17 15:16:41 -06:00
Nagy-Egri Máté Ferenc
1a570efb48 Math Libraries Landing pages (#1940)
* Add C++ algorithm primitive lib cards

* Add PRNG section

* API Reference Manuals first

* Add Tensile and rocWMMA

* Change rocFFT and hipFFT order for consistency

* Add RCCL

* Fix PRNG links

* Add rocSOLVER and hipSOLVER

* Add general note on rocLIB vs hipLIB
2023-03-17 10:37:03 -06:00
Mészáros Gergely
75f4c018cc Quick Start Linux: Add RHEL and SLES instructions, minor touch-ups to Ubuntu (#1968)
* linux quick start: Mention correct package to install

* linux quick start: Rephrase prerequisites

Mention that installing the headers is usually not required by hand.

* linux quick start: Simplify command to get singing key

* linux quick start: Add instructions for RHEL and SLES
2023-03-17 07:13:41 -06:00
Mészáros Gergely
f1a46ae86b Update quick start guide for Ubuntu (#1964)
Reorganize the quick start guide for linux, adding multi level
tab selection for just the commands where it makes sense.

Currently mostly Ubuntu commands are filled out, if the structure
looks fine, then more will follow.
2023-03-16 12:05:47 -06:00
Alex Voicu
8bc40f4649 Fix a typo (#1962) 2023-03-16 11:08:12 -06:00
Sam Wu
d614c6e500 hide link to main ROCm docs (#1960)
ROCm already links to main ROCm docs in default sidebar header unlike other subprojects
2023-03-16 10:05:21 -06:00
Saad Rahim
3b4c592c53 Changing navbar home name (#1950)
* Changing navbar home name

* Reorg navigation tree
2023-03-16 07:47:22 -06:00
Alex Voicu
bcba7ed752 Rtd alexv feedback (#1945) 2023-03-15 12:22:25 -06:00
Mészáros Gergely
9144ac6238 Add docker deployment guide (#1938)
* Add docker deployment guide.

* Correct 'Docker Hub' styling.
2023-03-14 09:56:10 -06:00
Nara
b65adbd159 update landing page (#1939) 2023-03-14 09:19:47 -06:00
Ehud Sharlin
4ce8372761 Updates to complier doc (#1921) 2023-03-13 14:07:58 -06:00
Saad Rahim
5c80077b67 Fixing rccl link (#1935) 2023-03-13 13:08:16 -06:00
Sam Wu
5787b613f6 Add 404 page (#1933)
* Add 404 page

Only build htmlzip format for docs

* Add homepage link to 404 page
2023-03-13 12:20:47 -06:00
Mészáros Gergely
5ce34c593a Ignore more generated files in gitignore (#1934)
Add more of the sphinx generated files, so generating the docs does not
add untracked files. Ignore the folder `.venv` typically used for
virtual environments.
Also sort the ignored file list for easier maintenance.
2023-03-13 12:01:26 -06:00
Saad Rahim
3db2cff387 Fixing build (#1920) 2023-03-09 16:49:14 -07:00
Saad Rahim
555e4f078b Support levels (#1919) 2023-03-09 16:28:33 -07:00
Saad Rahim
b19681711c Pitchfork Standard for Docs (#1918) 2023-03-09 14:03:04 -07:00
Saad Rahim
67cd4c3789 Documentation Redesign (#1883) 2023-03-09 12:02:54 -07:00
zhang2amd
a2790438b5 Update manifest for v5.4.3 release 2023-02-07 13:52:06 -08:00
zhang2amd
e6646b2f38 Readme update for v5.4.3
Update README.md
2023-02-07 13:51:16 -08:00
Roopa Malavally
9126c010d4 Update README.md 2023-02-07 13:47:46 -08:00
zhang2amd
52876c050b Update manifest to v5.4.3 2023-02-07 13:33:54 -08:00
zhang2amd
81722b3451 Merge pull request #1890 from RadeonOpenCompute/Rmalavally-patch-10
Update README.md
2023-01-13 13:30:00 -08:00
Roopa Malavally
e464db856c Update README.md 2023-01-13 12:38:37 -08:00
zhang2amd
8b49837f76 Update manifest to release v5.4.1 2022-12-15 15:19:21 -08:00
zhang2amd
0e2b33f904 Merge pull request #1878 from Rmalavally/master
Update README.md
2022-12-15 15:17:49 -08:00
Roopa Malavally
4eb9653b68 Update README.md 2022-12-15 14:56:40 -08:00
zhang2amd
a1884e46fe Update manifest to v5.4 release. 2022-11-30 12:35:07 -08:00
zhang2amd
419f1a9560 Merge pull request #1870 from RadeonOpenCompute/Rmalavally-patch-8
Update README.md
2022-11-30 12:34:09 -08:00
Saad Rahim
a9c87c8b13 Adding stakeholders to CODEOWNERS file (#1823) 2022-11-30 13:22:26 -07:00
Roopa Malavally
002cca3756 Update README.md 2022-11-30 11:39:15 -08:00
zhang2amd
48ded5bc01 Update readme to fix typo, v5.3.3 release. 2022-11-17 14:24:32 -08:00
zhang2amd
ee989c21f9 Update manifest to v5.3.3 release 2022-11-17 14:15:27 -08:00
zhang2amd
b638a620ac Merge pull request #1858 from RadeonOpenCompute/Rmalavally-patch-5
Update README.md
2022-11-17 14:14:30 -08:00
Roopa Malavally
36a57f1389 Update README.md 2022-11-17 13:36:08 -08:00
Saad Rahim
c92f5af561 Adding MIT License file (#1845) 2022-11-15 12:54:14 -07:00
zhang2amd
09001c933b Update manifest file to v5.3.2 release. 2022-11-09 17:32:00 -08:00
zhang2amd
b7c9943ff7 Merge pull request #1855 from RadeonOpenCompute/Rmalavally-patch-5
Update README.md
2022-11-09 17:29:56 -08:00
Roopa Malavally
25a52ec827 Update README.md 2022-11-09 17:16:04 -08:00
zhang2amd
b14834e5a1 Merge pull request #1818 from RadeonOpenCompute/Rmalavally-patch-3
Update README.md
2022-10-04 10:19:57 -07:00
zhang2amd
368178d758 Update manifest to release 5.3.0 2022-09-30 16:20:26 -07:00
Roopa Malavally
a047d37bfe Update README.md 2022-09-30 16:09:00 -07:00
Saad Rahim
7536ef0196 Fixing Ubuntu 22 to Ubuntu 20 (#1792) 2022-08-19 14:21:53 -06:00
Saad Rahim
5241caf779 Final edits to documentation (#1791) 2022-08-18 17:26:47 -06:00
Saad Rahim
1ae99c5e4b Updates to release notes, changelog and manifest for ROCm 5.2.3 (#1788) 2022-08-18 14:37:04 -06:00
Saad Rahim
f034733da2 Adding a CODEOWNERS file (#1771) 2022-07-29 14:26:53 -06:00
Saad Rahim
d4879fdec4 Removing unused files (#1772) 2022-07-22 13:37:21 +01:00
Roopa Malavally
60957c84b7 Update README.md 2022-07-21 17:47:33 -07:00
zhozha
3859eef2a9 Update manifest to 5.2.1 release 2022-07-21 16:28:50 -07:00
zhozha
4915438362 Update manifest for ROCm 5.2 release, remove old docs 2022-06-28 18:32:04 -07:00
Roopa Malavally
c4ce059e12 Update README.md 2022-06-28 18:13:03 -07:00
Ronan Keryell
ca4d4597ba Add release note section (#1740)
* Remove spurious trailing spaces

* Move all the release notes into a global release note section
2022-05-25 22:06:01 -06:00
zhozha
418e8bfda6 Update manifest to 5.1.3 release 2022-05-20 15:58:17 -07:00
Roopa Malavally
82477df454 Update README.md 2022-05-20 15:37:38 -07:00
zhang2amd
075562b1f2 Update manifest to 5.1.1 release 2022-04-08 17:30:20 -07:00
Roopa Malavally
74d067032e Update README.md 2022-04-08 17:08:51 -07:00
zhang2amd
526846dc7e Update manifest to 5.1 release 2022-03-30 18:44:16 -07:00
Roopa Malavally
a47030ca10 Update README.md 2022-03-30 18:19:14 -07:00
zhang2amd
fac29ca466 Update default.xml for ROCm 5.0.2 release 2022-03-04 15:28:19 -08:00
Roopa Malavally
986ba19e80 Update README.md 2022-03-04 15:13:47 -08:00
Roopa Malavally
e00f7f6d59 Update README.md 2022-03-04 15:12:54 -08:00
Roopa Malavally
cac8ecf2bc Update README.md 2022-02-23 21:23:18 -08:00
Roopa Malavally
2653e081e2 Delete Hardware_and_Software_Support.md 2022-02-23 21:22:43 -08:00
Roopa Malavally
34eb2a85f3 Update Hardware_and_Software_Support.md 2022-02-23 18:30:44 -08:00
Roopa Malavally
164129954e Create Hardware_and_Software_Support.md 2022-02-23 18:29:53 -08:00
zhang2amd
eaf8e74802 Update default.xml for ROCm 5.0.1 release 2022-02-16 16:58:29 -08:00
Roopa Malavally
403c81a83e Update README.md 2022-02-16 16:54:40 -08:00
Cory Bloor
ced195c62c Cleanup README.md formatting (#1674)
* Cleanup README.md formatting

Fixed code formatting, broken URLs and changelog table.

* Update README.md

Fixup rocm-smi --showtopoaccess.
2022-02-13 08:24:02 -08:00
Roopa Malavally
3486206b09 Add files via upload 2022-02-10 16:12:04 -08:00
Roopa Malavally
c379917e1c Delete ROCm_Release_Notes_v5.0.pdf 2022-02-10 16:11:51 -08:00
Roopa Malavally
0a60a3b256 Add files via upload 2022-02-10 09:57:04 -08:00
Roopa Malavally
99a3476a5e Delete ROCm_Installation_Guide v5.0.pdf 2022-02-10 09:56:43 -08:00
Roopa Malavally
ad3a774274 Delete ROCm_Installation_Guide_v5.0.pdf 2022-02-10 08:43:38 -08:00
Roopa Malavally
5bb9c86fb6 Add files via upload 2022-02-10 08:43:17 -08:00
zhang2amd
0a0b750e0e Update default.xml for ROCm 5.0 release 2022-02-09 21:11:15 -08:00
Roopa Malavally
c6ec9d7b55 Update README.md 2022-02-09 21:09:07 -08:00
Roopa Malavally
a1eac48dea AMD ROCm Release v5.0 (#1670)
* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Add files via upload

* converting md tables

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* more changes to table

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* latest changes with alignment

* Update README.md

* Update README.md

* Update README.md

* tables made till system interface

Co-authored-by: anubhavamd <92926185+anubhavamd@users.noreply.github.com>
2022-02-09 21:07:33 -08:00
Roopa Malavally
94f4488904 Delete ROCm_SMI_Manual_4.5.pdf 2022-02-09 17:53:09 -08:00
Roopa Malavally
afc1a33ad7 Delete ROCDebugger_User_Guide.pdf 2022-02-09 17:52:22 -08:00
Roopa Malavally
9b6fb663c9 Delete ROCDebugger_API_Guide.pdf 2022-02-09 17:52:12 -08:00
Roopa Malavally
7d78a111b4 Delete RDC_API_Manual_4.5.pdf 2022-02-09 17:51:58 -08:00
Roopa Malavally
f04316efdb Delete AMD_ROCm_DataCenter_Tool_User_Guide_v4.5.pdf 2022-02-09 17:51:47 -08:00
Roopa Malavally
0083f955a7 Delete AMD_HIP_Supported_CUDA_API_Reference_Guide.pdf 2022-02-09 17:51:35 -08:00
Roopa Malavally
237e662486 Delete AMD_HIP_Programming_Guide.pdf 2022-02-09 17:51:27 -08:00
Roopa Malavally
475711bb7d Delete AMD_Compiler_Reference_Guide_v4.5.pdf 2022-02-09 17:51:17 -08:00
Roopa Malavally
dc2b00f43d Delete AMD-HIP-API-4.5.pdf 2022-02-09 17:51:09 -08:00
Roopa Malavally
c0cd1b72ce Delete AMD Instinct™High Performance Computing and Tuning Guide.pdf 2022-02-09 17:51:02 -08:00
zhozha
95493f625c Update default.xml for ROCm 4.5.2 release 2021-12-10 16:40:11 -08:00
Roopa Malavally
c3f91afb26 Update README.md 2021-12-10 16:29:05 -08:00
Roopa Malavally
d827b836b2 Update README.md 2021-12-10 16:24:06 -08:00
Roopa Malavally
99d5fb03e0 Add files via upload 2021-12-10 16:23:34 -08:00
Roopa Malavally
1f6c308006 Delete AMD_HIP_Programming_Guide.pdf 2021-12-10 16:23:21 -08:00
Roopa Malavally
bb3aa02a86 Update README.md 2021-12-10 15:47:14 -08:00
Roopa Malavally
9b82c422d0 Update README.md 2021-11-23 11:08:04 -08:00
Roopa Malavally
8eed074e8a Update README.md 2021-11-23 11:07:12 -08:00
Roopa Malavally
53db303dd3 Update README.md 2021-11-23 10:54:49 -08:00
Roopa Malavally
36ec27d9a4 Update README.md 2021-11-23 10:52:59 -08:00
Roopa Malavally
d78bb0121b Update README.md 2021-11-23 10:43:10 -08:00
Roopa Malavally
f72c130e06 Update README.md 2021-11-17 07:05:28 -08:00
zhang2amd
c058e7a1c9 Added hipamd and MIOpenTensile to manifest. 2021-11-09 07:57:31 -08:00
zhang2amd
0d12925fe9 Merge pull request #1602 from RadeonOpenCompute/zhang2amd-patch-1
Update manifest for ROCm 4.5 release.
2021-10-27 20:36:31 -07:00
zhang2amd
f088317e44 Update manifest for ROCm 4.5 release. 2021-10-27 20:35:20 -07:00
Roopa Malavally
ca8f60e96f Update README.md 2021-10-27 19:26:36 -07:00
Roopa Malavally
ba8c56abdc Update README.md 2021-10-27 19:24:34 -07:00
Roopa Malavally
18410afcd7 Add files via upload 2021-10-27 07:24:03 -07:00
Roopa Malavally
c637c2a964 Add files via upload 2021-10-26 19:00:15 -07:00
Roopa Malavally
5a56a31fac Delete AMD_HIP_Supported_CUDA_API_Reference_Guide.pdf 2021-10-26 18:59:59 -07:00
Roopa Malavally
82b35be1ee Add files via upload 2021-10-26 18:21:01 -07:00
Roopa Malavally
03fb0f863c Delete HIP-API-4.5.pdf 2021-10-26 17:28:58 -07:00
Roopa Malavally
c730ade1e3 Add files via upload 2021-10-26 17:28:44 -07:00
Roopa Malavally
164a386ed6 Add files via upload 2021-10-26 17:27:34 -07:00
Roopa Malavally
db517138f6 Add files via upload 2021-10-26 17:17:19 -07:00
Roopa Malavally
bc63e35725 Add files via upload 2021-10-26 16:49:33 -07:00
Roopa Malavally
c9a8556171 Add files via upload 2021-10-26 16:34:10 -07:00
Roopa Malavally
91f193a510 Delete AMD_ROCm_SMI_Guide_v4.3.pdf 2021-10-26 15:46:18 -07:00
Roopa Malavally
b2fac149b5 Delete AMD_ROCm_Release_Notes_v4.3.pdf 2021-10-26 15:46:04 -07:00
Roopa Malavally
1d23bb0ec6 Delete AMD_ROCm_Release_Notes_v4.3.1.pdf 2021-10-26 15:45:49 -07:00
Roopa Malavally
fedfa50634 Delete AMD_ROCm_DataCenter_Tool_User_Guide_v4.3.pdf 2021-10-26 15:45:37 -07:00
Roopa Malavally
51ea894667 Delete AMD_ROCDebugger_User_Guide.pdf 2021-10-26 15:45:26 -07:00
Roopa Malavally
63b0e6d273 Delete AMD_ROCDebugger_API.pdf 2021-10-26 15:45:14 -07:00
Roopa Malavally
f1383c5d16 Delete AMD_RDC_API_Guide_v4.3.pdf 2021-10-26 15:45:02 -07:00
Roopa Malavally
f3ec7b4720 Delete AMD_HIP_Supported_CUDA_API_Reference_Guide_v4.3.pdf 2021-10-26 15:44:52 -07:00
Roopa Malavally
9492fc9b0d Delete AMD_HIP_Programming_Guide_v4.3.pdf 2021-10-26 15:44:37 -07:00
Roopa Malavally
c103fe233f Delete AMD_HIP_API_Guide_v4.3.pdf 2021-10-26 15:44:23 -07:00
Roopa Malavally
63c16a229e Delete AMD_Compiler_Reference_Guide_v4.3.pdf 2021-10-26 15:44:08 -07:00
Paul Menzel
18aa89804f README: Replace screenshots of tables with Markdown table (#1593)
The screenshots are from tables with text, which are not easily searchable,
are bigger in size than needed – increasing load times – and are in a
resolution, causing them to be blurry on HiDPI displays.  Therefore, use a
Markdown table instead solving all the issues above, and delete the images
from the repository.

The SLES service pack version differs in the two screenshots: SP2 vs SP3.
Go for *SP3*.

Resolves: https://github.com/RadeonOpenCompute/ROCm/issues/1591
2021-10-15 06:27:44 -07:00
Roopa Malavally
65a4524834 Update README.md 2021-09-18 12:36:44 -07:00
Roopa Malavally
b04ab30e81 Delete AMD_ROCm_v2.10_Release_Notes.pdf 2021-09-15 19:40:10 -07:00
Roopa Malavally
4c8787087a Update README.md 2021-08-27 15:37:37 -07:00
Roopa Malavally
7cd85779c4 Update README.md 2021-08-27 15:31:42 -07:00
Aakash Sudhanwa
c676ff480e Update default.xml (#1567) 2021-08-27 15:26:48 -07:00
Roopa Malavally
6d19f5b6c1 Add files via upload 2021-08-27 15:24:56 -07:00
Roopa Malavally
4679e8ac87 Update README.md 2021-08-27 15:24:20 -07:00
Roopa Malavally
8a3209f985 Update README.md 2021-08-27 15:23:58 -07:00
Roopa Malavally
79d0d00b2a Update README.md 2021-08-27 15:23:18 -07:00
Roopa Malavally
db5121cdfe Update README.md 2021-08-27 15:22:30 -07:00
Aakash Sudhanwa
035f4995bb Merge branch 'master' into master 2021-08-27 15:08:41 -07:00
Roopa Malavally
f63e3f9ce1 Add files via upload 2021-08-27 15:02:49 -07:00
Roopa Malavally
4e56ed7dc3 Update README.md 2021-08-13 11:49:38 -07:00
Roopa Malavally
2faf5b6ab7 Update README.md 2021-08-13 11:48:18 -07:00
Roopa Malavally
e69b7e6f71 Delete OSKernel.PNG 2021-08-13 11:48:00 -07:00
Roopa Malavally
d53ffd1c89 Add files via upload 2021-08-13 11:47:48 -07:00
Roopa Malavally
e177599de1 Add files via upload 2021-08-09 12:55:19 -07:00
Roopa Malavally
9fc1ba3970 Add files via upload 2021-08-09 12:47:17 -07:00
Nick Curtis
520764faa3 Fix missing links in rocprof docs (#1550) 2021-08-07 08:42:25 -07:00
Roopa Malavally
7d0b53c87f Add files via upload 2021-08-03 10:53:16 -07:00
Roopa Malavally
c3a8ecd0c5 Delete AMD_Compiler_Reference_Guide_v4.3.pdf 2021-08-03 10:49:28 -07:00
Roopa Malavally
21cf37b2df Add files via upload 2021-08-02 21:37:19 -07:00
Roopa Malavally
f4419a3d1c Delete AMD_HIP_Programming_Guide_v4.3.pdf 2021-08-02 21:37:00 -07:00
zhozha
5ffdcf84ab Update to ROCm 4.3 manifest 2021-08-02 17:33:25 -07:00
Roopa Malavally
085295daea Update README.md 2021-08-02 16:51:39 -07:00
Roopa Malavally
cf5cec2580 ROCm v4.3 Release Notes (#1540)
* Delete AMD HIP Programming Guide_v4.2.pdf

* Delete AMD_HIP_API_Guide_4.2.pdf

* Delete AMD_ROCm_DataCenter_Tool_User_Guide_v4.2.pdf

* Delete AMD_ROCm_Release_Notes_v4.2.pdf

* Delete HIP_Supported_CUDA_API_Reference_Guide_v4.2.pdf

* Delete ROCm_Data_Center_Tool_API_Guide_v4.2.pdf

* Delete ROCm_Debugger_API_Guide_v4.2.pdf

* Delete ROCm_Debugger_User_Guide_v4.2.pdf

* Delete ROCm_SMI_Manual_4.2.pdf

* Update README.md

* Update README.md

* Delete CG1.PNG

* Delete CG2.PNG

* Delete CG3.PNG

* Delete CGMain.PNG

* Delete CLI1.PNG

* Delete CLI2.PNG

* Delete SMI.PNG

* Delete keyfeatures.PNG

* Delete latestGPU.PNG

* Delete rocsolverAPI.PNG

* Create test.rst

* Add files via upload

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md
2021-08-02 16:39:54 -07:00
Roopa Malavally
e7a93ae3f5 Add files via upload 2021-08-01 18:53:14 -07:00
Roopa Malavally
e3b7d2f39d Delete AMD_ROCDebugger_API.pdf.pdf 2021-08-01 18:52:58 -07:00
Roopa Malavally
0c4565d913 Delete AMD_ROCDebugger_User_Guide.pdf.pdf 2021-08-01 18:52:30 -07:00
Roopa Malavally
313a589132 Add files via upload 2021-08-01 18:52:03 -07:00
Roopa Malavally
1caf5514e8 Add files via upload 2021-08-01 18:33:33 -07:00
Roopa Malavally
d029ad24cf Add files via upload 2021-08-01 18:09:17 -07:00
Roopa Malavally
ca6638d917 Add files via upload 2021-08-01 17:42:39 -07:00
Roopa Malavally
5cba920022 Add files via upload 2021-08-01 16:21:37 -07:00
Roopa Malavally
cefc8ef1d7 Add files via upload 2021-08-01 16:17:54 -07:00
Roopa Malavally
b71c5705a2 Delete ROCm_SMI_Manual_4.2.pdf 2021-08-01 16:13:32 -07:00
Roopa Malavally
977a1d14cd Delete ROCm_Debugger_User_Guide_v4.2.pdf 2021-08-01 16:13:17 -07:00
Roopa Malavally
3ab60d1326 Delete ROCm_Debugger_API_Guide_v4.2.pdf 2021-08-01 16:13:04 -07:00
Roopa Malavally
4b5b13294e Delete ROCm_Data_Center_Tool_API_Guide_v4.2.pdf 2021-08-01 16:12:50 -07:00
Roopa Malavally
ce66b14d9e Delete HIP_Supported_CUDA_API_Reference_Guide_v4.2.pdf 2021-08-01 16:12:32 -07:00
Roopa Malavally
01f63f546f Delete AMD_ROCm_Release_Notes_v4.2.pdf 2021-08-01 16:12:20 -07:00
Roopa Malavally
72eab2779e Delete AMD_ROCm_DataCenter_Tool_User_Guide_v4.2.pdf 2021-08-01 16:12:05 -07:00
Roopa Malavally
8a366db3d7 Delete AMD_HIP_API_Guide_4.2.pdf 2021-08-01 16:11:50 -07:00
Roopa Malavally
8267a84345 Delete AMD HIP Programming Guide_v4.2.pdf 2021-08-01 16:11:30 -07:00
zhang2amd
f7b3a38d49 Merge pull request #1470 from RadeonOpenCompute/roc-4.2.x
4.2 : Manifest Files
2021-05-11 14:58:43 -07:00
Lad, Aditya
12e3bb376b 4.2 : Manifest Files 2021-05-11 14:37:52 -07:00
Roopa Malavally
a44e82f263 ROCm v4.2 Release Notes (#1469)
* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md
2021-05-11 14:15:34 -07:00
Roopa Malavally
9af988ffc8 Add files via upload 2021-05-11 14:09:17 -07:00
Roopa Malavally
5fed386cf1 Delete AMD_ROCm_Release_Notes_v4.1.pdf 2021-05-11 14:08:41 -07:00
Roopa Malavally
d729428302 Add files via upload 2021-05-10 17:47:35 -07:00
Roopa Malavally
8611c5f450 Delete ROCm_SMI_API_GUIDE_v4.1.pdf 2021-05-10 17:47:20 -07:00
Roopa Malavally
ae0b56d029 Delete AMD_HIP_Programming_Guide_v4.1.pdf 2021-05-10 17:28:58 -07:00
Roopa Malavally
3862c69b09 Add files via upload 2021-05-10 16:30:37 -07:00
Roopa Malavally
be34f32307 Add files via upload 2021-05-10 15:18:46 -07:00
Roopa Malavally
08c9cce749 Add files via upload 2021-05-10 15:18:03 -07:00
Roopa Malavally
a83a7c9206 Delete Debugging with ROCGDB User Guide v4.1.pdf 2021-05-10 15:16:45 -07:00
Roopa Malavally
71faa9c81f Delete AMD-Debugger API Guide v4.1.pdf 2021-05-10 15:16:35 -07:00
Roopa Malavally
6b021edb23 Add files via upload 2021-05-10 13:37:23 -07:00
Roopa Malavally
3936d236e6 Delete AMD_ROCm_DataCenter_Tool_User_Guide_v4.1.pdf 2021-05-10 13:37:12 -07:00
Roopa Malavally
dbcb26756d Add files via upload 2021-05-10 13:13:55 -07:00
Roopa Malavally
96de448de6 Delete HIP_Supported_CUDA_API_Reference_Guide_v4.1.pdf 2021-05-10 13:13:39 -07:00
Roopa Malavally
ee0bc562e6 Add files via upload 2021-05-10 12:01:17 -07:00
Roopa Malavally
376b8673b7 Delete ROCm_Data_Center_Tool_API_Manual_4.1.pdf 2021-05-10 12:00:11 -07:00
Roopa Malavally
e9147a9103 Add files via upload 2021-05-10 11:58:50 -07:00
Roopa Malavally
fab1a697f0 Delete AMD_HIP_API_Guide_4.2.pdf.pdf 2021-05-10 11:58:28 -07:00
Roopa Malavally
a369e642b8 Delete AMD_HIP_API_Guide_v4.1.pdf 2021-05-10 11:58:16 -07:00
Roopa Malavally
9101972654 Add files via upload 2021-05-10 11:57:52 -07:00
Roopa Malavally
f3ba8df53d Update README.md 2021-04-21 08:28:44 -07:00
Roopa Malavally
ba7a87a2dc Update README.md 2021-04-19 13:43:39 -07:00
zhang2amd
df6d746d50 Merge pull request #1443 from RadeonOpenCompute/roc-4.1.1
ROCm 4.1.1 default.xml
2021-04-08 10:06:17 -07:00
Lad, Aditya
2b2bab5bf3 ROCm 4.1.1 default.xml 2021-04-08 09:59:11 -07:00
Roopa Malavally
5ec9b12f99 Update README.md 2021-04-08 09:27:07 -07:00
Roopa Malavally
803148affd Update README.md 2021-04-08 09:21:27 -07:00
Roopa Malavally
9275fb6298 Update README.md 2021-04-08 09:19:52 -07:00
Roopa Malavally
b6ae3f145e Update README.md 2021-04-07 11:06:04 -07:00
Roopa Malavally
f80eefc965 Update README.md 2021-04-07 11:04:51 -07:00
Roopa Malavally
c5d91843a7 Update README.md 2021-04-07 11:03:31 -07:00
Roopa Malavally
733a9c097c Update README.md 2021-04-07 07:15:49 -07:00
Roopa Malavally
ff2b3f8a23 Add files via upload 2021-03-26 12:14:59 -07:00
Roopa Malavally
5a4cf1cee1 Delete AMD_ROCm_Release_Notes_v4.1.docx 2021-03-26 12:14:46 -07:00
Roopa Malavally
dccf5ca356 Update README.md 2021-03-26 12:01:54 -07:00
Roopa Malavally
8b20bd56a6 Update README.md 2021-03-26 10:00:07 -07:00
zhang2amd
65cb10e5e8 Merge pull request #1427 from xuhuisheng/patch-1
add hipFFT to default.xml
2021-03-25 23:03:26 -07:00
Roopa Malavally
ac2625dd26 Delete AMD_ROCm_Release_Notes_v4.1.pdf 2021-03-25 15:55:22 -07:00
Roopa Malavally
3716310e93 Add files via upload 2021-03-25 15:55:04 -07:00
Roopa Malavally
2dee17f7d6 Add files via upload 2021-03-25 13:03:33 -07:00
Roopa Malavally
61e8b0d70e Delete AMD_ROCm_Release_Notes_v4.1.pdf 2021-03-25 13:03:20 -07:00
Roopa Malavally
8a3304a8d9 Update README.md 2021-03-25 11:45:08 -07:00
Roopa Malavally
55488a9424 Update README.md 2021-03-25 11:03:19 -07:00
Roopa Malavally
ff4a1d4059 Update README.md 2021-03-25 10:03:46 -07:00
Xu Huisheng
4b2d93fb7e add hipFFT to default.xml
There is hipFFT on <http://repo.radeon.com/rocm/apt/4.1/pool/main/h/hipfft/>.
Please add related repository in default.xml.
Thank you.
2021-03-25 19:41:05 +08:00
Roopa Malavally
061ccd21b8 Update README.md 2021-03-24 10:26:07 -07:00
Roopa Malavally
0ed1bd9f8e Add files via upload 2021-03-24 10:25:24 -07:00
Roopa Malavally
856c74de55 Update README.md 2021-03-24 07:59:03 -07:00
Roopa Malavally
12c6f60e45 Update README.md 2021-03-24 07:58:30 -07:00
Aditya Lad
897b1e8e2d Merge pull request #1422 from RadeonOpenCompute/roc-4.1.x
Roc 4.1.x
2021-03-23 17:59:19 -07:00
Lad, Aditya
382ea7553f Remove inaccessible repos 2021-03-23 17:56:10 -07:00
Aditya Lad
2014b47dcb Merge pull request #1420 from RadeonOpenCompute/master
Addition of ROCm release notes
2021-03-23 17:29:17 -07:00
zhang2amd
b9f9bafd9b Merge pull request #1419 from RadeonOpenCompute/roc-4.1.x
ROCm 4.1 Release
2021-03-23 17:17:00 -07:00
Lad, Aditya
ff15f420c6 ROCm 4.1 default.xml edit 2021-03-23 17:10:44 -07:00
Lad, Aditya
f51c9be952 Release ROCm 4.1 Readme.md and default.xml 2021-03-23 17:03:00 -07:00
Lad, Aditya
64e254dc99 Release ROCm 4.1 Readme.md and default.xml 2021-03-23 17:01:33 -07:00
Roopa Malavally
af7f921474 Add files via upload 2021-03-23 17:00:17 -07:00
Roopa Malavally
8b3377749f Add files via upload 2021-03-23 14:16:46 -07:00
Roopa Malavally
c3a3ce55d1 Delete gdb.pdf 2021-03-22 17:29:33 -07:00
Roopa Malavally
64c727449b Delete amd-dbgapi.pdf 2021-03-22 17:29:24 -07:00
Roopa Malavally
182dfc65cf Add files via upload 2021-03-22 16:43:36 -07:00
Roopa Malavally
d529d5c585 Delete AMD_ROCm_Release_Notes_v4.0.pdf 2021-03-22 16:29:11 -07:00
Roopa Malavally
cca6bc4921 Delete HIP_Programming_Guide_v4.0.pdf 2021-03-22 16:28:56 -07:00
Roopa Malavally
e3dbbb6bbf Add files via upload 2021-03-22 16:27:41 -07:00
Roopa Malavally
6e39c80762 Add files via upload 2021-03-22 16:17:38 -07:00
Roopa Malavally
f96f5df625 Add files via upload 2021-03-22 16:07:44 -07:00
Roopa Malavally
0639a312c8 Delete ROCm_Data_Center_Too_API_Manual_4.1.pdf 2021-03-22 16:07:03 -07:00
Roopa Malavally
a2878b1460 Add files via upload 2021-03-22 15:38:16 -07:00
Roopa Malavally
1daf261d25 Delete ROCm_SMI_API_Guide_v4.0.pdf 2021-03-22 15:37:54 -07:00
Roopa Malavally
5848bc3d7e Add files via upload 2021-03-22 15:37:15 -07:00
Roopa Malavally
d9692359ad Delete HIP-API_Guide_v4.0.pdf 2021-03-22 15:36:42 -07:00
Roopa Malavally
25110784cf Add files via upload 2021-03-22 14:53:33 -07:00
Roopa Malavally
9ff31d316f Update README.md 2021-03-10 07:53:11 -08:00
Roopa Malavally
b072119ad6 Update README.md 2021-03-09 09:03:05 -08:00
Roopa Malavally
095544032c Update README.md 2021-02-25 07:28:52 -08:00
Roopa Malavally
26a39a637a Update README.md 2021-02-25 07:24:46 -08:00
Roopa Malavally
6fb55e6f45 Update README.md 2021-02-24 13:16:33 -08:00
Lad, Aditya
290091946f ROCm 4.0.1 Manifest file 2021-01-25 15:11:55 -08:00
Roopa Malavally
2874a8ae6c Update README.md 2021-01-25 15:02:27 -08:00
Roopa Malavally
f62f2b24da Add files via upload 2021-01-20 18:10:40 -08:00
Roopa Malavally
790567e3bd Update README.md 2020-12-18 15:08:54 -08:00
Roopa Malavally
57d7a202d4 Update README.md 2020-12-18 15:08:24 -08:00
Aditya Lad
80d2aa739b Merge pull request #1343 from RadeonOpenCompute/roc-4.0.x
ROCm 4.0 Release
2020-12-18 14:30:27 -08:00
Roopa Malavally
b18851f804 Update README.md 2020-12-18 13:12:20 -08:00
Roopa Malavally
0f0dbf0c92 Update README.md 2020-12-18 13:11:59 -08:00
Lad, Aditya
224a45379f ROCm 4.0 Release 2020-12-18 12:53:33 -08:00
Roopa Malavally
f521943747 Update README.md 2020-12-18 12:52:04 -08:00
Roopa Malavally
2b7f806b10 AMD ROCm Release Notes v4.0 (#1342)
* Update README.md

* Update README.md

* Add files via upload

* Delete AMD_ROCm_Release_Notes_v3.10.pdf

* Delete AMD_ROCm_DataCenter_Tool_User_Guide.pdf

* Delete ROCm_Data_Center_API_Guide.pdf

* Delete ROCm_SMI_API_Guide_v3.10.pdf

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Add files via upload

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md
2020-12-18 12:46:40 -08:00
Roopa Malavally
cd55ef67c9 Add files via upload 2020-12-18 12:32:43 -08:00
Roopa Malavally
9320669eee Delete AMD_ROCm_Release_Notes_v3.10.pdf 2020-12-18 08:19:51 -08:00
Roopa Malavally
c1211c66e3 Delete ROCm_SMI_API_Guide_v3.10.pdf 2020-12-18 08:19:36 -08:00
Roopa Malavally
c8fcff6488 Delete ROCm_Data_Center_API_Guide.pdf 2020-12-18 08:19:18 -08:00
Roopa Malavally
7118076ab4 Delete AMD_ROCm_DataCenter_Tool_User_Guide.pdf 2020-12-18 08:18:58 -08:00
Roopa Malavally
ec5523395a Add files via upload 2020-12-17 21:00:59 -08:00
Roopa Malavally
41d8f6a235 Add files via upload 2020-12-17 14:00:59 -08:00
Roopa Malavally
c69eef858a Update README.md 2020-12-10 13:38:07 -08:00
Aditya Lad
5b902ca38c Merge pull request #1316 from RadeonOpenCompute/roc-3.10.x
add rdc and half
2020-12-02 16:11:11 -08:00
Aditya Lad
68c5c198df add rdc and half 2020-12-02 16:07:15 -08:00
Aditya Lad
761ed4e70f Merge pull request #1314 from RadeonOpenCompute/roc-3.10.x
3.10 : Manifest Files
2020-12-01 16:31:55 -08:00
Lad, Aditya
8d5a160f0a 3.10 : Manifest Files 2020-12-01 16:24:12 -08:00
Roopa Malavally
f61c2ad155 Add files via upload 2020-12-01 15:45:33 -08:00
Roopa Malavally
3e2e30cc9a Delete AMD_ROCm_DataCenter_Tool_User_Guide.pdf 2020-12-01 15:44:56 -08:00
Roopa Malavally
a1f3b4e6b8 Update README.md 2020-12-01 15:08:53 -08:00
Roopa Malavally
7a3a012e6a Update README.md 2020-11-30 15:45:42 -08:00
Roopa Malavally
5b6ab31db3 Update README.md 2020-11-30 14:12:01 -08:00
Roopa Malavally
acabe2c532 Update README.md 2020-11-30 14:10:06 -08:00
Roopa Malavally
39d8bcd504 Release notes for v3.10 (#1312)
* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Add files via upload

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Delete matrix.png

* Delete ROCMCLI3.PNG

* Delete ROCMCLI2.PNG

* Delete ROCMCLI1.PNG

* Delete GEMM2.PNG

* Add files via upload

* Delete ROCm_SMI_Manual_v3.9.pdf

* Delete AMD_ROCm_Release_Notes_v3.9.pdf

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md
2020-11-30 14:07:52 -08:00
Roopa Malavally
af6d1e9b26 Add files via upload 2020-11-30 14:01:36 -08:00
Roopa Malavally
1fa1d4a935 Add files via upload 2020-11-30 09:53:49 -08:00
Roopa Malavally
03d93c1948 Delete AMD_ROCm_Release_Notes_v3.9.pdf 2020-11-30 08:55:35 -08:00
Roopa Malavally
93984b0956 Add files via upload 2020-11-30 08:54:52 -08:00
Roopa Malavally
6ccb1cfc0f Add files via upload 2020-11-30 07:29:29 -08:00
Roopa Malavally
f054f82173 Delete ROCm_SMI_Manual_v3.9.pdf 2020-11-30 07:28:11 -08:00
Xu Huisheng
bb6756b58d remove dumplicated remote=roc-github (#1248) 2020-11-18 08:19:23 -08:00
Roopa Malavally
d957b8a17c Update README.md 2020-11-12 13:47:48 -08:00
Roopa Malavally
37ece61861 Update README.md 2020-11-11 14:16:48 -08:00
Roopa Malavally
434023f31b Update README.md 2020-11-03 07:45:53 -08:00
Aditya Lad
a555260687 Merge pull request #1268 from RadeonOpenCompute/roc-3.9.x
Roc 3.9.x
2020-10-28 17:39:17 -07:00
Lad, Aditya
bf89c6bbf1 3.9 documentation 2020-10-28 15:32:49 -07:00
Lad, Aditya
bd4b772255 ROCm 3.9 default.xml 2020-10-28 15:22:02 -07:00
Lad, Aditya
e99027c39c ROCm 3.9 : Manifest files 2020-10-28 15:14:41 -07:00
Roopa Malavally
93c69afb5b Add files via upload 2020-10-28 14:54:54 -07:00
Roopa Malavally
bc2ce5c35b Delete staticlinkinglib.PNG 2020-10-28 14:52:02 -07:00
Roopa Malavally
bf633aec6b Delete forweb.PNG 2020-10-28 14:51:49 -07:00
Roopa Malavally
8608a9a1c9 Delete RDCComponentsrevised.png 2020-10-28 14:51:33 -07:00
Roopa Malavally
76afb05b6c Delete AMD_ROCm_DataCenter_Tool_User_Guide.pdf 2020-10-28 14:51:19 -07:00
Roopa Malavally
8bc67a21ea Update README.md 2020-10-19 20:23:07 -07:00
Roopa Malavally
1ce148edb1 Update README.md 2020-10-19 20:21:08 -07:00
Roopa Malavally
cc6147c25b Update README.md 2020-10-19 20:20:20 -07:00
Roopa Malavally
aadd9e68e1 Update README.md 2020-10-19 20:17:34 -07:00
Roopa Malavally
dce5aee2dc Add files via upload 2020-10-19 19:34:27 -07:00
Aditya Lad
0bcae510a3 Merge pull request #1244 from RadeonOpenCompute/roc-3.8.x
Remove MiGraphX from 3.8
2020-09-25 10:06:57 -07:00
Lad, Aditya
86a09b146b Remove MiGraphX from 3.8 2020-09-25 10:05:32 -07:00
Roopa Malavally
506cdcf6db Update README.md 2020-09-25 08:06:49 -07:00
Roopa Malavally
a919ba64c9 Update README.md 2020-09-25 08:00:10 -07:00
Roopa Malavally
fae25ccf9b Update README.md 2020-09-22 16:52:31 -07:00
Lad, Aditya
d1f9aa98a3 hipfort addition to 3.8 2020-09-22 11:38:23 -07:00
Lad, Aditya
42fa0e0765 Remove version_history.md file. Since we are currently maintaining it on external documentation. 2020-09-21 16:04:25 -07:00
Lad, Aditya
e89903ed3a ROCm release 3.8 2020-09-21 15:58:09 -07:00
Roopa Malavally
ba2e1f0109 ROCm v3.8 Release Notes (#1226)
* Update README.md

* Add files via upload

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Add files via upload

* Delete staticlinkinglib.PNG

* Add files via upload

* Delete staticlinkinglib.PNG

* Add files via upload

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Delete AMD_ROCm_Release_Notes_v3.7.pdf

* Update README.md

* Update README.md

* Update README.md

* Add files via upload

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Update README.md
2020-09-21 15:47:24 -07:00
Roopa Malavally
a1830b5330 Add files via upload 2020-09-17 12:23:13 -07:00
Roopa Malavally
0c596d155a Update README.md 2020-09-07 10:46:57 -07:00
Roopa Malavally
75c0d668d9 Update README.md 2020-09-02 06:13:56 -07:00
Roopa Malavally
49bd50c858 Update README.md 2020-09-02 06:13:23 -07:00
Roopa Malavally
a54214d05d Update README.md 2020-09-02 06:12:10 -07:00
Roopa Malavally
2524166765 Update README.md 2020-08-23 18:33:23 -07:00
Roopa Malavally
abc65687d4 Add files via upload 2020-08-23 09:44:46 -07:00
Roopa Malavally
0fddb14b8f Delete AMD_ROCm_Release_Notes_v3.7.pdf 2020-08-23 09:44:30 -07:00
Roopa Malavally
3909efb389 Update README.md 2020-08-23 09:34:53 -07:00
Aakash Sudhanwa
67bd7501c1 Update README.md 2019-12-18 14:10:38 -08:00
Aakash Sudhanwa
d62f1c4247 Merge pull request #12 from RadeonOpenCompute/master
Rebase
2019-12-18 14:09:40 -08:00
Aakash Sudhanwa
c3d5bc6406 Rename Release nodes pdf 2019-11-25 20:54:25 -08:00
Aakash Sudhanwa
db45731729 Merge pull request #11 from RadeonOpenCompute/master
ROCm Release 2.10 (#947)
2019-11-25 20:12:36 -08:00
Aakash Sudhanwa
34552e95e0 Release Notes 2019-11-25 19:23:24 -08:00
Aakash Sudhanwa
8d0c516c5c Merge pull request #10 from RadeonOpenCompute/master
Update to 2.10
2019-11-25 19:20:50 -08:00
Aakash Sudhanwa
5cba919767 default.xml: ROCm Rel 2.10 2019-11-25 14:38:06 -08:00
Aakash Sudhanwa
bb0022e972 Merge pull request #9 from RadeonOpenCompute/master
Updating to latest
2019-11-25 13:04:27 -08:00
193 changed files with 16042 additions and 981 deletions

1
.github/CODEOWNERS vendored Normal file
View File

@@ -0,0 +1 @@
* @saadrahim @Rmalavally @amd-aakash @zhang2amd @jlgreathouse @samjwu @MathiasMagnus

12
.github/dependabot.yml vendored Normal file
View File

@@ -0,0 +1,12 @@
# 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"

56
.github/workflows/linting.yml vendored Normal file
View File

@@ -0,0 +1,56 @@
name: Linting
on:
push:
branches:
- develop
- main
pull_request:
branches:
- develop
- main
concurrency:
group: ${{ github.ref }}-${{ github.workflow }}
cancel-in-progress: true
jobs:
lint-rest:
name: "RestructuredText"
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v3
- name: Install rst-lint
run: pip install restructuredtext-lint
- name: Lint ResT files
run: rst-lint ${{ join(github.workspace, '/docs') }}
lint-md:
name: "Markdown"
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v3
- name: Use markdownlint-cli2
uses: DavidAnson/markdownlint-cli2-action@v10.0.1
with:
globs: '**/*.md'
spelling:
name: "Spelling"
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v3
- name: Fetch config
shell: sh
run: |
curl --silent --show-error --fail --location https://raw.github.com/RadeonOpenCompute/rocm-docs-core/develop/.spellcheck.yaml -O
curl --silent --show-error --fail --location https://raw.github.com/RadeonOpenCompute/rocm-docs-core/develop/.wordlist.txt >> .wordlist.txt
- name: Run spellcheck
uses: rojopolis/spellcheck-github-actions@0.30.0
- name: On fail
if: failure()
run: |
echo "Please check for spelling mistakes or add them to '.wordlist.txt' in either the root of this project or in rocm-docs-core."

18
.gitignore vendored Normal file
View File

@@ -0,0 +1,18 @@
.venv
.vscode
build
# documentation artifacts
_build/
_images/
_static/
_templates/
_toc.yml
docBin/
_doxygen/
_readthedocs/
# avoid duplicating contributing.md due to conf.py
docs/contributing.md
docs/release.md
docs/CHANGELOG.md

14
.markdownlint-cli2.yaml Normal file
View File

@@ -0,0 +1,14 @@
config:
default: true
MD013: false
MD026:
punctuation: '.,;:!'
MD029:
style: ordered
MD033: false
MD034: false
MD041: false
ignores:
- CHANGELOG.md
- "{,docs/}{RELEASE,release}.md"
- tools/autotag/templates/**/*.md

21
.readthedocs.yaml Normal file
View File

@@ -0,0 +1,21 @@
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
version: 2
build:
os: ubuntu-22.04
tools:
python: "3.10"
apt_packages:
- "doxygen"
- "graphviz" # For dot graphs in doxygen
python:
install:
- requirements: docs/sphinx/requirements.txt
sphinx:
configuration: docs/conf.py
formats: []

29
.wordlist.txt Normal file
View File

@@ -0,0 +1,29 @@
# isv_deployment_win
ABI
# gpu_aware_mpi
DMA
GDR
HCA
MPI
MVAPICH
Mellanox's
NIC
OFED
OSU
OpenFabrics
PeerDirect
RDMA
UCX
ib_core
# linear algebra
LAPACK
MMA
backends
cuSOLVER
cuSPARSE
# tuning_guides
BMC
DGEMM
HPCG
HPL
IOPM

Binary file not shown.

1416
CHANGELOG.md Normal file

File diff suppressed because it is too large Load Diff

246
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,246 @@
# Contributing to ROCm Docs
AMD values and encourages the ROCm community to contribute to our code and
documentation. This repository is focused on ROCm documentation and this
contribution guide describes the recommend method for creating and modifying our
documentation.
While interacting with ROCm Documentation, we encourage you to be polite and
respectful in your contributions, content or otherwise. Authors, maintainers of
these docs act on good intentions and to the best of their knowledge.
Keep that in mind while you engage. Should you have issues with contributing
itself, refer to
[discussions](https://github.com/RadeonOpenCompute/ROCm/discussions) on the
GitHub repository.
## Supported Formats
Our documentation includes both markdown and rst files. Markdown is encouraged
over rst due to the lower barrier to participation. GitHub flavored markdown is preferred
for all submissions as it will render accurately on our GitHub repositories. For existing documentation,
[MyST](https://myst-parser.readthedocs.io/en/latest/intro.html) markdown
is used to implement certain features unsupported in GitHub markdown. This is
not encouraged for new documentation. AMD will transition
to stricter use of GitHub flavored markdown with a few caveats. ROCm documentation
also uses [sphinx-design](https://sphinx-design.readthedocs.io/en/latest/index.html)
in our markdown and rst files. We also will use breathe syntax for doxygen documentation
in our markdown files. Other design elements for effective HTML rendering of the documents
may be added to our markdown files. Please see
[GitHub](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github)'s
guide on writing and formatting on GitHub as a starting point.
ROCm documentation adds additional requirements to markdown and rst based files
as follows:
- Level one headers are only used for page titles. There must be only one level
1 header per file for both Markdown and Restructured Text.
- Pass [markdownlint](https://github.com/markdownlint/markdownlint) check via
our automated github action on a Pull Request (PR).
## Filenames and folder structure
Please use snake case for file names. Our documentation follows pitchfork for
folder structure. All documentation is in /docs except for special files like
the contributing guide in the / folder. All images used in the documentation are
place in the /docs/data folder.
## How to provide feedback for for ROCm documentation
There are three standard ways to provide feedback for this repository.
### Pull Request
All contributions to ROCm documentation should arrive via the
[GitHub Flow](https://docs.github.com/en/get-started/quickstart/github-flow)
targetting the develop branch of the repository. If you are unable to contribute
via the GitHub Flow, feel free to email us. TODO, confirm email address.
### GitHub Issue
Issues on existing or absent docs can be filed as [GitHub issues
](https://github.com/RadeonOpenCompute/ROCm/issues).
### Email Feedback
## Language and Style
Adopting Microsoft CPP-Docs guidelines for [Voice and Tone
](https://github.com/MicrosoftDocs/cpp-docs/blob/main/styleguide/voice-tone.md).
ROCm documentation templates to be made public shortly. ROCm templates dictate
the recommended structure and flow of the documentation. Guidelines on how to
integrate figures, equations, and tables are all based off
[MyST](https://myst-parser.readthedocs.io/en/latest/intro.html).
Font size and selection, page layout, white space control, and other formatting
details are controlled via rocm-docs-core, sphinx extention. Please raise issues
in rocm-docs-core for any formatting concerns and changes requested.
## Building Documentation
While contributing, one may build the documentation locally on the command-line
or rely on Continuous Integration for previewing the resulting HTML pages in a
browser.
### Command line documentation builds
Python versions known to build documentation:
- 3.8
To build the docs locally using Python Virtual Environment (`venv`), execute the
following commands from the project root:
```sh
python3 -mvenv .venv
# Windows
.venv/Scripts/python -m pip install -r docs/sphinx/requirements.txt
.venv/Scripts/python -m sphinx -T -E -b html -d _build/doctrees -D language=en docs _build/html
# Linux
.venv/bin/python -m pip install -r docs/sphinx/requirements.txt
.venv/bin/python -m sphinx -T -E -b html -d _build/doctrees -D language=en docs _build/html
```
Then open up `_build/html/index.html` in your favorite browser.
### Pull Requests documentation builds
When opening a PR to the `develop` branch on GitHub, the page corresponding to
the PR (`https://github.com/RadeonOpenCompute/ROCm/pull/<pr_number>`) will have
a summary at the bottom. This requires the user be logged in to GitHub.
- There, click `Show all checks` and `Details` of the Read the Docs pipeline. It
will take you to `https://readthedocs.com/projects/advanced-micro-devices-rocm/
builds/<some_build_num>/`
- The list of commands shown are the exact ones used by CI to produce a render
of the documentation.
- There, click on the small blue link `View docs` (which is not the same as the
bigger button with the same text). It will take you to the built HTML site with
a URL of the form `https://
advanced-micro-devices-demo--<pr_number>.com.readthedocs.build/projects/alpha/en
/<pr_number>/`.
### Build the docs using VS Code
One can put together a productive environment to author documentation and also
test it locally using VS Code with only a handful of extensions. Even though the
extension landscape of VS Code is ever changing, here is one example setup that
proved useful at the time of writing. In it, one can change/add content, build a
new version of the docs using a single VS Code Task (or hotkey), see all errors/
warnings emitted by Sphinx in the Problems pane and immediately see the
resulting website show up on a locally serving web server.
#### Configuring VS Code
1. Install the following extensions:
- Python (ms-python.python)
- Live Server (ritwickdey.LiveServer)
2. Add the following entries in `.vscode/settings.json`
```json
{
"liveServer.settings.root": "/.vscode/build/html",
"liveServer.settings.wait": 1000,
"python.terminal.activateEnvInCurrentTerminal": true
}
```
The settings in order are set for the following reasons:
- Sets the root of the output website for live previews. Must be changed
alongside the `tasks.json` command.
- Tells live server to wait with the update to give time for Sphinx to
regenerate site contents and not refresh before all is don. (Empirical value)
- Automatic virtual env activation is a nice touch, should you want to build
the site from the integrated terminal.
3. Add the following tasks in `.vscode/tasks.json`
```json
{
"version": "2.0.0",
"tasks": [
{
"label": "Build Docs",
"type": "process",
"windows": {
"command": "${workspaceFolder}/.venv/Scripts/python.exe"
},
"command": "${workspaceFolder}/.venv/bin/python3",
"args": [
"-m",
"sphinx",
"-j",
"auto",
"-T",
"-b",
"html",
"-d",
"${workspaceFolder}/.vscode/build/doctrees",
"-D",
"language=en",
"${workspaceFolder}/docs",
"${workspaceFolder}/.vscode/build/html"
],
"problemMatcher": [
{
"owner": "sphinx",
"fileLocation": "absolute",
"pattern": {
"regexp": "^(?:.*\\.{3}\\s+)?(\\/[^:]*|[a-zA-Z]:\\\\[^:]*):(\\d+):\\s+(WARNING|ERROR):\\s+(.*)$",
"file": 1,
"line": 2,
"severity": 3,
"message": 4
},
},
{
"owner": "sphinx",
"fileLocation": "absolute",
"pattern": {
"regexp": "^(?:.*\\.{3}\\s+)?(\\/[^:]*|[a-zA-Z]:\\\\[^:]*):{1,2}\\s+(WARNING|ERROR):\\s+(.*)$",
"file": 1,
"severity": 2,
"message": 3
}
}
],
"group": {
"kind": "build",
"isDefault": true
}
},
],
}
```
> (Implementation detail: two problem matchers were needed to be defined,
> because VS Code doesn't tolerate some problem information being potentially
> absent. While a single regex could match all types of errors, if a capture
> group remains empty (the line number doesn't show up in all warning/error
> messages) but the `pattern` references said empty capture group, VS Code
> discards the message completely.)
4. Configure Python virtual environment (venv)
- From the Command Palette, run `Python: Create Environment`
- Select `venv` environment and the `docs/sphinx/requirements.txt` file.
_(Simply pressing enter while hovering over the file from the dropdown is
insufficient, one has to select the radio button with the 'Space' key if
using the keyboard.)_
5. Build the docs
- Launch the default build Task using either:
- a hotkey _(default is 'Ctrl+Shift+B')_ or
- by issuing the `Tasks: Run Build Task` from the Command Palette.
6. Open the live preview
- Navigate to the output of the site within VS Code, right-click on
`.vscode/build/html/index.html` and select `Open with Live Server`. The
contents should update on every rebuild without having to refresh the
browser.
<!-- markdownlint-restore -->

21
LICENSE Normal file
View File

@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2023 Advanced Micro Devices, Inc. All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

472
README.md
View File

@@ -1,448 +1,54 @@
# AMD ROCm™ Platform
# AMD ROCm Release Notes v3.7.0
ROCm™ is an open-source stack for GPU computation. ROCm is primarily Open-Source
Software (OSS) that allows developers the freedom to customize and tailor their
GPU software for their own needs while collaborating with a community of other
developers, and helping each other find solutions in an agile, flexible, rapid
and secure manner.
This page describes the features, fixed issues, and information about downloading and installing the ROCm software.
It also covers known issues and deprecated features in this release.
ROCm is a collection of drivers, development tools and APIs enabling GPU
programming from the low-level kernel to end-user applications. ROCm is powered
by AMDs Heterogeneous-computing Interface for Portability (HIP), an OSS C++ GPU
programming environment and its corresponding runtime. HIP allows ROCm
developers to create portable applications on different platforms by deploying
code on a range of platforms, from dedicated gaming GPUs to exascale HPC
clusters. ROCm supports programming models such as OpenMP and OpenCL, and
includes all the necessary OSS compilers, debuggers and libraries. ROCm is fully
integrated into ML frameworks such as PyTorch and TensorFlow. ROCm can be
deployed in many ways, including through the use of containers such as Docker,
Spack, and your own build from source.
- [Supported Operating Systems and Documentation Updates](#Supported-Operating-Systems-and-Documentation-Updates)
* [Supported Operating Systems](#Supported-Operating-Systems)
* [AMD ROCm Documentation Updates](#AMD-ROCm-Documentation-Updates)
- [What\'s New in This Release](#Whats-New-in-This-Release)
* [AOMP Enhancements](#AOMP-Enhancements)
* [Compatibility with NVIDIA Communications Collective Library v2\.7 API](#Compatibility-with-NVIDIA-Communications-Collective-Library-v27-API)
* [Singular Value Decomposition of Bi\-diagonal Matrices](#Singular-Value-Decomposition-of-Bi-diagonal-Matrices)
* [rocSPARSE_gemmi\() Operations for Sparse Matrices](#rocSPARSE_gemmi-Operations-for-Sparse-Matrices)
- [Known Issues](#Known-Issues)
ROCms goal is to allow our users to maximize their GPU hardware investment.
ROCm is designed to help develop, test and deploy GPU accelerated HPC, AI,
scientific computing, CAD, and other applications in a free, open-source,
integrated and secure software ecosystem.
- [Deploying ROCm](#Deploying-ROCm)
- [Hardware and Software Support](#Hardware-and-Software-Support)
This repository contains the manifest file for ROCm™ releases, changelogs, and
release information. The file default.xml contains information for all
repositories and the associated commit used to build the current ROCm release.
- [Machine Learning and High Performance Computing Software Stack for AMD GPU](#Machine-Learning-and-High-Performance-Computing-Software-Stack-for-AMD-GPU)
* [ROCm Binary Package Structure](#ROCm-Binary-Package-Structure)
* [ROCm Platform Packages](#ROCm-Platform-Packages)
The default.xml file uses the repo Manifest format.
The develop branch of this repository contains content for the next
ROCm release.
# Supported Operating Systems
## ROCm Documentation
## Support for Ubuntu 20.04
ROCm Documentation is available online at
[rocm.docs.amd.com](https://rocm.docs.amd.com). Source code for the documenation
is located in the docs folder of most repositories that are part of ROCm.
### How to build documentation via Sphinx
In this release, AMD ROCm extends support to Ubuntu 20.04, including dual-kernel.
```bash
cd docs
## List of Supported Operating Systems
pip3 install -r sphinx/requirements.txt
The AMD ROCm v3.7.x platform is designed to support the following operating systems:
* Ubuntu 20.04 and 18.04.4 (Kernel 5.3)
* CentOS 7.8 & RHEL 7.8 (Kernel 3.10.0-1127) (Using devtoolset-7 runtime support)
* CentOS 8.2 & RHEL 8.2 (Kernel 4.18.0 ) (devtoolset is not required)
* SLES 15 SP1
## Fresh Installation of AMD ROCm v3.7 Recommended
A fresh and clean installation of AMD ROCm v3.7 is recommended. An upgrade from previous releases to AMD ROCm v3.7 is not supported.
For more information, refer to the AMD ROCm Installation Guide at:
https://rocmdocs.amd.com/en/latest/Installation_Guide/Installation-Guide.html
**Note**: AMD ROCm release v3.3 or prior releases are not fully compatible with AMD ROCm v3.5 and higher versions. You must perform a fresh ROCm installation if you want to upgrade from AMD ROCm v3.3 or older to 3.5 or higher versions and vice-versa.
# AMD ROCm Documentation Updates
## AMD ROCm Installation Guide
The AMD ROCm Installation Guide in this release includes:
* Updated Supported Environments
* HIP Installation Instructions
https://rocmdocs.amd.com/en/latest/Installation_Guide/Installation-Guide.html
## AMD ROCm - HIP Documentation Updates
### Texture and Surface Functions
The documentation for Texture and Surface functions is updated and available at:
https://rocmdocs.amd.com/en/latest/Programming_Guides/Kernel_language.html
### Warp Shuffle Functions
The documentation for Warp Shuffle functions is updated and available at:
https://rocmdocs.amd.com/en/latest/Programming_Guides/Kernel_language.html
### Compiler Defines and Environment Variables
The documentation for the updated HIP Porting Guide is available at:
https://rocmdocs.amd.com/en/latest/Programming_Guides/HIP-porting-guide.html#hip-porting-guide
## AMD ROCm Debug Agent
ROCm Debug Agent Library
https://rocmdocs.amd.com/en/latest/ROCm_Tools/rocm-debug-agent.html
## General AMD ROCm Documentatin Links
Access the following links for more information:
* For AMD ROCm documentation, see
https://rocmdocs.amd.com/en/latest/
* For installation instructions on supped platforms, see
https://rocmdocs.amd.com/en/latest/Installation_Guide/Installation-Guide.html
* For AMD ROCm binary structure, see
https://rocmdocs.amd.com/en/latest/Installation_Guide/Installation-Guide.html#build-amd-rocm
* For AMD ROCm Release History, see
https://rocmdocs.amd.com/en/latest/Installation_Guide/Installation-Guide.html#amd-rocm-version-history
# What\'s New in This Release
## AOMP ENHANCEMENTS
AOMP is a scripted build of LLVM. It supports OpenMP target offload on AMD GPUs. Since AOMP is a Clang/LLVM compiler, it also supports GPU offloading with HIP, CUDA, and OpenCL.
The following enhancements are made for AOMP in this release:
* OpenMP 5.0 is enabled by default. You can use -fopenmp-version=45 for OpenMP 4.5 compliance
* Restructured to include the ROCm compiler
* B=Bitcode search path using hip policy HIP_DEVICE_LIB_PATH and hip-devic-lib command line option to enable global_free for kmpc_impl_free
Restructured hostrpc, including:
* Replaced hostcall register functions with handlePayload(service, payload). Note, handlPayload has a simple switch to call the correct service handler function.
* Removed the WITH_HSA macro
* Moved the hostrpc stubs and host fallback functions into a single library and the include file. This enables the stubs openmp cpp source instead of hip and reorganizes the directory openmp/libomptarget/hostrpc.
* Moved hostrpc_invoke.cl to DeviceRTLs/amdgcn.
* Generalized the vargs processing in printf to work for any vargs function to execute on the host, including a vargs function that uses a function pointer.
* Reorganized files, added global_allocate and global_free.
* Fixed llvm TypeID enum to match the current upstream llvm TypeID.
* Moved strlen_max function inside the declare target #ifdef _DEVICE_GPU in hostrpc.cpp to resolve linker failure seen in pfspecifier_str smoke test.
* Fixed AOMP_GIT_CHECK_BRANCH in aomp_common_vars to not block builds in Red Hat if the repository is on a specific commit hash.
* Simplified and reduced the size of openmp host runtime
* Switched to default OpenMP 5.0
For more information, see https://github.com/ROCm-Developer-Tools/aomp
## ROCm COMMUNICATIONS COLLECTIVE LIBRARY
### Compatibility with NVIDIA Communications Collective Library v2\.7 API
ROCm Communications Collective Library (RCCL) is now compatible with the NVIDIA Communications Collective Library (NCCL) v2.7 API.
RCCL (pronounced "Rickle") is a stand-alone library of standard collective communication routines for GPUs, implementing all-reduce, all-gather, reduce, broadcast, reduce-scatter, gather, scatter, and all-to-all. There is also initial support for direct GPU-to-GPU send and receive operations. It has been optimized to achieve high bandwidth on platforms using PCIe, xGMI as well as networking using InfiniBand Verbs or TCP/IP sockets. RCCL supports an arbitrary number of GPUs installed in a single node or multiple nodes, and can be used in either single- or multi-process (e.g., MPI) applications.
The collective operations are implemented using ring and tree algorithms and have been optimized for throughput and latency. For best performance, small operations can be either batched into larger operations or aggregated through the API.
For more information about RCCL APIs and compatibility with NCCL v2.7, see
https://rccl.readthedocs.io/en/develop/index.html
## Singular Value Decomposition of Bi\-diagonal Matrices
Rocsolver_bdsqr now computes the Singular Value Decomposition (SVD) of bi-diagonal matrices. It is an auxiliary function for the SVD of general matrices (function rocsolver_gesvd).
BDSQR computes the singular value decomposition (SVD) of a n-by-n bidiagonal matrix B.
The SVD of B has the following form:
B = Ub * S * Vb'
where
• S is the n-by-n diagonal matrix of singular values of B
• the columns of Ub are the left singular vectors of B
• the columns of Vb are its right singular vectors
The computation of the singular vectors is optional; this function accepts input matrices U (of size nu-by-n) and V (of size n-by-nv) that are overwritten with U*Ub and Vb*V. If nu = 0 no left vectors are computed; if nv = 0 no right vectors are computed.
Optionally, this function can also compute Ub*C for a given n-by-nc input matrix C.
PARAMETERS
• [in] handle: rocblas_handle.
• [in] uplo: rocblas_fill.
Specifies whether B is upper or lower bidiagonal.
• [in] n: rocblas_int. n >= 0.
The number of rows and columns of matrix B.
• [in] nv: rocblas_int. nv >= 0.
The number of columns of matrix V.
• [in] nu: rocblas_int. nu >= 0.
The number of rows of matrix U.
• [in] nc: rocblas_int. nu >= 0.
The number of columns of matrix C.
• [inout] D: pointer to real type. Array on the GPU of dimension n.
On entry, the diagonal elements of B. On exit, if info = 0, the singular values of B in decreasing order; if info > 0, the diagonal elements of a bidiagonal matrix orthogonally equivalent to B.
• [inout] E: pointer to real type. Array on the GPU of dimension n-1.
On entry, the off-diagonal elements of B. On exit, if info > 0, the off-diagonal elements of a bidiagonal matrix orthogonally equivalent to B (if info = 0 this matrix converges to zero).
• [inout] V: pointer to type. Array on the GPU of dimension ldv*nv.
On entry, the matrix V. On exit, it is overwritten with Vb*V. (Not referenced if nv = 0).
• [in] ldv: rocblas_int. ldv >= n if nv > 0, or ldv >=1 if nv = 0.
Specifies the leading dimension of V.
• [inout] U: pointer to type. Array on the GPU of dimension ldu*n.
On entry, the matrix U. On exit, it is overwritten with U*Ub. (Not referenced if nu = 0).
• [in] ldu: rocblas_int. ldu >= nu.
Specifies the leading dimension of U.
• [inout] C: pointer to type. Array on the GPU of dimension ldc*nc.
On entry, the matrix C. On exit, it is overwritten with Ub*C. (Not referenced if nc = 0).
• [in] ldc: rocblas_int. ldc >= n if nc > 0, or ldc >=1 if nc = 0.
Specifies the leading dimension of C.
• [out] info: pointer to a rocblas_int on the GPU.
If info = 0, successful exit. If info = i > 0, i elements of E have not converged to zero.
For more information, see
https://rocsolver.readthedocs.io/en/latest/userguide_api.html#rocsolver-type-bdsqr
### rocSPARSE_gemmi\() Operations for Sparse Matrices
This enhancement provides a dense matrix sparse matrix multiplication using the CSR storage format.
rocsparse_gemmi multiplies the scalar αα with a dense m×km×k matrix AA and the sparse k×nk×n matrix BB defined in the CSR storage format, and adds the result to the dense m×nm×n matrix CC that is multiplied by the scalar ββ, such that
C:=α⋅op(A)⋅op(B)+β⋅CC:=α⋅op(A)⋅op(B)+β⋅C
with
op(A)=⎧⎩⎨⎪⎪A,AT,AH,if trans_A == rocsparse_operation_noneif trans_A == rocsparse_operation_transposeif trans_A == rocsparse_operation_conjugate_transposeop(A)={A,if trans_A == rocsparse_operation_noneAT,if trans_A == rocsparse_operation_transposeAH,if trans_A == rocsparse_operation_conjugate_transpose
and
op(B)=⎧⎩⎨⎪⎪B,BT,BH,if trans_B == rocsparse_operation_noneif trans_B == rocsparse_operation_transposeif trans_B == rocsparse_operation_conjugate_transposeop(B)={B,if trans_B == rocsparse_operation_noneBT,if trans_B == rocsparse_operation_transposeBH,if trans_B == rocsparse_operation_conjugate_transpose
Note: This function is non-blocking and executed asynchronously with the host. It may return before the actual computation has finished.
For more information and examples, see
https://rocsparse.readthedocs.io/en/master/usermanual.html#rocsparse-gemmi
# Known Issues
The following are the known issues in this release.
## (AOMP) Undefined Hidden Symbol Linker Error Causes Compilation Failure in HIP
The HIP example device_lib fails to compile due to unreferenced symbols with Link Time Optimization resulting in undefined hidden symbol errors.
This issue is under investigation and there is no known workaround at this time.
## MIGraphX Fails for fp16 Datatype
The MIGraphX functionality does not work for the fp16 datatype.
The following workaround is recommended:
Use the AMD ROCm v3.3 of MIGraphX
Or
Build MIGraphX v3.7 from the source using AMD ROCm v3.3
## Missing Google Test Installation May Cause RCCL Unit Test Compilation Failure
Users of the RCCL install.sh script may encounter an RCCL unit test compilation error. It is recommended to use CMAKE directly instead of install.sh to compile RCCL. Ensure Google Test 1.10+ is available in the CMAKE search path.
As a workaround, use the latest RCCL from the GitHub development branch at:
https://github.com/ROCmSoftwarePlatform/rccl/pull/237
## Issue with Peer-to-Peer Transfers
Using peer-to-peer (P2P) transfers on systems without the hardware P2P assistance may produce incorrect results.
Ensure the hardware supports peer-to-peer transfers and enable the peer-to-peer setting in the hardware to resolve this issue.
## Partial Loss of Tracing Events for Large Applications
An internal tracing buffer allocation issue can cause a partial loss of some tracing events for large applications.
As a workaround, rebuild the roctracer/rocprofiler libraries from the GitHub roc-3.7 branch at:
• https://github.com/ROCm-Developer-Tools/rocprofiler
• https://github.com/ROCm-Developer-Tools/roctracer
## GPU Kernel C++ Names Not Demangled
GPU kernel C++ names in the profiling traces and stats produced by —hsa-trace option are not demangled.
As a workaround, users may choose to demangle the GPU kernel C++ names as required.
## rocprof option --parallel-kernels Not Supported in This Release
rocprof option --parallel-kernels is available in the options list, however, it is not fully validated and supported in this release.
## Random Soft Hang Observed When Running ResNet-Based Models
A random soft hang is observed when running ResNet-based models for a loop run of more than 25 to 30 hours. The issue is observed on both PyTorch and TensorFlow frameworks.
You can terminate the unresponsive process to temporarily resolve the issue.
There is no known workaround at this time.
# Deploying ROCm
AMD hosts both Debian and RPM repositories for the ROCm v3.7.x packages.
For more information on ROCM installation on all platforms, see
https://rocmdocs.amd.com/en/latest/Installation_Guide/Installation-Guide.html
# Hardware and Software Support
ROCm is focused on using AMD GPUs to accelerate computational tasks such as machine learning, engineering workloads, and scientific computing.
In order to focus our development efforts on these domains of interest, ROCm supports a targeted set of hardware configurations which are detailed further in this section.
#### Supported GPUs
Because the ROCm Platform has a focus on particular computational domains, we offer official support for a selection of AMD GPUs that are designed to offer good performance and price in these domains.
ROCm officially supports AMD GPUs that use following chips:
* GFX8 GPUs
* "Fiji" chips, such as on the AMD Radeon R9 Fury X and Radeon Instinct MI8
* "Polaris 10" chips, such as on the AMD Radeon RX 580 and Radeon Instinct MI6
* GFX9 GPUs
* "Vega 10" chips, such as on the AMD Radeon RX Vega 64 and Radeon Instinct MI25
* "Vega 7nm" chips, such as on the Radeon Instinct MI50, Radeon Instinct MI60 or AMD Radeon VII
ROCm is a collection of software ranging from drivers and runtimes to libraries and developer tools.
Some of this software may work with more GPUs than the "officially supported" list above, though AMD does not make any official claims of support for these devices on the ROCm software platform.
The following list of GPUs are enabled in the ROCm software, though full support is not guaranteed:
* GFX8 GPUs
* "Polaris 11" chips, such as on the AMD Radeon RX 570 and Radeon Pro WX 4100
* "Polaris 12" chips, such as on the AMD Radeon RX 550 and Radeon RX 540
* GFX7 GPUs
* "Hawaii" chips, such as the AMD Radeon R9 390X and FirePro W9100
As described in the next section, GFX8 GPUs require PCI Express 3.0 (PCIe 3.0) with support for PCIe atomics. This requires both CPU and motherboard support. GFX9 GPUs require PCIe 3.0 with support for PCIe atomics by default, but they can operate in most cases without this capability.
The integrated GPUs in AMD APUs are not officially supported targets for ROCm.
As described [below](#limited-support), "Carrizo", "Bristol Ridge", and "Raven Ridge" APUs are enabled in our upstream drivers and the ROCm OpenCL runtime.
However, they are not enabled in the HIP runtime, and may not work due to motherboard or OEM hardware limitations.
As such, they are not yet officially supported targets for ROCm.
For a more detailed list of hardware support, please see [the following documentation](https://rocm.github.io/hardware.html).
#### Supported CPUs
As described above, GFX8 GPUs require PCIe 3.0 with PCIe atomics in order to run ROCm.
In particular, the CPU and every active PCIe point between the CPU and GPU require support for PCIe 3.0 and PCIe atomics.
The CPU root must indicate PCIe AtomicOp Completion capabilities and any intermediate switch must indicate PCIe AtomicOp Routing capabilities.
Current CPUs which support PCIe Gen3 + PCIe Atomics are:
* AMD Ryzen CPUs
* The CPUs in AMD Ryzen APUs
* AMD Ryzen Threadripper CPUs
* AMD EPYC CPUs
* Intel Xeon E7 v3 or newer CPUs
* Intel Xeon E5 v3 or newer CPUs
* Intel Xeon E3 v3 or newer CPUs
* Intel Core i7 v4, Core i5 v4, Core i3 v4 or newer CPUs (i.e. Haswell family or newer)
* Some Ivy Bridge-E systems
Beginning with ROCm 1.8, GFX9 GPUs (such as Vega 10) no longer require PCIe atomics.
We have similarly opened up more options for number of PCIe lanes.
GFX9 GPUs can now be run on CPUs without PCIe atomics and on older PCIe generations, such as PCIe 2.0.
This is not supported on GPUs below GFX9, e.g. GFX8 cards in the Fiji and Polaris families.
If you are using any PCIe switches in your system, please note that PCIe Atomics are only supported on some switches, such as Broadcom PLX.
When you install your GPUs, make sure you install them in a PCIe 3.1.0 x16, x8, x4, or x1 slot attached either directly to the CPU's Root I/O controller or via a PCIe switch directly attached to the CPU's Root I/O controller.
In our experience, many issues stem from trying to use consumer motherboards which provide physical x16 connectors that are electrically connected as e.g. PCIe 2.0 x4, PCIe slots connected via the Southbridge PCIe I/O controller, or PCIe slots connected through a PCIe switch that does
not support PCIe atomics.
If you attempt to run ROCm on a system without proper PCIe atomic support, you may see an error in the kernel log (`dmesg`):
```
kfd: skipped device 1002:7300, PCI rejects atomics
python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
```
Experimental support for our Hawaii (GFX7) GPUs (Radeon R9 290, R9 390, FirePro W9100, S9150, S9170)
does not require or take advantage of PCIe Atomics. However, we still recommend that you use a CPU
from the list provided above for compatibility purposes.
## Older ROCm™ Releases
#### Not supported or limited support under ROCm
##### Limited support
* ROCm 2.9.x should support PCIe 2.0 enabled CPUs such as the AMD Opteron, Phenom, Phenom II, Athlon, Athlon X2, Athlon II and older Intel Xeon and Intel Core Architecture and Pentium CPUs. However, we have done very limited testing on these configurations, since our test farm has been catering to CPUs listed above. This is where we need community support. _If you find problems on such setups, please report these issues_.
* Thunderbolt 1, 2, and 3 enabled breakout boxes should now be able to work with ROCm. Thunderbolt 1 and 2 are PCIe 2.0 based, and thus are only supported with GPUs that do not require PCIe 3.1.0 atomics (e.g. Vega 10). However, we have done no testing on this configuration and would need community support due to limited access to this type of equipment.
* AMD "Carrizo" and "Bristol Ridge" APUs are enabled to run OpenCL, but do not yet support HIP or our libraries built on top of these compilers and runtimes.
* As of ROCm 2.1, "Carrizo" and "Bristol Ridge" require the use of upstream kernel drivers.
* In addition, various "Carrizo" and "Bristol Ridge" platforms may not work due to OEM and ODM choices when it comes to key configurations parameters such as inclusion of the required CRAT tables and IOMMU configuration parameters in the system BIOS.
* Before purchasing such a system for ROCm, please verify that the BIOS provides an option for enabling IOMMUv2 and that the system BIOS properly exposes the correct CRAT table. Inquire with your vendor about the latter.
* AMD "Raven Ridge" APUs are enabled to run OpenCL, but do not yet support HIP or our libraries built on top of these compilers and runtimes.
* As of ROCm 2.1, "Raven Ridge" requires the use of upstream kernel drivers.
* In addition, various "Raven Ridge" platforms may not work due to OEM and ODM choices when it comes to key configurations parameters such as inclusion of the required CRAT tables and IOMMU configuration parameters in the system BIOS.
* Before purchasing such a system for ROCm, please verify that the BIOS provides an option for enabling IOMMUv2 and that the system BIOS properly exposes the correct CRAT table. Inquire with your vendor about the latter.
##### Not supported
* "Tonga", "Iceland", "Vega M", and "Vega 12" GPUs are not supported in ROCm 2.9.x
* We do not support GFX8-class GPUs (Fiji, Polaris, etc.) on CPUs that do not have PCIe 3.0 with PCIe atomics.
* As such, we do not support AMD Carrizo and Kaveri APUs as hosts for such GPUs.
* Thunderbolt 1 and 2 enabled GPUs are not supported by GFX8 GPUs on ROCm. Thunderbolt 1 & 2 are based on PCIe 2.0.
#### ROCm support in upstream Linux kernels
As of ROCm 1.9.0, the ROCm user-level software is compatible with the AMD drivers in certain upstream Linux kernels.
As such, users have the option of either using the ROCK kernel driver that are part of AMD's ROCm repositories or using the upstream driver and only installing ROCm user-level utilities from AMD's ROCm repositories.
These releases of the upstream Linux kernel support the following GPUs in ROCm:
* 4.17: Fiji, Polaris 10, Polaris 11
* 4.18: Fiji, Polaris 10, Polaris 11, Vega10
* 4.20: Fiji, Polaris 10, Polaris 11, Vega10, Vega 7nm
The upstream driver may be useful for running ROCm software on systems that are not compatible with the kernel driver available in AMD's repositories.
For users that have the option of using either AMD's or the upstreamed driver, there are various tradeoffs to take into consideration:
| | Using AMD's `rock-dkms` package | Using the upstream kernel driver |
| ---- | ------------------------------------------------------------| ----- |
| Pros | More GPU features, and they are enabled earlier | Includes the latest Linux kernel features |
| | Tested by AMD on supported distributions | May work on other distributions and with custom kernels |
| | Supported GPUs enabled regardless of kernel version | |
| | Includes the latest GPU firmware | |
| Cons | May not work on all Linux distributions or versions | Features and hardware support varies depending on kernel version |
| | Not currently supported on kernels newer than 5.4 | Limits GPU's usage of system memory to 3/8 of system memory (before 5.6). For 5.6 and beyond, both DKMS and upstream kernels allow use of 15/16 of system memory. |
| | | IPC and RDMA capabilities are not yet enabled |
| | | Not tested by AMD to the same level as `rock-dkms` package |
| | | Does not include most up-to-date firmware |
## Machine Learning and High Performance Computing Software Stack for AMD GPU
For an updated version of the software stack for AMD GPU, see
https://rocmdocs.amd.com/en/latest/Installation_Guide/Installation-Guide.html#machine-learning-and-high-performance-computing-software-stack-for-amd-gpu-v3-5-0
For release information for older ROCm™ releases, refer to
[CHANGELOG](./CHANGELOG.md).

39
RELEASE.md Normal file
View File

@@ -0,0 +1,39 @@
# Release Notes
<!-- Do not edit this file! This file is autogenerated with -->
<!-- tools/autotag/tag_script.py -->
<!-- Disable lints since this is an auto-generated file. -->
<!-- markdownlint-disable blanks-around-headers -->
<!-- markdownlint-disable no-duplicate-header -->
<!-- markdownlint-disable no-blanks-blockquote -->
<!-- markdownlint-disable ul-indent -->
<!-- markdownlint-disable no-trailing-spaces -->
<!-- spellcheck-disable -->
The release notes for the ROCm platform.
-------------------
## ROCm 5.1.3
### Library Changes in ROCM 5.1.3
| Library | Version |
|---------|---------|
| hipBLAS | [0.50.0](https://github.com/ROCmSoftwarePlatform/hipBLAS/releases/tag/rocm-5.1.3) |
| hipCUB | [2.11.0](https://github.com/ROCmSoftwarePlatform/hipCUB/releases/tag/rocm-5.1.3) |
| hipFFT | [1.0.7](https://github.com/ROCmSoftwarePlatform/hipFFT/releases/tag/rocm-5.1.3) |
| hipSOLVER | [1.3.0](https://github.com/ROCmSoftwarePlatform/hipSOLVER/releases/tag/rocm-5.1.3) |
| hipSPARSE | [2.1.0](https://github.com/ROCmSoftwarePlatform/hipSPARSE/releases/tag/rocm-5.1.3) |
| rccl | [2.11.4](https://github.com/ROCmSoftwarePlatform/rccl/releases/tag/rocm-5.1.3) |
| rocALUTION | [2.0.2](https://github.com/ROCmSoftwarePlatform/rocALUTION/releases/tag/rocm-5.1.3) |
| rocBLAS | [2.43.0](https://github.com/ROCmSoftwarePlatform/rocBLAS/releases/tag/rocm-5.1.3) |
| rocFFT | [1.0.16](https://github.com/ROCmSoftwarePlatform/rocFFT/releases/tag/rocm-5.1.3) |
| rocPRIM | [2.10.13](https://github.com/ROCmSoftwarePlatform/rocPRIM/releases/tag/rocm-5.1.3) |
| rocRAND | [2.10.13](https://github.com/ROCmSoftwarePlatform/rocRAND/releases/tag/rocm-5.1.3) |
| rocSOLVER | [3.17.0](https://github.com/ROCmSoftwarePlatform/rocSOLVER/releases/tag/rocm-5.1.3) |
| rocSPARSE | [2.1.0](https://github.com/ROCmSoftwarePlatform/rocSPARSE/releases/tag/rocm-5.1.3) |
| rocThrust | [2.14.0](https://github.com/ROCmSoftwarePlatform/rocThrust/releases/tag/rocm-5.1.3) |
| Tensile | [4.32.0](https://github.com/ROCmSoftwarePlatform/Tensile/releases/tag/rocm-5.1.3) |

View File

@@ -1,27 +1,27 @@
<?xml version="1.0" encoding="UTF-8"?>
<manifest>
<remote name="roc-github"
fetch="http://github.com/RadeonOpenCompute/" />
fetch="https://github.com/RadeonOpenCompute/" />
<remote name="rocm-devtools"
fetch="https://github.com/ROCm-Developer-Tools/" />
fetch="https://github.com/ROCm-Developer-Tools/" />
<remote name="rocm-swplat"
fetch="https://github.com/ROCmSoftwarePlatform/" />
fetch="https://github.com/ROCmSoftwarePlatform/" />
<remote name="gpuopen-libs"
fetch="https://github.com/GPUOpen-ProfessionalCompute-Libraries/" />
fetch="https://github.com/GPUOpen-ProfessionalCompute-Libraries/" />
<remote name="gpuopen-tools"
fetch="https://github.com/GPUOpen-Tools/" />
fetch="https://github.com/GPUOpen-Tools/" />
<remote name="KhronosGroup"
fetch="https://github.com/KhronosGroup/" />
<default revision="refs/tags/rocm-3.7.0"
remote="roc-github"
sync-c="true"
sync-j="4" />
<!--list of projects for ROCM-->
fetch="https://github.com/KhronosGroup/" />
<default revision="refs/tags/rocm-5.5.1"
remote="roc-github"
sync-c="true"
sync-j="4" />
<!--list of projects for ROCM-->
<project name="ROCK-Kernel-Driver" />
<project name="ROCT-Thunk-Interface" />
<project name="ROCR-Runtime" />
<project name="ROC-smi" />
<project name="rocm_smi_lib" remote="roc-github" />
<project name="rocm_smi_lib" />
<project name="rocm-core" />
<project name="rocm-cmake" />
<project name="rocminfo" />
<project name="rocprofiler" remote="rocm-devtools" />
@@ -29,51 +29,51 @@
<project name="ROCm-OpenCL-Runtime" />
<project path="ROCm-OpenCL-Runtime/api/opencl/khronos/icd" name="OpenCL-ICD-Loader" remote="KhronosGroup" revision="6c03f8b58fafd9dd693eaac826749a5cfad515f8" />
<project name="clang-ocl" />
<!--HIP Projects-->
<!--HIP Projects-->
<project name="HIP" remote="rocm-devtools" />
<project name="hipamd" remote="rocm-devtools" />
<project name="HIP-Examples" remote="rocm-devtools" />
<project name="ROCclr" remote="rocm-devtools" />
<project name="HIPIFY" remote="rocm-devtools" />
<!-- The following projects are all associated with the AMDGPU LLVM compiler -->
<project name="llvm-project" path="llvm_amd-stg-open" />
<project name="HIPCC" remote="rocm-devtools" />
<!-- The following projects are all associated with the AMDGPU LLVM compiler -->
<project name="llvm-project" />
<project name="ROCm-Device-Libs" />
<project name="atmi" />
<project name="ROCm-CompilerSupport" />
<project name="rocr_debug_agent" remote="rocm-devtools" revision="refs/tags/roc-3.7.0" />
<project name="rocr_debug_agent" remote="rocm-devtools" />
<project name="rocm_bandwidth_test" />
<project name="half" remote="rocm-swplat" revision="37742ce15b76b44e4b271c1e66d13d2fa7bd003e" />
<project name="RCP" remote="gpuopen-tools" revision="3a49405a1500067c49d181844ec90aea606055bb" />
<!-- gdb projects -->
<!-- gdb projects -->
<project name="ROCgdb" remote="rocm-devtools" />
<project name="ROCdbgapi" remote="rocm-devtools" />
<!-- ROCm Libraries -->
<project name="rocBLAS" remote="rocm-swplat" />
<project name="hipBLAS" remote="rocm-swplat" />
<project name="rocFFT" remote="rocm-swplat" />
<project name="rocRAND" remote="rocm-swplat" />
<project name="rocSPARSE" remote="rocm-swplat" />
<project name="rocSOLVER" remote="rocm-swplat" />
<project name="hipSPARSE" remote="rocm-swplat" />
<project name="rocALUTION" remote="rocm-swplat" />
<!-- ROCm Libraries -->
<project name="rdc" />
<project groups="mathlibs" name="rocBLAS" remote="rocm-swplat" />
<project groups="mathlibs" name="Tensile" remote="rocm-swplat" />
<project groups="mathlibs" name="hipBLAS" remote="rocm-swplat" />
<project groups="mathlibs" name="rocFFT" remote="rocm-swplat" />
<project groups="mathlibs" name="hipFFT" remote="rocm-swplat" />
<project groups="mathlibs" name="rocRAND" remote="rocm-swplat" />
<project groups="mathlibs" name="rocSPARSE" remote="rocm-swplat" />
<project groups="mathlibs" name="rocSOLVER" remote="rocm-swplat" />
<project groups="mathlibs" name="hipSOLVER" remote="rocm-swplat" />
<project groups="mathlibs" name="hipSPARSE" remote="rocm-swplat" />
<project groups="mathlibs" name="rocALUTION" remote="rocm-swplat" />
<project name="MIOpenGEMM" remote="rocm-swplat" />
<project name="MIOpen" remote="rocm-swplat" />
<project name="rccl" remote="rocm-swplat" />
<project groups="mathlibs" name="rccl" remote="rocm-swplat" />
<project name="MIVisionX" remote="gpuopen-libs" />
<project name="rocThrust" remote="rocm-swplat" />
<project name="hipCUB" remote="rocm-swplat" />
<project name="rocPRIM" remote="rocm-swplat" />
<project name="AMDMIGraphX" remote="rocm-swplat" revision="e66968a25f9342a28af1157b06cbdbf8579c5519" />
<project groups="mathlibs" name="rocThrust" remote="rocm-swplat" />
<project groups="mathlibs" name="hipCUB" remote="rocm-swplat" />
<project groups="mathlibs" name="rocPRIM" remote="rocm-swplat" />
<project groups="mathlibs" name="rocWMMA" remote="rocm-swplat" />
<project name="hipfort" remote="rocm-swplat" />
<project name="AMDMIGraphX" remote="rocm-swplat" />
<project name="ROCmValidationSuite" remote="rocm-devtools" />
<!-- Projects for AOMP -->
<project name="ROCT-Thunk-Interface" path="aomp/roct-thunk-interface" remote="roc-github" />
<project name="ROCR-Runtime" path="aomp/rocr-runtime" remote="roc-github" />
<project name="ROCm-Device-Libs" path="aomp/rocm-device-libs" remote="roc-github" />
<project name="ROCm-CompilerSupport" path="aomp/rocm-compilersupport" remote="roc-github" />
<project name="rocminfo" path="aomp/rocminfo" remote="roc-github" />
<project name="HIP" path="aomp/hip-on-vdi" remote="rocm-devtools" />
<project name="aomp" path="aomp/aomp" remote="rocm-devtools" />
<project name="aomp-extras" path="aomp/aomp-extras" remote="rocm-devtools" />
<project name="flang" path="aomp/flang" remote="rocm-devtools" />
<project name="amd-llvm-project" path="aomp/amd-llvm-project" remote="rocm-devtools" />
<project name="ROCclr" path="aomp/vdi" remote="rocm-devtools" />
<project name="ROCm-OpenCL-Runtime" path="aomp/opencl-on-vdi" remote="roc-github" />
<!-- Projects for OpenMP-Extras -->
<project name="aomp" path="openmp-extras/aomp" remote="rocm-devtools" />
<project name="aomp-extras" path="openmp-extras/aomp-extras" remote="rocm-devtools" />
<project name="flang" path="openmp-extras/flang" remote="rocm-devtools" />
</manifest>

6
docs/404.md Normal file
View File

@@ -0,0 +1,6 @@
# 404 Page Not Found
Page could not be found.
Return to [home](./index) or please use the links from the sidebar to find what
you are looking for.

74
docs/about.md Normal file
View File

@@ -0,0 +1,74 @@
# About ROCm Documentation
ROCm documentation is made available under open source [licenses](licensing.md).
Documentation is built using open source toolchains. Contributions to our
documentation is encouraged and welcome. As a contributor, please familiarize
yourself with our documentation toolchain.
## ReadTheDocs
[ReadTheDocs](https://docs.readthedocs.io/en/stable/) is our front end for the
our documentation. By front end, this is the tool that serves our HTML based
documentation to our end users.
## Doxygen
[Doxygen](https://www.doxygen.nl/) is the most common inline code documentation
standard. ROCm projects are use Doxygen for public API documentation (unless the
upstream project is using a different tool).
## Sphinx
[Sphinx](https://www.sphinx-doc.org/en/master/) is a documentation generator
originally used for python. It is now widely used in the Open Source community.
Originally, sphinx supported RST based documentation. Markdown support is now
available. ROCm documentation plans to default to markdown for new projects.
Existing projects using RST are under no obligation to convert to markdown. New
projects that believe markdown is not suitable should contact the documentation
team prior to selecting RST.
### MyST
[Markedly Structured Text (MyST)](https://myst-tools.org/docs/spec) is an extended
flavor of Markdown ([CommonMark](https://commonmark.org/)) influenced by reStructuredText (RST) and Sphinx.
It is integrated via [`myst-parser`](https://myst-parser.readthedocs.io/en/latest/).
A cheat sheet that showcases how to use the MyST syntax is available over at [the Jupyter
reference](https://jupyterbook.org/en/stable/reference/cheatsheet.html).
### Sphinx Theme
ROCm is using the
[Sphinx Book Theme](https://sphinx-book-theme.readthedocs.io/en/latest/). This
theme is used by Jupyter books. ROCm documentation applies some customization
include a header and footer on top of the Sphinx Book Theme. A future custom
ROCm theme will be part of our documentation goals.
### Sphinx Design
Sphinx Design is an extension for sphinx based websites that add design
functionality. Please see the documentation
[here](https://sphinx-design.readthedocs.io/en/latest/index.html). ROCm
documentation uses sphinx design for grids, cards, and synchronized tabs.
Other features may be used in the future.
### Sphinx External TOC
ROCm uses the
[sphinx-external-toc](https://sphinx-external-toc.readthedocs.io/en/latest/intro.html)
for our navigation. This tool allows a YAML file based left navigation menu. This
tool was selected due to its flexibility that allows scripts to operate on the
YAML file. Please transition to this file for the project's navigation. You can
see the `_toc.yml.in` file in this repository in the docs/sphinx folder for an
example.
### Breathe
Sphinx uses [Breathe](https://www.breathe-doc.org/) to integrate Doxygen
content.
## `rocm-docs-core` pip package
[rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) is an AMD
maintained project that applies customization for our documentation. This
project is the tool most ROCm repositories will use as part of the documentation
build.

76
docs/conf.py Normal file
View File

@@ -0,0 +1,76 @@
# 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 shutil
from rocm_docs import ROCmDocs
shutil.copy2('../CONTRIBUTING.md','./contributing.md')
shutil.copy2('../RELEASE.md','./release.md')
# Keep capitalization due to similar linking on GitHub's markdown preview.
shutil.copy2('../CHANGELOG.md','./CHANGELOG.md')
# configurations for PDF output by Read the Docs
project = "ROCm Documentation"
author = "Advanced Micro Devices, Inc."
copyright = "Copyright (c) 2023 Advanced Micro Devices, Inc. All rights reserved."
version = "5.1.3"
release = "5.1.3"
setting_all_article_info = True
all_article_info_os = ["linux"]
all_article_info_author = ""
# pages with specific settings
article_pages = [
{"file":"deploy/linux/index", "os":["linux"]},
{"file":"deploy/linux/install_overview", "os":["linux"]},
{"file":"deploy/linux/prerequisites", "os":["linux"]},
{"file":"deploy/linux/quick_start", "os":["linux"]},
{"file":"deploy/linux/install", "os":["linux"]},
{"file":"deploy/linux/upgrade", "os":["linux"]},
{"file":"deploy/linux/uninstall", "os":["linux"]},
{"file":"deploy/linux/package_manager_integration", "os":["linux"]},
{"file":"deploy/docker", "os":["linux"]},
{"file":"release/gpu_os_support", "os":["linux"]},
{"file":"release/docker_support_matrix", "os":["linux"]},
{"file":"reference/gpu_libraries/communication", "os":["linux"]},
{"file":"reference/ai_tools", "os":["linux"]},
{"file":"reference/management_tools", "os":["linux"]},
{"file":"reference/validation_tools", "os":["linux"]},
{"file":"reference/framework_compatibility/framework_compatibility", "os":["linux"]},
{"file":"reference/computer_vision", "os":["linux"]},
{"file":"how_to/deep_learning_rocm", "os":["linux"]},
{"file":"how_to/gpu_aware_mpi", "os":["linux"]},
{"file":"how_to/magma_install/magma_install", "os":["linux"]},
{"file":"how_to/pytorch_install/pytorch_install", "os":["linux"]},
{"file":"how_to/system_debugging", "os":["linux"]},
{"file":"how_to/tensorflow_install/tensorflow_install", "os":["linux"]},
{"file":"examples/machine_learning", "os":["linux"]},
{"file":"examples/inception_casestudy/inception_casestudy", "os":["linux"]},
{"file":"understand/file_reorg", "os":["linux"]},
{"file":"understand/isv_deployment_win", "os":["windows"]},
]
external_toc_path = "./sphinx/_toc.yml"
docs_core = ROCmDocs("ROCm 5.1.3 Documentation Home")
docs_core.setup()
external_projects_current_project = "rocm"
for sphinx_var in ROCmDocs.SPHINX_VARS:
globals()[sphinx_var] = getattr(docs_core, sphinx_var)
html_theme_options = {
"link_main_doc": False
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 939 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 537 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 292 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 163 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 183 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 407 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 465 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 207 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 461 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 461 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 412 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB

View File

@@ -0,0 +1 @@

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 88 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 99 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 130 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 144 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 57 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 102 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 114 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 103 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 59 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 64 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 91 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 88 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 66 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 87 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 66 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 87 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 64 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 69 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.8 KiB

90
docs/deploy/docker.md Normal file
View File

@@ -0,0 +1,90 @@
# Deploy ROCm Docker containers
## Prerequisites
Docker containers share the kernel with the host operating system, therefore the
ROCm kernel-mode driver must be installed on the host. Please refer to
{ref}`using-the-package-manager` on installing `amdgpu-dkms`. The other
user-space parts (like the HIP-runtime or math libraries) of the ROCm stack will
be loaded from the container image and don't need to be installed to the host.
(docker-access-gpus-in-container)=
## Accessing GPUs in containers
In order to access GPUs in a container (to run applications using HIP, OpenCL or
OpenMP offloading) explicit access to the GPUs must be granted.
The ROCm runtimes make use of multiple device files:
- `/dev/kfd`: the main compute interface shared by all GPUs
- `/dev/dri/renderD<node>`: direct rendering interface (DRI) devices for each
GPU. **`<node>`** is a number for each card in the system starting from 128.
Exposing these devices to a container is done by using the
[`--device`](https://docs.docker.com/engine/reference/commandline/run/#device)
option, i.e. to allow access to all GPUs expose `/dev/kfd` and all
`/dev/dri/renderD` devices:
```shell
docker run --device /dev/kfd --device /dev/renderD128 --device /dev/renderD129 ...
```
More conveniently, instead of listing all devices, the entire `/dev/dri` folder
can be exposed to the new container:
```shell
docker run --device /dev/kfd --device /dev/dri
```
Note that this gives more access than strictly required, as it also exposes the
other device files found in that folder to the container.
(docker-restrict-gpus)=
### Restricting a container to a subset of the GPUs
If a `/dev/dri/renderD` device is not exposed to a container then it cannot use
the GPU associated with it; this allows to restrict a container to any subset of
devices.
For example to allow the container to access the first and third GPU start it
like:
```shell
docker run --device /dev/kfd --device /dev/dri/renderD128 --device /dev/dri/renderD130 <image>
```
### Additional Options
The performance of an application can vary depending on the assignment of GPUs
and CPUs to the task. Typically, `numactl` is installed as part of many HPC
applications to provide GPU/CPU mappings. This Docker runtime option supports
memory mapping and can improve performance.
```shell
--security-opt seccomp=unconfined
```
This option is recommended for Docker Containers running HPC applications.
```shell
docker run --device /dev/kfd --device /dev/dri --security-opt seccomp=unconfined ...
```
## Docker images in the ROCm ecosystem
### Base images
<https://github.com/RadeonOpenCompute/ROCm-docker> hosts images useful for users
wishing to build their own containers leveraging ROCm. The built images are
available from [Docker Hub](https://hub.docker.com/u/rocm). In particular
`rocm/rocm-terminal` is a small image with the prerequisites to build HIP
applications, but does not include any libraries.
### Applications
AMD provides pre-built images for various GPU-ready applications through its
Infinity Hub at <https://www.amd.com/en/technologies/infinity-hub>.
Examples for invoking each application and suggested parameters used for
benchmarking are also provided there.

View File

@@ -0,0 +1,53 @@
# Deploy ROCm on Linux
Start with {doc}`/deploy/linux/quick_start` or follow the detailed
instructions below.
## Prepare to Install
::::{grid} 1 1 2 2
:gutter: 1
:::{grid-item-card} Prerequisites
:link: prerequisites
:link-type: doc
The prerequisites page lists the required steps *before* installation.
:::
:::{grid-item-card} Install Choices
:link: install_overview
:link-type: doc
Package manager vs AMDGPU Installer
Standard Packages vs Multi-Version Packages
:::
::::
## Choose your install method
::::{grid} 1 1 2 2
:gutter: 1
:::{grid-item-card} Package Manager
:link: os-native/index
:link-type: doc
Directly use your distribution's package manager to install ROCm.
:::
:::{grid-item-card} AMDGPU Installer
:link: installer/index
:link-type: doc
Use an installer tool that orchestrates changes via the package
manager.
:::
::::
## See Also
- {doc}`/release/gpu_os_support`

View File

@@ -0,0 +1,71 @@
# ROCm Installation Options (Linux)
Users installing ROCm must choose between various installation options. A new
user should follow the [Quick Start guide](./quick_start).
## Package Manager versus AMDGPU Installer?
ROCm supports two methods for installation:
- Directly using the Linux distribution's package manager
- The `amdgpu-install` script
There is no difference in the final installation state when choosing either
option.
Using the distribution's package manager lets the user install,
upgrade and uninstall using familiar commands and workflows. Third party
ecosystem support is the same as your OS package manager.
The `amdgpu-install` script is a wrapper around the package manager. The same
packages are installed by this script as the package manager system.
The installer automates the installation process for the AMDGPU
and ROCm stack. It handles the complete installation process
for ROCm, including setting up the repository, cleaning the system, updating,
and installing the desired drivers and meta-packages. Users who are
less familiar with the package manager can choose this method for ROCm
installation.
(installation-types)=
## Single Version ROCm install versus Multi-Version
ROCm packages are versioned with both semantic versioning that is package
specific and a ROCm release version.
### Single-version Installation
The single-version ROCm installation refers to the following:
- Installation of a single instance of the ROCm release on a system
- Use of non-versioned ROCm meta-packages
### Multi-version Installation
The multi-version installation refers to the following:
- Installation of multiple instances of the ROCm stack on a system. Extending
the package name and its dependencies with the release version adds the
ability to support multiple versions of packages simultaneously.
- Use of versioned ROCm meta-packages.
```{attention}
ROCm packages that were previously installed from a single-version installation
must be removed before proceeding with the multi-version installation to avoid
conflicts.
```
```{note}
Multiversion install is not available for the kernel driver module, also referred to as AMDGPU.
```
The following image demonstrates the difference between single-version and
multi-version ROCm installation types:
```{figure-md} install-types
<img src="/data/deploy/linux/image.001.png" alt="">
ROCm Installation Types
```

View File

@@ -0,0 +1,31 @@
# AMDGPU Install Script
::::{grid} 2 3 3 3
:gutter: 1
:::{grid-item-card} Install
:link: install
:link-type: doc
How to install ROCm?
:::
:::{grid-item-card} Upgrade
:link: upgrade
:link-type: doc
Instructions for upgrading an existing ROCm installation.
:::
:::{grid-item-card} Uninstall
:link: uninstall
:link-type: doc
Steps for removing ROCm packages libraries and tools.
:::
::::
## See Also
- {doc}`/release/gpu_os_support`

View File

@@ -0,0 +1,299 @@
# Installation with install script
Prior to beginning, please ensure you have the [prerequisites](../prerequisites)
installed.
## Download the Installer Script
To download and install the `amdgpu-install` script on the system, use the
following commands based on your distribution.
::::::{tab-set}
:::::{tab-item} Ubuntu
:sync: ubuntu
::::{tab-set}
:::{tab-item} Ubuntu 18.04
:sync: ubuntu-18.04
```shell
sudo apt update
wget https://repo.radeon.com/amdgpu-install/22.10.3/ubuntu/bionic/amdgpu-install_22.10.3.50103-1_all.deb
sudo apt install ./amdgpu-install_22.10.3.50103-1_all.deb
```
:::
:::{tab-item} Ubuntu 20.04
:sync: ubuntu-20.04
```shell
sudo apt update
wget https://repo.radeon.com/amdgpu-install/22.10.3/ubuntu/focal/amdgpu-install_22.10.3.50103-1_all.deb
sudo apt install ./amdgpu-install_22.10.3.50103-1_all.deb
```
:::
::::
:::::
:::::{tab-item} Red Hat Enterprise Linux
:sync: RHEL
::::{tab-set}
:::{tab-item} RHEL 7.9
:sync: RHEL-7.9
:sync: RHEL-7
```shell
sudo yum install https://repo.radeon.com/amdgpu-install/22.10.3/rhel/7.9/amdgpu-install-22.10.3.50103-1.el7.noarch.rpm
```
:::
:::{tab-item} RHEL 8.4
:sync: RHEL-8.4
:sync: RHEL-8
```shell
sudo yum install https://repo.radeon.com/amdgpu-install/22.10.3/rhel/8.4/amdgpu-install-22.10.3.50103-1.el8.noarch.rpm
```
:::
:::{tab-item} RHEL 8.5
:sync: RHEL-8.5
:sync: RHEL-8
```shell
sudo yum install https://repo.radeon.com/amdgpu-install/22.10.3/rhel/8.5/amdgpu-install-22.10.3.50103-1.el8.noarch.rpm
```
:::
::::
:::::
:::::{tab-item} SUSE Linux Enterprise Server 15
:sync: SLES15
::::{tab-set}
:::{tab-item} Service Pack 4
:sync: SLES15-SP4
```shell
sudo zypper --no-gpg-checks install https://repo.radeon.com/amdgpu-install/22.10.3/sle/15/amdgpu-install-22.10.3.50103-1.noarch.rpm
```
:::
::::
:::::
::::::
## Use cases
Instead of installing individual applications or libraries the installer script
groups packages into specific use cases, matching typical workflows and runtimes.
To display a list of available use cases execute the command:
```shell
sudo amdgpu-install --list-usecase
```
The available use-cases will be printed in a format similar to the example
output below.
```none
If --usecase option is not present, the default selection is "graphics,opencl,hip"
Available use cases:
rocm(for users and developers requiring full ROCm stack)
- OpenCL (ROCr/KFD based) runtime
- HIP runtimes
- Machine learning framework
- All ROCm libraries and applications
- ROCm Compiler and device libraries
- ROCr runtime and thunk
lrt(for users of applications requiring ROCm runtime)
- ROCm Compiler and device libraries
- ROCr runtime and thunk
opencl(for users of applications requiring OpenCL on Vega or
later products)
- ROCr based OpenCL
- ROCm Language runtime
openclsdk (for application developers requiring ROCr based OpenCL)
- ROCr based OpenCL
- ROCm Language runtime
- development and SDK files for ROCr based OpenCL
hip(for users of HIP runtime on AMD products)
- HIP runtimes
hiplibsdk (for application developers requiring HIP on AMD products)
- HIP runtimes
- ROCm math libraries
- HIP development libraries
```
To install use cases specific to your requirements, use the installer
`amdgpu-install` as follows:
- To install a single use case add it with the `--usecase` option:
```shell
sudo amdgpu-install --usecase=rocm
```
- For multiple use cases separate them with commas:
```shell
sudo amdgpu-install --usecase=hiplibsdk,rocm
```
## Single-version ROCm Installation
By default (without the `--rocmrelease` option)
the installer script will install packages in the single-version layout.
## Multi-version ROCm Installation
For the multi-version ROCm installation you must use the installer script from
the latest release of ROCm that you wish to install.
**Example:** If you want to install ROCm releases 5.0.2 and 5.1.3
simultaneously, you are required to download the installer from the latest ROCm
release v5.1.3.
### Add Required Repositories
You must add the ROCm repositories manually for all ROCm releases
you want to install except the latest one. The `amdgpu-install` script
automatically adds the required repositories for the latest release.
Run the following commands based on your distribution to add the repositories:
::::::{tab-set}
:::::{tab-item} Ubuntu
:sync: ubuntu
::::{tab-set}
:::{tab-item} Ubuntu 18.04
:sync: ubuntu-18.04
```shell
for ver in 5.0.2 5.1.3; do
echo "deb [arch=amd64 signed-by=/etc/apt/trusted.gpg.d/rocm-keyring.gpg] https://repo.radeon.com/rocm/apt/$ver bionic main" | sudo tee /etc/apt/sources.list.d/rocm.list
done
echo -e 'Package: *\nPin: release o=repo.radeon.com\nPin-Priority: 600' | sudo tee /etc/apt/preferences.d/rocm-pin-600
sudo apt update
```
:::
:::{tab-item} Ubuntu 20.04
:sync: ubuntu-20.04
```shell
for ver in 5.0.2 5.1.3; do
echo "deb [arch=amd64 signed-by=/etc/apt/trusted.gpg.d/rocm-keyring.gpg] https://repo.radeon.com/rocm/apt/$ver focal main" | sudo tee /etc/apt/sources.list.d/rocm.list
done
echo -e 'Package: *\nPin: release o=repo.radeon.com\nPin-Priority: 600' | sudo tee /etc/apt/preferences.d/rocm-pin-600
sudo apt update
```
:::
::::
:::::
:::::{tab-item} Red Hat Enterprise Linux
:sync: RHEL
::::{tab-set}
:::{tab-item} RHEL 7
:sync: RHEL-7
```shell
for ver in 5.0.2 5.1.3; do
sudo tee --append /etc/yum.repos.d/rocm.repo <<EOF
[ROCm-$ver]
name=ROCm$ver
baseurl=https://repo.radeon.com/rocm/yum/$ver/main
enabled=1
priority=50
gpgcheck=1
gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
EOF
done
sudo yum clean all
```
:::
:::{tab-item} RHEL 8
:sync: RHEL-8
```shell
for ver in 5.0.2 5.1.3; do
sudo tee --append /etc/yum.repos.d/rocm.repo <<EOF
[ROCm-$ver]
name=ROCm$ver
baseurl=https://repo.radeon.com/rocm/yum/$ver/main
enabled=1
priority=50
gpgcheck=1
gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
EOF
done
sudo yum clean all
```
:::
::::
:::::
:::::{tab-item} SUSE Linux Enterprise Server 15
:sync: SLES15
```shell
for ver in 5.0.2 5.1.3; do
sudo tee --append /etc/zypp/repos.d/rocm.repo <<EOF
name=rocm
baseurl=https://repo.radeon.com/rocm/zyp/$ver/main
enabled=1
gpgcheck=1
gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
EOF
done
sudo zypper ref
```
:::::
::::::
### Install packages
Use the installer script as given below:
```none
sudo amdgpu-install --usecase=rocm --rocmrelease=<release-number-1>
sudo amdgpu-install --usecase=rocm --rocmrelease=<release-number-2>
sudo amdgpu-install --usecase=rocm --rocmrelease=<release-number-3>
```
Following are examples of ROCm multi-version installation. The kernel-mode
driver, associated with the ROCm release v5.1.3, will be installed as its latest
release in the list.
```none
sudo amdgpu-install --usecase=rocm --rocmrelease=5.0.2
sudo amdgpu-install --usecase=rocm --rocmrelease=5.1.3
```
## Additional options
### Unattended installation
Adding `-y` as a parameter to `amdgpu-install` skips user prompts (for
automation). Example: `amdgpu-install -y --usecase=rocm`
### Skipping kernel mode driver installation
The installer script tries to install the kernel mode driver along with the
requested use cases. This might be unnecessary as in the case of docker
containers or you may wish to keep a specific version when using multi-version
installation, and not have the last installed version overwrite the kernel mode
driver.
To skip the installation of the kernel-mode driver add the `--no-dkms` option
when calling the installer script.

View File

@@ -0,0 +1,25 @@
# Installer Script Uninstallation (Linux)
To uninstall all ROCm packages and the kernel-mode driver the following commands
can be used.
::::{rubric} Uninstalling Single-Version Install
::::
```console shell
sudo amdgpu-install --uninstall
```
::::{rubric} Uninstalling a Specific ROCm Release
::::
```console shell
sudo amdgpu-install --uninstall --rocmrelease=<release-number>
```
::::{rubric} Uninstalling all ROCm Releases
::::
```console shell
sudo amdgpu-install --uninstall --rocmrelease=all
```

View File

@@ -0,0 +1,5 @@
# Upgrading with the Installer Script (Linux)
The upgrade procedure with the installer script is exactly the same as
installing for 1st time use. Refer to the {doc}`install`
section on the exact procedure to follow.

Some files were not shown because too many files have changed in this diff Show More