Commit Graph

456 Commits

Author SHA1 Message Date
Peter Park
61d18252ab Remove unused images and add link to usage in Deep Learning install guide (#3196) 2024-05-30 19:28:13 -04:00
Peter Park
6a5defb825 Add "How to use ROCm for AI" (#3117)
* Add Using ROCm for AI:wq

Add PyTorch Docker installation images

Split doc into subtopics

Add metadata

Clean up index

Clean up hugging face guide

Clean up installation guide

Fix rST formatting

Clean up install and train-a-model

Clean up MAD

Delete unused file

Add ref anchors and clean up MAD doc

Add formatting fixes

Update toc and section index

Format some code blocks

Remove install guide and update toc

Chop installation guide

Clean up deployment and hugging face sections

Change headings to end in -ing

Fix spelling in Training a model

Delete MAD and split out install content

Fix formatting

Change words to satisfy spellcheck linter

* Add review suggestions and add helpful links

Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>

Add helpful links and add review suggestions

Remove fine-tuning link and links to D5 and MAGMA

Update docs/how-to/rocm-for-ai/deploy-your-model.rst

Co-authored-by: Young Hui - AMD <145490163+yhuiYH@users.noreply.github.com>

Update DeepSpeed link

Add subheading to ML framework installation and closing blurb to hugging face models guide

* Reorder topics
2024-05-30 16:17:44 -04:00
randyh62
6864f1546e hipcc doc link (#3190)
* hipcc doc link

* Update docs/what-is-rocm.rst

Co-authored-by: Istvan Kiss <neon60@gmail.com>

* Update docs/what-is-rocm.rst

Co-authored-by: Istvan Kiss <neon60@gmail.com>

---------

Co-authored-by: Istvan Kiss <neon60@gmail.com>
2024-05-30 12:52:58 -07:00
Sam Wu
5930282993 docs(conf.py): Update PDF version to 6.1.1 (#3184) 2024-05-29 15:11:19 -04:00
Peter Park
3a68f43df7 Reorg 'Deep learning' and 'Tuning guides' docs (#3153)
* Rename 'Tuning guides' to 'Hardware optimization'

* Move deep learning to Install section

* Change 'Hardware' to 'System' to align with index.md

* Satisfy spellcheck linter

* adding new framework install graphic with JAX

* Fix link to ROCm libraries list

* crop framework_install graphic

* Reset .wordlist.txt update

* Prettify deep learning framework installation page

* Change spacing in list of frameworks

---------

Co-authored-by: Young Hui <young.hui@amd.com>
2024-05-29 14:12:43 -04:00
Bence Parajdi
97129c0972 Merge pull request #3062 from StreamHPC/cu
add cu setting page
2024-05-29 09:46:20 +02:00
Bence Parajdi
0ba6bb43ef fix bad file extention referencing setting-cus.rst in index.md 2024-05-28 12:27:02 +02:00
MKKnorr
f4a688e0a5 Re-add glossary to hardware specification table (#3073)
* Re-add glossary to hardware specification table

* PR findings

* PR findings

PR findings

* Update docs/reference/gpu-arch-specs.rst

Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>

* Update docs/reference/gpu-arch-specs.rst

Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>

* Update docs/reference/gpu-arch-specs.rst

Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>

* Update docs/reference/gpu-arch-specs.rst

Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>

* PR findings

---------

Co-authored-by: Istvan Kiss <neon60@gmail.com>
Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>
2024-05-27 13:31:25 -04:00
Peter Park
48bd77a816 Change ROCR-Runtime to relative link (#3143) 2024-05-21 16:19:26 -04:00
Peter Park
c12703cfbb Update What is ROCm?: remove RCP from components and change repo links to ROCm docs (#3129)
* Remove Radeon Compute Profiler from list of components

* Update ROCm CMake and ROCr links
2024-05-14 15:11:57 -04:00
Bence Parajdi
d86c23a847 remove unnecessary comma 2024-05-14 10:08:44 +02:00
Bence Parajdi
06c960aa97 Update docs/conceptual/setting-cus.rst
Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>
2024-05-13 16:27:05 +02:00
Bence Parajdi
3edc3e9759 add new page to index.md 2024-05-13 16:27:04 +02:00
Bence Parajdi
41da494ef0 fix review comments 2024-05-13 16:26:16 +02:00
Bence Parajdi
c0fbd1ca5b fix typos 2024-05-13 16:25:33 +02:00
Bence Parajdi
7f38465770 add cu setting page 2024-05-13 16:25:31 +02:00
randyh62
7ebd810f7a updates for SWDEV-459863 (#3113) 2024-05-09 12:42:48 -07:00
Sam Wu
f982da3add Add 6.1.1 to version list (#3107) 2024-05-09 12:49:39 -04:00
Sam Wu
3ab619ffc4 Add more explanation about doc requirements (#3108)
* Add more explanation about doc requirements

* Fix spelling
2024-05-09 10:22:52 -06:00
Sam Wu
06660690d1 Merge branch 'roc-6.1.x' into develop 2024-05-08 15:25:38 -06:00
Sam Wu
f5f2a1f561 Sync develop branch 2024-05-08 15:09:31 -06:00
dependabot[bot]
ef4c05d0b7 Bump rocm-docs-core from 1.1.0 to 1.1.1 in /docs/sphinx
Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 1.1.0 to 1.1.1.
- [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases)
- [Changelog](https://github.com/ROCm/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v1.1.0...v1.1.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>
2024-05-08 15:07:02 -06:00
Peter Jun Park
a5a1e39e61 Fix changelog and release notes
Add \n to top of 6.0.2 template

Update RELEASE.md and 6.1.1.md

Regenerate changelog

Add minor wording changes in RELEASE.md

Incorporate Leo's feedback

Reformat RELEASE.md to fix build issue

Fixes an issue preventing Changelog from appearing in the TOC.

Update AMDSMI link & change 'release highlights' to 'release notes'

Change AMD SMI link from develop to docs/6.1.1
2024-05-08 15:07:00 -06:00
Young Hui - AMD
78bb4a464e Compatibility Matrix - include AMDSMI (#3090) 2024-05-06 19:01:30 -04:00
dependabot[bot]
a02a4df775 Bump jinja2 from 3.1.3 to 3.1.4 in /docs/sphinx (#3089)
Bumps [jinja2](https://github.com/pallets/jinja) from 3.1.3 to 3.1.4.
- [Release notes](https://github.com/pallets/jinja/releases)
- [Changelog](https://github.com/pallets/jinja/blob/main/CHANGES.rst)
- [Commits](https://github.com/pallets/jinja/compare/3.1.3...3.1.4)

---
updated-dependencies:
- dependency-name: jinja2
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-05-06 15:36:09 -06:00
Young Hui - AMD
fb9ea7397f update OS strings to be more readable and searchable (#3088) 2024-05-06 15:07:53 -04:00
Young Hui - AMD
40615d2950 Add compatibility matrix (#3082)
* add compatibility matrix and custom css

* fix toc

* reorder some components in matrix, add missing tools to reference page

* Update docs/compatibility/compatibility-matrix.rst

Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>

---------

Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>
2024-05-06 11:20:35 -04:00
peter
d000ce56e6 Fix broken link on hardware specs page (#3075)
* Fix broken link

Fix broken link on hardware specs page to HIP programming model due to
refactoring of HIP docs.

* Update link anchor
2024-05-01 16:41:59 -04:00
dependabot[bot]
c42a12a0d5 Bump rocm-docs-core from 1.1.0 to 1.1.1 in /docs/sphinx (#3070)
Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 1.1.0 to 1.1.1.
- [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases)
- [Changelog](https://github.com/ROCm/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v1.1.0...v1.1.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>
2024-04-26 17:03:22 -06:00
dependabot[bot]
5f0579a1a0 Bump urllib3 from 1.26.13 to 1.26.18 in /docs/sphinx (#3068)
Bumps [urllib3](https://github.com/urllib3/urllib3) from 1.26.13 to 1.26.18.
- [Release notes](https://github.com/urllib3/urllib3/releases)
- [Changelog](https://github.com/urllib3/urllib3/blob/main/CHANGES.rst)
- [Commits](https://github.com/urllib3/urllib3/compare/1.26.13...1.26.18)

---
updated-dependencies:
- dependency-name: urllib3
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-04-26 14:53:56 -06:00
dependabot[bot]
f33a46d921 Bump rocm-docs-core from 1.0.0 to 1.1.0 in /docs/sphinx
Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 1.0.0 to 1.1.0.
- [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases)
- [Changelog](https://github.com/ROCm/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v1.0.0...v1.1.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>
2024-04-25 08:42:25 -06:00
dependabot[bot]
226db1f19c Bump rocm-docs-core from 1.0.0 to 1.1.0 in /docs/sphinx (#3063)
Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 1.0.0 to 1.1.0.
- [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases)
- [Changelog](https://github.com/ROCm/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v1.0.0...v1.1.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>
2024-04-24 16:48:32 -06:00
Sam Wu
ccc27838f8 Merge branch 'docs/6.1.0' into roc-6.1.x 2024-04-22 11:59:35 -06:00
Sam Wu
023f478384 Merge develop into roc-6.1.x (#3048)
* Add ROCm version 6.1.0 to version list (#3023)

* Update CHANGELOG.md

Added GitHub links to Changelog

* Update CHANGELOG.md

* Update manifest for ROCm 6.1.0 (#3022)

* Reorganize default.xml by group and alphabetically

* Add rocDecode to default.xml

* Add rocDecode to included names in tag script

* update tag to 6.1.0

---------

Co-authored-by: Young Hui - AMD <145490163+yhuiYH@users.noreply.github.com>

* Update CHANGELOG.md

Updated ROCm Compiler with fixed issue

* docs(tools/autotag/README.md): Add additional note to avoid duplicating data in changelog template (#3018)

* Bump rocm-docs-core from 0.38.1 to 1.0.0 in /docs/sphinx

Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.38.1 to 1.0.0.
- [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases)
- [Changelog](https://github.com/ROCm/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v0.38.1...v1.0.0)

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

Signed-off-by: dependabot[bot] <support@github.com>

* Use Ubuntu 22.04 and Python 3.10 in RTD config

* Update README.md (#3043)

* Update README.md

Fix rocSPARSE build link

* Update link to just general page, instead of anchor

* Add 'JAX for ROCm' link to index.md (#3034)

* Add JAX for ROCm link to index.md

* Reorder third-party libraries installation guides in index

* Update links to rocAL component (#3033)

* Update links to rocAL component

* Change absolute rocm docs links to relative

* Update compatibility/precision-support links (#3030)

* Change links to component data type support pages from absolute to relative

* Fix rocPRIM data type support links

* Empty commit to trigger demo rebuild.

* Update excluded and included projects

* Separate templates into a module; Fix MIVisionX template

* Add hipfort changelog processor

* Add rpp custom processor

* Add custom processor for rvs

* update the code-owner list (#3046)

* Update default.xml (#3038)

* Remove HIPCC from default.xml

HIPCC moved into llvm-project

* Remove ROCm-Device-Libs from default.xml

ROCm-Device-Libs was moved into llvm-project

* Remove ROCm-CompilerSupport from default.xml

ROCm-CompilerSupport was moved into llvm-project

* Add rocprofiler-register to default.xml

Added in 6.1 manifest

* Apply mathlibs group to projects in manifest

* Bump rocm-docs-core from 0.38.1 to 1.0.0 in /docs/sphinx (#3047)

* Bump rocm-docs-core from 0.38.1 to 1.0.0 in /docs/sphinx

Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.38.1 to 1.0.0.
- [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases)
- [Changelog](https://github.com/ROCm/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v0.38.1...v1.0.0)

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

Signed-off-by: dependabot[bot] <support@github.com>

* Set Ubuntu 22.04 and Python 3.10 in ReadtheDocs config

---------

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 <22262939+samjwu@users.noreply.github.com>

* Add 6.1.0.md template

* Add AMD SMI to 6.1.0 template

* Add ROCm Compiler to 6.1.0 template

* Add RDC to 6.1.0 template

* Add ROCgdb to 6.1.0 template

* Add ROCm SMI to 6.1.0 template

* Add ROCProfiler to 6.1.0 template

* Add MI200 SR-IOV known issue to 6.1.0 template

* Add MI300 RAS fixed defect to 6.1.0 template

* docs(6.1.0.md): Add more changelog notes for 6.1.0

* Update 6.1.0.md

Added links to GitHub for known issues and ROCm Compiler fixed defect

* Test autotag script

* Add ck template

* Add HIPIFY to included names for tag script

* Remove rocprofiler from tag_script

* Remove RVS template

Determine cause of missing later

* Add HIPIFY to template for 6.1.0

* Add extra line to topp of template for formatting changelog

* Update 5.7.1.md

Fixing the broken link for rocBLAS programmer's guide in 5.7.1 Changelog.

* Regenerate changelog with new 5.7.1 link fix

* Add note for tag_script included_names

* Improve readability of GPU architecture hardware specs (#3009)

* move units of measurement to table headers

* add glossary explaining table headers

* add missed units and update h1

* toc listing to say indicate Accelerators & GPUs

* fix typo

* update meta description and keywords

* Update title in toc to fit in sidebar

* update title, toc, and filename

* Fix broken link to HIP programming guide

* Revert "update title, toc, and filename"

This reverts commit 6b9e687805.

* Revert glossary; slight fixes

* Change 'Pro' to 'PRO' for consistency

* Add references to programming and hardware architecture guides

* Change 'warp' to 'wavefront'

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Roopa Malavally <56051583+Rmalavally@users.noreply.github.com>
Co-authored-by: Young Hui - AMD <145490163+yhuiYH@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: peter <peter.park@amd.com>
Co-authored-by: amitkumar-amd <120512306+amitkumar-amd@users.noreply.github.com>
2024-04-22 11:56:47 -06:00
peter
42849e92a6 Improve readability of GPU architecture hardware specs (#3009)
* move units of measurement to table headers

* add glossary explaining table headers

* add missed units and update h1

* toc listing to say indicate Accelerators & GPUs

* fix typo

* update meta description and keywords

* Update title in toc to fit in sidebar

* update title, toc, and filename

* Fix broken link to HIP programming guide

* Revert "update title, toc, and filename"

This reverts commit 6b9e687805.

* Revert glossary; slight fixes

* Change 'Pro' to 'PRO' for consistency

* Add references to programming and hardware architecture guides

* Change 'warp' to 'wavefront'
2024-04-22 13:23:21 -04:00
dependabot[bot]
3ac6f3b2cc Bump rocm-docs-core from 0.38.1 to 1.0.0 in /docs/sphinx (#3047)
* Bump rocm-docs-core from 0.38.1 to 1.0.0 in /docs/sphinx

Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.38.1 to 1.0.0.
- [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases)
- [Changelog](https://github.com/ROCm/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v0.38.1...v1.0.0)

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

Signed-off-by: dependabot[bot] <support@github.com>

* Set Ubuntu 22.04 and Python 3.10 in ReadtheDocs config

---------

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 <22262939+samjwu@users.noreply.github.com>
2024-04-18 16:53:34 -06:00
peter
d5c24f30ee Pick link fixes into 6.1.0 (#3045)
* Update compatibility/precision-support links (#3030)

* Change links to component data type support pages from absolute to relative

* Fix rocPRIM data type support links

* Empty commit to trigger demo rebuild.

* Update links to rocAL component (#3033)

* Update links to rocAL component

* Change absolute rocm docs links to relative

* Add 'JAX for ROCm' link to index.md (#3034)

* Add JAX for ROCm link to index.md

* Reorder third-party libraries installation guides in index

* Update README.md (#3043)

* Update README.md

Fix rocSPARSE build link

* Update link to just general page, instead of anchor

---------

Co-authored-by: Young Hui - AMD <145490163+yhuiYH@users.noreply.github.com>
2024-04-18 16:31:23 -04:00
peter
e4055682fe Update compatibility/precision-support links (#3030)
* Change links to component data type support pages from absolute to relative

* Fix rocPRIM data type support links

* Empty commit to trigger demo rebuild.
2024-04-18 15:10:41 -04:00
peter
e84f95f96c Update links to rocAL component (#3033)
* Update links to rocAL component

* Change absolute rocm docs links to relative
2024-04-18 15:08:20 -04:00
peter
2db2dac10d Add 'JAX for ROCm' link to index.md (#3034)
* Add JAX for ROCm link to index.md

* Reorder third-party libraries installation guides in index
2024-04-18 15:02:56 -04:00
Sam Wu
d45af8cfc6 Merge roc-6.1.x into docs/6.1.0 (#3026)
* update manifest file for ROCm6.1 (#3024)

Co-authored-by: Wang, Yanyao <yanyao.wang@amd.com>

* Add ROCm version 6.1.0 to version list (#3023) (#3025)

---------

Co-authored-by: Yanyao Wang <yanywang@amd.com>
Co-authored-by: Wang, Yanyao <yanyao.wang@amd.com>
2024-04-17 09:11:56 -07:00
Sam Wu
4970c5d010 Add ROCm version 6.1.0 to version list (#3023) (#3025) 2024-04-16 18:22:13 -06:00
Sam Wu
0c14b861d2 Add ROCm version 6.1.0 to version list (#3023) 2024-04-16 16:21:59 -06:00
Sam Wu
fcf3037953 Merge branch 'develop' into docs/6.1.0 2024-04-16 16:06:48 -06:00
Sam Wu
de6b23da83 Sync develop branches 2024-04-16 15:56:14 -06:00
Lisa Delaney
2ea7ac694e Manually update release notes and changelog
Added known issue for ROCm compiler

https://ontrack-internal.amd.com/browse/SWDEV-454778

Added known issue for RVS

Added known issue for MI200 SRIOV

Updated PEBB test known issue for RVS

Added expansion for PEBB

Added PBQT known issue

expanded P2P Benchmark and Qualification Tool

Edited RVS known issue description based on Leo's input

Added MI300A fixed defect

Removed PEBB and Babel Stream from RVS known issue

Updated RCCL

Added rocm-cmake

Added rocRAND

Added rocWMMA

Added Tensile

Alan's change 1

Alan change to HIPIFY

Alan's edit 3 for MIOpen

OpenMP 2nd bullet fix - Alan edit

Alan's edit - ROCm Compiler

ROCm Validation Suite edits

Alan's edit rocSOLVER

Alan's edit to ROCTracer

Updated hipSPARSELt

Added hipTensor 1.2.0

Added hipTensor

data type correction

updated the RCCL version

Added bullets to known issues for consistency

Changed RAS to Fixed defect
2024-04-16 15:55:29 -06:00
peter
d5a5bd4da5 Cherry-pick: add rocDecode (#3020)
* Add rocDecode to What is ROCm? components list (#3016)

* Add rocDecode to What is ROCm? components list

* Fix typo -> 'Common Language Runtime'

* Change 'compute' to 'common'

* Add rocDecode to API libraries (#3019)
2024-04-16 16:20:00 -04:00
peter
3ffd2f78e9 Add rocDecode to API libraries (#3019) 2024-04-16 16:08:03 -04:00
peter
4b1574cbe2 Add rocDecode to What is ROCm? components list (#3016)
* Add rocDecode to What is ROCm? components list

* Fix typo -> 'Common Language Runtime'

* Change 'compute' to 'common'
2024-04-16 15:48:17 -04:00
Young Hui - AMD
b9502cbf97 Update requirements.txt (#3012) 2024-04-12 17:18:02 -04:00