Commit Graph

136 Commits

Author SHA1 Message Date
Saad Rahim
bdb527980a Fixing typo on GPU support tables for Radeon 2023-06-29 13:14:14 -06:00
Sam Wu
72c128f681 update project names for intersphinx 2023-06-29 11:30:50 -06:00
Sam Wu
da32369db1 config for pdf 2023-06-29 11:24:09 -06:00
Sam Wu
e70545bcd9 update release notes date 2023-06-29 11:21:30 -06:00
Saad Rahim
4df2273587 Table fix (#2296)
* Table fix

* Supported and unsupported tab fix
2023-06-28 16:47:18 -06:00
Saad Rahim
996f4a8c37 Compatibility Section for ROCm 5.6 (#2294)
* Update 3rd party compat for 5.6

* Update supported OS for 5.6

* Validated kernels

* linting

* missed GPU

* Update .wordlist.txt

---------

Co-authored-by: Máté Ferenc Nagy-Egri <mate@streamhpc.com>
2023-06-28 16:34:08 -06:00
Sam Wu
5bbe13fb75 Cherry pick changes from develop to 5.6 (#2295)
* Update Links (#2240)

* update link to PCIe Gen 4 pdf

* fix broken links

* remove references to broken links

* fix spelling of data center

* Fixing HIP link (#2236)

* Swati develop (#2245)

* Added deleted sections to openmp.md and other improvements

* Update openmp.md

Tagged `ICV`

* Solving indiscrepencies in openmp.md

There are apparently differences in the published document and information conveyed by the Dev. Fixed it.

* add new words to wordlist

---------

Co-authored-by: Sam Wu <sam.wu2@amd.com>

* fix rocm_smi_lib link in toc (#2260)

* ROCm FHS Reorganization, Backward Compatibility, and Versioning - rev (#2255)

* update requirements

---------

Co-authored-by: Saad Rahim <44449863+saadrahim@users.noreply.github.com>
Co-authored-by: srawat <120587655+SwRaw@users.noreply.github.com>
Co-authored-by: Ehud Sharlin <112672820+Ehud-Sharlin@users.noreply.github.com>
2023-06-28 16:30:19 -06:00
Mészáros Gergely
8bf7cfdddc Add documentation on 5.6 support SLES 15.5 (#2271)
* docs: clean up SLES tab-sets

- Always use a tab-set for SLES 15.4
- In the toplevel SLES title don't say version 15
- harmonize the `:sync:` labels between documents

* docs: Misc fixes in installation

- Fix rocm repository url in the installer script installation for SLES
- Add a missing :sync: tab in installation prerequisites

* docs: add SLES 15.5 support to installation and OS support pages
2023-06-26 15:29:55 -06:00
Saad Rahim
e05ce21fb4 MIOpen kdb installation instructions for PyTorch warmup performance improvement (#2248) 2023-06-22 09:47:38 -06:00
Nara
c1a8c5b030 docs(deploy/linux): update install instructions to 5.6 (#2244) 2023-06-16 07:27:00 -06:00
Mészáros Gergely
014c904c4c Add RHEL 8.8 and 9.2 as supported distributions for 5.6 (#2242)
- add them to the os support table
- add install instructions for them
2023-06-14 07:07:50 -06:00
Alfin Auzikri
51af0be780 Update tensorflow_install.md (#2237)
* Update tensorflow_install.md

Fixed writing commands so that when executed by copy paste it doesn't cause an error.

* Update tensorflow_install.md

Following @saadrahim's suggestion of using "\" to signify a line break in bash.
2023-06-12 09:29:44 -06:00
Nagy-Egri Máté Ferenc
5e24832f3b Remove package pin from quick start quide (#2233)
* Remove package pin from quick start quide

When installing a single-package fashion, no version pinning is needed

* Add package pinning to quick start guide

Pinning the packages is required to make apt prefer the rocm packages
instead of the system ones when both provide the same package (e.g
`rocm-smi`).

* Removing Ubuntu 20.04 change

---------

Co-authored-by: Gergely Meszaros <gergely@streamhpc.com>
Co-authored-by: Saad Rahim <44449863+saadrahim@users.noreply.github.com>
2023-06-09 13:56:23 -06:00
srawat
6757f9dc56 Added specialized kernels to openmp.md (#2187)
* Added specialized kernels to openmp.md

A few formatting changes and addition of specialized kernels section at the end.

* Added Specialized kernels in openmp.md

Some formatting changes and addition of specialized kernels instead of no loop and cross team kernels

* Added specialized kernel to openmp.md

* Added specialized kernels to openmp.md

* Replaced the usage of uncertain clauses(may/might) in  openmp.md

* Attempt to align the table headings for environment variables in openmp.md

* Feedback from Dhruva

---------

Co-authored-by: Saad Rahim <44449863+saadrahim@users.noreply.github.com>
2023-06-08 10:00:51 -06: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
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
f4a481e58b URL change and nav cleanup 2023-05-18 14:42:03 -06:00