Commit Graph

66 Commits

Author SHA1 Message Date
Jeffrey Novotny
4992db3e6c Add FBGEMM/FBGEMM_GPU to the Model acceleration libraries page (#3659)
* Add FBGEMM/FBGEMM_GPU to the Model acceleration libraries page

* Add words to wordlist and fix a typo

* Add new sections for Docker and testing

* Incorporate comments from the external review

* Some minor edits and clarifications

* Incorporate further review coments and fix test section

* Add comment to test section

* Change git clone command for FBGEMM repo

* Change Docker command

* Changes from internal review

* Fix linting issue
2024-09-09 11:20:50 -04:00
Jeffrey Novotny
23a67a3abf Add introduction and links to the new guide to the vLLM optimized Doc… (#3637)
* Add introduction and links to the new guide to the vLLM optimized Docker image on AMD Infinity Hub

* Update target link for the Docker vLLM guide

* Change target URL

* Change link target URL again
2024-09-04 17:07:46 -04:00
Peter Park
bc64c7b425 Fix intersphinx links (#3668)
* fix links in install.rst

* fix links in sys opt guides
2024-09-03 12:28:24 -04:00
ozziemoreno
b91522afbb Update model-quantization.rst to import BitsAndBytesConfig from transformers library (#3638) 2024-09-03 10:35:35 -04:00
Jeffrey Novotny
66211e27b6 Expand the section on changing thread affinity (#3653)
* Expand the section on changing thread affinity

* Clarify the methods for configuring allocatable memory settings

* Small correction
2024-08-29 09:45:50 -04:00
Chris Kime
a19fe8bb31 Correct ttm to amdttm (#3648) 2024-08-27 14:23:04 -04:00
Jeffrey Novotny
91d4a7e0c9 Add a section on increasing memory allocation to the MI300A system op… (#3587)
* Add a section on increasing memory allocation to the MI300A system optimization guide

* Addition to wordlist

* Change GB to GiB for consistency

* Standardize GiB/KiB spacing

* Minor wording changes
2024-08-16 08:35:08 -04:00
Peter Park
27f5d9ad7d Fix intersphinx links (#3546)
* update fw install links

* fix more intersphinx links

* fix more links
2024-08-08 15:20:57 -04:00
Baodi
499cff0da0 Typo fix (#3537)
* Typo fix

* Update

---------

Co-authored-by: Peter Jun Park <peter.park@amd.com>
2024-08-08 00:20:56 -04:00
Jeffrey Novotny
2308f43653 Fix link to rocr debug agent (#3525) 2024-08-06 12:11:21 -06:00
Jeffrey Novotny
2d61a92120 Fix link to meta-llama finetuning recipes (#3522) 2024-08-06 12:10:58 -04:00
Sam Wu
33ce708926 Sync develop branch 2024-08-02 11:13:45 -06:00
Peter Park
63d3dfd344 6.2 release notes (#111)
* generate release notes

* update release notes

update release.md

update anchors

fix formatting

* add component notes

* remove known issues from toc

* update pydata sphinx table styling

* remove temp file

* add 6.2.0 templates

* add documentation improvements list

* update conf.py with 6.2.0 version and GA date

* update changelog headings

* remove rserp tickets

* add miopen cl

* remove bolding

* add Ram's feedback

fix  thing

* rm sub-bullets

* update new components formatting

* update amd smi version

* add css

* add table styles

* add component notes and KIs

* update os support wording

* update highlights

* update compilers cls

* fix links

* add KIs

* update KI wording

* add ram's suggestions

* add omniperf known issue

fmt

* system -> system management in components table

* change rocthrust version to 3.0.1

* remove release highlight and add RVS changelog

* update highlights

* fix version nums, add rocr runtime

* reorder components table

* update compiler KI

* more compiler known issue under llvm-proj

* add space

* word

* fix internal links

* add gdb

* update pytorch autocast highligh

* add hipfft cl

* fix hipfft internal link

* fix svg icon color

* fix table

* remove rocblas highlight and update tf hl

* add fixes

* update highlights

* fix ck in table

* fix mivisionx rocal note

* fix link and dbgapi version

* fix link to llvm proj docs

* fix fmt

* add feedback

* add more changes

move clang-ocl to upcoming changes

add fixes

fix some fmt

fix table width

fix formatting

add fixes

fix tensile fmt

remove unused file

update templates

change words

* add known issue

* rm "for unknown reasons"

* fix hipsolver, platform -> software stack

* add amdsmi note

* rm mention of mi308

fmt

* add beta note to rocprofiler-sdk

fix

* bold a heading

* move hipify under compilers

* Revert "move hipify under compilers"

This reverts commit 83861f544a75bce1ea64b14871e1224161d34815.

* fix typos and GA date

update text

* update words

* add processor affinity KI and remove rocHPL KI

* update processor affinity KI

* update llvm-proj KI

fix

* update processor affinity KI

update

* fix hip link

* update templates

* words

* update links to 6.2.0

* remove extra css

* fix some stuff in hip

word

* add dell black screen hang ki

word

* fix rocpydecode link

* remove sass files
2024-08-02 12:40:33 -04:00
Peter Park
717ec0df34 Docs housekeeping / fixes for 6.2 (#124)
* align What is ROCm components order with stack diagram

* update links in mi300x workload tuning

* fix license

* update mi300x system opt

* Update docs/about/license.md

* Update docs/about/license.md
2024-08-02 10:50:25 -04: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
Baodi
0762966fd1 Fix the separator in pip install to be a space instead of a comma (#3455) 2024-07-26 10:09:40 -06: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
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
091fa3ef8e update AI framework image (#3406)
* update AI framework image

* remove old image
2024-07-16 11:02:07 -07:00
James Banks
d275a543cb Update single-gpu-fine-tuning-and-inference.rst with correct --showproductname flag (#3378)
Prior flag of `-showproductname` was not valid
2024-07-02 12:04:29 -04:00
Peter Park
a552f9f6b8 Add fixes to vLLM install and triton kernel optimization (#3366)
* Add fixes to vLLM install and triton kernel optimization

* Update TGI how-to

remove extra step in TGI
2024-06-27 14:28:20 -04:00
randyh62
356ad4ab47 remove Magma (#3361)
* remove Magma

* missed one
2024-06-26 10:00:39 -07: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
Peter Park
fe1c2e9529 Update link to ROCr Debug Agent to docs portal (#3303)
* Fix link to debug agent in what-is-rocm

* ROCm --> ROCR

add index

* ROCR --> ROCr

* Change ROCm Debug Agent to ROCr Debug Agent in docs
2024-06-14 17:52:49 -04:00
Peter Park
d24b3fab61 Fix ExLlama-v2 code snippet (#3281) 2024-06-12 17:03:04 -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
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
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
Edgar Gabriel
00907151a2 minor update to the gpu-mpi section (#2983)
provide the precise parameters required to run Open MPI with libfabric and rocm
support.
2024-04-04 17:44:17 -04:00
Istvan Kiss
02cc970a75 Update github links to ROCm organization 2024-02-09 17:03:40 +01:00
Lisa
a44f6d1efc link updates (#2861) 2024-02-08 17:24:12 -07:00
Lisa
3c94962813 new banner images (#2884) 2024-02-08 11:53:48 -07:00
Lisa
d399b13c88 add keywords (#2799) 2024-01-11 14:07:30 -07:00
Sam Wu
7ffc622039 docs(gpu-enabled-mpi.rst): Fix links to 3rd party support matrices (#2775)
* docs(gpu-enabled-mpi.rst): Fix links to 3rd party support matrices

* docs: Directly link for RST instead of using intersphinx
2024-01-08 16:34:45 -07:00
Lisa
5f9842db8f link fixes & consistency (#2761) 2023-12-20 12:42:15 -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
4adaff02a6 Left nav updates (#2647)
* update gpu-enabled-mpi

update the documentation to also include libfabric based network interconnects,
not just UCX.

* add some technical terms to wordlist

* shorten left nav

* grid updates

---------

Co-authored-by: Edgar Gabriel <Edgar.Gabriel@amd.com>
Co-authored-by: Saad Rahim (AMD) <44449863+saadrahim@users.noreply.github.com>
2023-11-24 07:15:10 -07:00
Lisa
33f110e354 update ROCm name (#2660)
* update ROCm name

* update version history page
2023-11-22 10:30:10 -07: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
urtiwari
2b788350e4 Updated the latest version in the document 2023-10-06 16:06:56 +00:00
urtiwari
e607ba6259 Merge branch 'develop' into develop 2023-10-06 08:20:10 -07:00