109 Commits

Author SHA1 Message Date
Istvan Kiss
81b7745f8e Docs: Add Environment Variable Page (#395)
Co-authored-by: Adel Johar <adel.johar@amd.com>
2025-11-19 17:40:26 +01:00
anisha-amd
a98236a4e3 Main Docs: references of accelerator removal and change to GPU (#5495)
* Docs: references of accelerator removal and change to GPU

Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>
Co-authored-by: Pratik Basyal <pratik.basyal@amd.com>
2025-10-16 11:22:10 -04:00
Istvan Kiss
7b7ff53985 Update Radeon link (#5453) 2025-10-15 17:25:05 +02:00
Pratik Basyal
c35a0a121a ROR link and text updated (#5426) 2025-09-24 13:28:13 -05:00
Istvan Kiss
d476d09aff Update precision support page with missing libraries and RDNA2 and CDNA4 support 2025-08-28 17:09:34 +02:00
Pratik Basyal
a0faccba37 AMD GPU Docs System optimization migration changes in ROCm Docs Develop (#4538)
* AMD GPU Docs System optimization migration changes in ROCm Docs (#296)

* System optimization migration changes in ROCm

* Linting issue fixed

* Linking corrected

* Minor change

* Link updated to Instinct.docs.amd.com

* ROCm docs grid updated by removing IOMMU.rst, pcie-atomics, and oversubscription pages

* Files removed and reference fixed

* Reference text updated

* GPU atomics from 6.4.0 removed
2025-03-27 16:38:10 -04:00
Jeffrey Novotny
d401b5f152 Add ToC and index links to the AI Developer Tutorials (#4312)
* Add ToC and index links to the AI Developer Tutorials

* Change link positioning

* Change wording
2025-01-29 14:43:32 -05:00
Pratik Basyal
353d2fe1c1 2nd POC for How to Use ROCm for AI (#282) (#4299)
* New TOC for ROCm for AI developed

Co-authored-by: Peter Park <peter.park@amd.com>
2025-01-27 15:49:21 -05:00
Adel Johar
7754fc4b9d Docs: resolve warnings from sphinx build output 2025-01-16 14:36:47 +01:00
Peter Park
d534f755e4 Add metadata to docs (#3688)
* add missing metadata

add metadata to mi300 arch doc

add metadata to contributing guide

add metadata to mi300x tuning guides

* update meta to yaml frontmatter

* update to md metadata to myst frontmatter

* remove extra file

* fix spelling
2025-01-14 08:55:45 -05:00
alexxu-amd
f7e04d8fb0 remove MPI page from index (#4206)
Co-authored-by: Alex Xu <alex.xu@amd.com>
2024-12-30 14:23:46 -05:00
alexxu-amd
85bd6e98f5 Remove gpu-cluster-networking and 'Using MPI' page due to migration to Instinct Docs (#4201)
* remove 'Using MPI' and 'gpu-cluster-networking' sections due to migration to dcgpu

* remove gpu-cluster-networking from index page

---------

Co-authored-by: Alex Xu <alex.xu@amd.com>
2024-12-30 09:39:46 -05:00
alexxu-amd
fe69fc1bb4 Update index.md 2024-12-23 18:01:06 -05:00
Pratik Basyal
33891d6fd0 Bar memory update develop (#4168)
* Bar Memory page added

* Leo's feedback incorporated

* Spell check fixed

* SME review feedback incorporated

* Feedback updated

* Indentation fixed

---------

Co-authored-by: prbasyal <prbasyal@amd.com>
2024-12-20 16:05:49 -05:00
Istvan Kiss
21d26e52d0 Add graph safe support 2024-12-19 14:48:58 +01:00
Pratik Basyal
6a7d8654ad Revamped PCIe into new format and incorporated style guide (#4051)
* Revamped PCIe into new format and incorporated style guide

* Title case fixed

* Quick fix and changes

* Added RMW to wordlist and updated titles

* Grammatical fixes incorporated

* Sandra's review feedback incorporated

* Removed PCIe3 feature reference

* Leo's feedback incorporated

* Sandra's feedback incorporated

* Replaced execute with run

* Replaced executing with running

* SME review feedback incorporated

* Minor feedback updated

* Sandra's feedback incorporated

* Filename renamed

* File rename changes updated

* Document title updated

---------

Co-authored-by: prbasyal <prbasyal@amd.com>
2024-12-17 12:00:00 -05:00
randyh62
49e50b93c6 Update index.md (#4144) (#4146)
Remove Programming Guide topic from "How to"
2024-12-09 12:17:54 -08:00
Istvan Kiss
3354099b9c Remove GPU memory page 2024-12-09 17:23:57 +01:00
Sam Wu
f77e2dd7a7 Sync develop branch (#4078) 2024-12-03 15:18:51 -07:00
alexxu-amd
89a978aef5 Add a page explaining IOMMU to Conceptual section (#3851)
* Add a page explaining IOMMU to Conceptual section

* fix typo, expand wordlist

* fix typo

* streamlined the iommu section (#3947)

* streamlined the iommu section

* made changes based on feedback

* tweaked some language around xgmi etc

* removed the reference to the MI300 to ensure a long shelf-life for this content

* changed onwards bc the spellcheck didn't like it

* Update docs/conceptual/iommu.rst

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

* Update docs/conceptual/iommu.rst

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

* Update docs/conceptual/iommu.rst

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

* Update docs/conceptual/iommu.rst

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

* Update docs/conceptual/iommu.rst

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

* Updated based

---------

Co-authored-by: spolifroni-amd <Sandra.Polifroni@amd.com>
Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>
2024-11-15 16:30:48 -05:00
Istvan Kiss
385dbc30d3 Update docs/how-to/hip_programming_guide.rst
Co-authored-by: MKKnorr <MKKnorr@web.de>
2024-11-07 17:36:38 +01:00
randyh62
77d61fbf4c Update docs/index.md 2024-11-07 17:36:38 +01:00
randyh62
fb5c08138e Update docs/how-to/hip_programming_guide.rst
Co-authored-by: MKKnorr <MKKnorr@web.de>
2024-11-07 17:36:38 +01:00
Istvan Kiss
d41f1362de Apply suggestions from code review
Co-authored-by: randyh62 <42045079+randyh62@users.noreply.github.com>
2024-11-07 17:36:38 +01:00
Istvan Kiss
ba3e128246 Increase visibility of programming guide 2024-11-07 17:36:38 +01:00
Pratik Basyal
59eb02af42 Changed the introductory text linked to Radeon (#3988)
Co-authored-by: prbasyal <prbasyal@amd.com>
2024-11-04 14:20:43 -05:00
Peter Park
35b16c1293 add vllm performance validation doc (#3964) 2024-10-30 13:24:11 -04:00
Peter Park
d0ecf51b0c add oversubscription conceptual doc (#3885)
add mitigiation steps

add to toc

move page for build

move doc

fix spelling

update doc

update oversubscription

update order

fix spelling

add oversubscription to wordlist

move oversubscription topic to bottom of toc and index
2024-10-11 15:47:23 -04:00
spolifroni-amd
a8dd588a72 Removed MIGraphX optimization page (#3848) 2024-10-04 17:06:51 -04:00
Michael Benavidez
d7e3a38e2c Add links to gpu cluster network guides (#3763)
* Add links to gpu cluster network guides

* Add newline character to eof

* Make link absolute

* add dynamic branch in toc

* remove unnecessary page

clean up

* clean up index/toc

* make multi-node topics adjacent

---------

Co-authored-by: Peter Park <peter.park@amd.com>
2024-10-01 14:05:57 -04:00
Young Hui - AMD
b745ff1367 restore index links from merge resolution (#175) 2024-09-20 09:48:25 -04:00
Young Hui - AMD
a5d38bf094 Adding preliminary compatibility matrix data for 6.2.1 (#134)
* adding preliminary compatibility matrix data for 6.2.1

* bump up some version numbers from 6.2.0 to 6.2.1

* adding kernel versions to compatibility matrix. I hate it

* add kernel version lookup table, in dropdown list

* add KFD and User space support. Also adjust some meta data keywords

* update 6.2.1 RC2 versions

* make spelling linter happy

* remove kernel versions from table, just reference LUT below

* Leave kenerel Lookup table expanded

* update kernel version table

* remove kernels from historical matrix, update footnotes

* move historical matrix into compatibility folder

* update historical matrix paths

* version bumps for RC3

* RC4 has no other version bumps. Reorder RPP alphabetically

* change How-To card hue to purple
2024-09-19 20:34:36 -04:00
Sam Wu
797d536965 Sync develop branch 2024-09-19 14:08:10 -06:00
randyh62
14325b17c7 Css card titles (#145)
* move precision_support to reference

* add rocPyDecode to AI

* Use CSS style sheets for Card titles

* remove temp folder and files

* add card hues

* shuffle hues

* update requirements

* add hues test

* add hues test2

* select hues

* remove hues test

* use hues and add gutters

* sync TOC and index titles

* once more through the TOC
2024-08-22 15:01:12 -07:00
randyh62
5d9be8118c move precision_support to reference (#132)
* move precision_support to reference

* add rocPyDecode to AI
2024-08-19 10:12:25 -07:00
Young Hui - AMD
d8bed576ce Fix links in historical compatibility matrix and broken OpenMP link (#3592)
* fix framework intersphinx links in historical matrix

* fix OpenMP link
2024-08-15 10:28:51 -06:00
Jeffrey Novotny
bdcb82372b MI300A system optimization guide internal draft (#117)
* MI300A system optimization guide internal draft

* Small changes to System BIOS paragraph

* Some minor edits

* Changes after external review feedback

* Add CPU Affinity debug setting

* Edit CPU Affinity debug setting

* Changes from external discussion

* Add glossary and other small fixes

* Additional changes from the review

* Update the IOMMU guidance

* Change description of CPU affinity setting

* Slight rewording

* Change Debian to Red Hat-based

* A few changes from the second internal review
2024-07-31 13:29:49 -04:00
Peter Park
222865c8be reorg ROCm landing page (#112) (#120)
* reorg ROCm landing page

* Conceptual

Co-authored-by: randyh62 <42045079+randyh62@users.noreply.github.com>
2024-07-30 16:43:00 -04:00
Sam Wu
c71969b79a Sync develop branch 2024-07-26 09:21:07 -06:00
Young Hui - AMD
2c5aabec54 Add Build-ROCm page (#109)
* add build-rocm page

* change tools name to Optimization with new card image, and reordered tool groups

* Update docs/how-to/build-rocm.rst with writer edits

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

* Apply suggestions from code review

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

* fix link to build page on index

* restore the performance banner

---------

Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>
2024-07-25 11:16:12 -04:00
Peter Park
7b883f3af4 Add MI300X tuning guides (#3448)
* Add MI300X tuning guides

Add mi300x doc (pandoc conversion)

fix headings

add metadata

move images to shared/

move images to shared/

convert tuning-guides.md to rst using pandoc

add mi300x to tuning-guides.rst landing page

update h1s, toc, and landing page

fix spelling

fix fmt

format code blocks

add tensilelite imgs

fix formatting

fix formatting some more

fix formatting

more formatting

spelling

remove --enforce-eager note

satisfy spellcheck linter

more spelling

add fixes from hongxia

fix env var in D5

add fixes to PyTorch inductor section

fix

fix

Update docs/how-to/tuning-guides/mi300x.rst

Co-authored-by: Hongxia Yang
<62075498+hongxiayang@users.noreply.github.com>

Update docs/how-to/tuning-guides/mi300x.rst

Co-authored-by: Hongxia Yang
<62075498+hongxiayang@users.noreply.github.com>

Update docs/how-to/tuning-guides/mi300x.rst

Co-authored-by: Hongxia Yang
<62075498+hongxiayang@users.noreply.github.com>

Update docs/how-to/tuning-guides/mi300x.rst

Co-authored-by: Hongxia Yang
<62075498+hongxiayang@users.noreply.github.com>

Update docs/how-to/tuning-guides/mi300x.rst

Co-authored-by: Hongxia Yang
<62075498+hongxiayang@users.noreply.github.com>

Update docs/how-to/tuning-guides/mi300x.rst

Co-authored-by: Hongxia Yang
<62075498+hongxiayang@users.noreply.github.com>

Update docs/how-to/tuning-guides/mi300x.rst

Co-authored-by: Hongxia Yang
<62075498+hongxiayang@users.noreply.github.com>

Update docs/how-to/tuning-guides/mi300x.rst

Co-authored-by: Hongxia Yang
<62075498+hongxiayang@users.noreply.github.com>

Update docs/how-to/tuning-guides/mi300x.rst

Co-authored-by: Hongxia Yang
<62075498+hongxiayang@users.noreply.github.com>

Update docs/how-to/tuning-guides/mi300x.rst

Co-authored-by: Hongxia Yang
<62075498+hongxiayang@users.noreply.github.com>

Update docs/how-to/tuning-guides/mi300x.rst

Co-authored-by: Hongxia Yang
<62075498+hongxiayang@users.noreply.github.com>

Update docs/how-to/tuning-guides/mi300x.rst

Co-authored-by: Hongxia Yang
<62075498+hongxiayang@users.noreply.github.com>

Update 'torch_compile_debug' suggestion based on Hongxia's feedback

fix PyTorch inductor env vars

minor formatting fixes

Apply suggestions from code review

Co-authored-by: Hongxia Yang
<62075498+hongxiayang@users.noreply.github.com>

Update vllm path

Co-authored-by: Hongxia Yang
<62075498+hongxiayang@users.noreply.github.com>

disable numfig in Sphinx configuration

fix formatting and capitalization

add words to wordlist

update index

update wordlist

update optimizing-triton-kernel

convert cards to table

fix link in index.md

add @lpaoletti's feedback

Add system tuning guide

add images

add system section

add os settings and sys management

remove pcie=noats recommendation

reorg

add blurb to developer section

impr formatting

remove windows os from tuning guides pages in conf.py

add suggestions from review

fix typo and link

remove os windows from relevant pages in conf

mi300x

add suggestions from review

fix toc

fix index links

reorg

update vLLM vars

Co-authored-by: Hongxia Yang
<62075498+hongxiayang@users.noreply.github.com>

update vLLM vars

Co-authored-by: Hongxia Yang
<62075498+hongxiayang@users.noreply.github.com>

reorganize

add warnings

add text to system tuning

add filler text on index pages

reorg tuning pages

fix links

fix vars

* rm old pages

fix toc

* add suggestions from review

small change

add more suggestions

rewrite intro

* add 'workload tuning philosophy'

* refactor

* fix broken links

* black format conf.py

* simplify cmd and update doc structure

* add higher-level heading for consistency (mi300x.rst)

* add fixes from review

fix url

add fixes

fix formatting

fix fmt

fix hipBLASLt section

change words

fix tensilelite section

fix

fix

fix fmt

* style guide

* fix some formatting

* satisfy spellcheck linter

* update wordlist

* fix bad conflict resolution
2024-07-22 17:24:14 -04:00
Sam Wu
7dcf79f95e Sync develop branch 2024-07-18 16:03:44 -06:00
Peter Park
e641b1b25f Update system optimization guides headings (#3422)
* update headings to system optimization

* update index

* conv tuning-guides.md to rst

* shorten system optimization landing page

* update conf.py

update toc order

add space

* Update docs/how-to/tuning-guides.rst

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

* update keywords

* update intro

---------

Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>
2024-07-16 15:43:00 -04:00
randyh62
2a34212ddd reorg ROCm landing page (#112)
* reorg ROCm landing page

* Conceptual
2024-07-16 09:17:34 -07:00
randyh62
3c42dc49ab Add llvm-project references (#101)
* Add llvm-project references

* fix link format

* Update docs/conceptual/compiler-topics.md

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

* update llvm-project links

* one more llvm-project link

---------

Co-authored-by: Young Hui - AMD <145490163+yhuiYH@users.noreply.github.com>
2024-07-03 11:09:24 -07:00
Peter Jun Park
5c9d071e85 remove card text styling 2024-06-26 14:12:25 -04:00
randyh62
356ad4ab47 remove Magma (#3361)
* remove Magma

* missed one
2024-06-26 10:00:39 -07:00
Peter Park
1435634f5c reorder toc (#3346) 2024-06-21 18:53:55 -04:00
Peter Park
22e9f6f373 Add "Using ROCm for HPC" guide (#3302)
* Add ROCm for HPC

* Update index and toc

* Add TMs in other tutorials

* Add hpc apps table

Spellcheck

add stack image and fix links

Add descriptions

update copy

Update copy

add ref

Finish adding app descriptions

tweak descs

fix line lengths

* Revert "Add TMs in other tutorials"

This reverts commit 08a1a80e57.

* Add links to install and compat matrix

* Update HPC stack graphic and add some links

Add hpc and td to wordlist

fix links

* Apply suggestions from Leo's review

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

Update docs/how-to/rocm-for-hpc/index.rst

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

Update docs/how-to/rocm-for-hpc/index.rst

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

Update docs/how-to/rocm-for-hpc/index.rst

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

Update docs/how-to/rocm-for-hpc/index.rst

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

Update docs/how-to/rocm-for-hpc/index.rst

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

fix formatting

Update words

* update wordlist

* Update hpc app descriptions with content from InfinityHub catalog
2024-06-21 16:15:18 -04:00
Istvan Kiss
78fdcdf48d Update docs/conceptual/setting-cus.rst
Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>
2024-06-12 16:17:42 +02:00