Commit Graph

74 Commits

Author SHA1 Message Date
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
Peter Park
6494885359 Rename fine-tuning and optimization guide directory and fix index.md (#3242)
* Mv fine-tuning and optimization files

* Reorder index.md

* Rename images directory

* Fix internal links
2024-06-05 11:11:00 -04:00
Peter Park
9a347aa168 Update fine-tuning guide: title, improve readibility in code blocks, fix typos (#3222)
* Fix typo

* Add torchtune link

* Add newlines before comments in code blocks for readability

* Update title
2024-06-03 22:11:19 -04:00
Peter Park
fed33835a0 Add "Fine Tuning LLMs" how to guide (#3124)
* Add Fine Tuning LLMs how to guide

* Reorg and refactor Fine-tuning LLMs with ROCm

Update index and headings

Fix formatting and update toc

Split out content from index to overview.rst

Add metadata

Clean up overview

Add inference sections, fix rst errors, clean up single-gpu-fine-tuning

Combine fine-tuning and inference guides

Fix some links and formatting

Update toc and add formatting fixes

Add ck kernel fusion content

Update toc

Clean up model quantization and acceleration

Add CK images

Clean up profiling

Update triton kernel performance optimization

Update llm inference frameworks guide

Disable automatic number of figures and tables in Sphinx conf

Change tabs to spaces

Change heading to end with -ing

Add link fixes and heading updates

Add rocprof/Omniperf/Omnitrace section

Update profiling and debugging guide

Add formatting fixes

Satisfy spellcheck

Fix words

Delete unused file

Finish overview

Clean up first 4 sections

Multi-gpu fine-tuning guide: slight fixes

Update toc

Remove tabs

Formatting fixes

* Minor wording updates

* Add some clean-up

* Update profiling and debugging gudie

* Fix Omnitrace link

* Update ck kernel fusion with latest

* Update CK formatting

* Fix perfetto link syntax

* Fix typos and add blurbs

* Add fixes to Triton optimization doc

* Tabify saving adapters / models section

* Fix linting errors - spellcheck

Fix spelling and grammar

Satisfy linter

Update wording in profiling guide

Add fixes to satisfy linter

More fixes for linting in Triton guide

More linting fixes

Spellcheck in CK guide

* Improve triton guide

Fix linting errors and optics

* Add occupancy / vgpr table

Change some wording

* Re-add tunableop

* Add missing indent in _toc.yml

* Remove ckProfiler references

* Add links to resources

* Add refs in CK optimization guide

* Rename files and fix internal links

* Organize tuning guides

Reorg triton

* Add compute unit diagram

* Remove AutoAWQ

* Add higher res image for Perfetto trace example

* Update link text

* Update fig nums

* Update some formatting

* Update "Inductor"

* Change "Inductor" to TorchInductor

* Add link to official TorchInductor docs
2024-06-03 14:04:33 -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
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
0ba6bb43ef fix bad file extention referencing setting-cus.rst in index.md 2024-05-28 12:27:02 +02:00
Bence Parajdi
3edc3e9759 add new page to index.md 2024-05-13 16:27:04 +02:00
randyh62
7ebd810f7a updates for SWDEV-459863 (#3113) 2024-05-09 12:42:48 -07: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
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
Lisa
a29b54a453 Update links (#2992)
* Update links

* table cleanup

* cross-refs

* wordlist update

* add temp hard links

* verbiage

* docs(index.md): Disable MD051 for Sphinx Markdown anchor point

In general this rule should be followed to avoid broken links

* revert gpu-arch table, remove dropdowns, quick start hyphen removedon index.md

* revise opening text as per PR comment

---------

Co-authored-by: Lisa <lisa.delaney@amd.com>
Co-authored-by: Sam Wu <sam.wu2@amd.com>
Co-authored-by: Young Hui <young.hui@amd.com>
2024-04-12 15:36:23 -04:00
Istvan Kiss
47d06cb492 Precision support (#2815)
* Precision support page initial commit

Move to rst file

Fix details of Mi100

Update docs/about/compatibility/precission-support.md Co-authored-by: MKKnorr <MKKnorr@web.de>

* Update precission-support page

Co-authored-by: MKKnorr <MKKnorr@web.de>

* PR fix based on feedbackcs

* Rename precision-support.rst to data-type_support.rts

* Update rocThrust library data type support

* PR findings fixes

* Update data-type-support page

Co-authored-by: MKKnorr <MKKnorr@web.de>

* Update docs/about/compatibility/data-type-support.rst

Co-authored-by: MKKnorr <MKKnorr@web.de>

* lisa edits

---------

Co-authored-by: MKKnorr <MKKnorr@web.de>
Co-authored-by: Lisa Delaney <lisa.delaney@amd.com>
2024-03-05 09:48:14 -07:00
MKKnorr
cd586348f5 Add instinct gpu architectures information (#2859)
* Add instinct gpu architectures information

* Improve gpu architecture table

Move table to "reference" instead of "conceptual"

* Add HIP terminology to GPU Arch glossary
2024-02-29 15:03:23 -07:00
Lisa
371b06f2c0 What is updates (#2923) 2024-02-23 12:13:26 -07:00
Sam Wu
89110a1662 Merge pull request #2910 from LisaDelaney/image-cleanup
add alt text
2024-02-22 17:26:17 -07:00
Istvan Kiss
67e3fc994b MI300 documentation (#2779)
---------

Co-authored-by: Nagy-Egri Máté Ferenc <mate@streamhpc.com>
Co-authored-by: Lisa Delaney <lisa.delaney@amd.com>
Co-authored-by: Davide Teixeira <77169625+daviteix@users.noreply.github.com>
2024-02-20 17:02:36 -07:00
Lisa Delaney
70ea915709 reduce image sizes 2024-02-20 10:34:04 -07:00
Lisa Delaney
40014ae3ad add alt text 2024-02-20 10:15:23 -07:00
Lisa
801457ce6a update tm (#2887) 2024-02-08 16:15:33 -07:00
Lisa
3c94962813 new banner images (#2884) 2024-02-08 11:53:48 -07:00
Lisa
8bbd51376d update contributing section & update card images (#2865) 2024-02-07 09:31:45 -07:00
Lisa
df70d90d49 radeon updates (#2818)
* radeon updates

* update link

* update intro

* verbiage

* Update docs/index.md

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

* Update docs/what-is-rocm.md

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

* Use intersphinx link for radeon

---------

Co-authored-by: Sam Wu <sam.wu2@amd.com>
2024-01-30 13:20:28 -07:00
Sam Wu
d509656c6b Fix typo (#2809) 2024-01-16 10:48:21 -07:00
Lisa
d399b13c88 add keywords (#2799) 2024-01-11 14:07:30 -07:00
Lisa
5f9842db8f link fixes & consistency (#2761) 2023-12-20 12:42:15 -07:00
Sam Wu
5b672af67d build: Update rocm-docs-core to v0.30.2 (#2724)
* build: Update rocm-docs-core to v0.30.2

* docs: Fix doc links in index
2023-12-15 14:32:46 -07:00
Lisa
a121e35aa7 rearranging (#2718) 2023-12-15 14:03:14 -07:00
Lisa
bcc8603454 update links, remove windows (#2706) 2023-12-14 09:21:50 -07:00
Lisa
3aa7072fc2 metadata test (#2656) 2023-11-30 14:37:12 -07:00
Lisa
3523e9e822 Open MPI updates (#2655) 2023-11-30 09:58:12 -07:00
Lisa Delaney
f0f4fa15b4 merge conflicts & remove linux install 2023-10-25 13:15:47 -06:00
Nara
74d8f95afb ROCm 5.7.1 Linux install and compatibility updates (#2547) 2023-10-13 15:16:14 -06:00
Lisa
4b7775d264 move spack & update pytorch (#2532) 2023-10-10 14:51:55 -06:00
Lisa
e87dba01c6 ROCm restructuring (#2521)
Flattened out page structure for improved navigability.
 * Change Table of Contents 
 * Update the install guides for windows and linux
 * Removed extraneous index pages
 * GPU architecture pages duplicate entries removed
 * spack page cleanup

---------

Co-authored-by: Sam Wu <samwu103@amd.com>
Co-authored-by: Saad Rahim (AMD) <44449863+saadrahim@users.noreply.github.com>
2023-10-06 15:42:11 -06:00
Lisa
d0d4eed1a6 Update titles to sentence case (#2455) 2023-09-18 12:26:31 -06:00