Commit Graph

573 Commits

Author SHA1 Message Date
Jeffrey Novotny
e7939656e7 Fix typo for TFLOPs metric in MI250 architecture page 2024-08-12 09:03:39 -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
dependabot[bot]
f47afb7c66 Bump rocm-docs-core from 1.6.1 to 1.6.2 in /docs/sphinx (#3536)
Bumps [rocm-docs-core](https://github.com/ROCm/rocm-docs-core) from 1.6.1 to 1.6.2.
- [Release notes](https://github.com/ROCm/rocm-docs-core/releases)
- [Changelog](https://github.com/ROCm/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/ROCm/rocm-docs-core/compare/v1.6.1...v1.6.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>
2024-08-07 10:15:39 -06: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
72cf5aa092 Update version list with 6.2.0 (#3505) 2024-08-02 14:14:38 -06:00
Sam Wu
33ce708926 Sync develop branch 2024-08-02 11:13:45 -06:00
Young Hui - AMD
10f8efa7e8 remove Ubuntu 20.04 from being listed, and revise MI300X footnotes (#125) 2024-08-02 12:43:47 -04: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
spolifroni-amd
b6a305f924 made the linter happy 2024-08-02 10:55:56 -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
Sandra Polifroni
531796f523 removed all references to the feedback email 2024-08-02 10:40:53 -04:00
Young Hui - AMD
9de6c61100 fix linting and update 6.2 stack image (#123) 2024-07-31 18:57:19 -04:00
randyh62
647634a976 Update ROCm component links (#116)
* Update ROCm component links

* link update

* correct rocal

* change ROCm Compilers link

* update llvm-project reference for rocmcc

* use llvm-project for Clang

* reorder links to match image

* fix link format

* Update rocm-tools.md

fix link syntax

* add spell checking note

* may to might

* add compilers to tools

* update what-is-rocm image

* Young's comments

* Leo's comments

* tools, compiler, and runtimes

* move hipify

* Perter's comments
2024-07-31 13:27:28 -07:00
Young Hui - AMD
dbea7719f9 Compatibility Matrix with initial 6.2 data (#105)
* initial commit for placeholder 6.2 data

* fix TensorFlow versions, and LLVM/OpenMP version strings

* add third column with 6.1.0 as last column.  Update some versions from Peter's review comments

* reduce RPP name

* remove trailing comma

* reduce length of 3rd party communications libs title

* change footnote for 6.2 to remove mention of MI300A

* remove TransferBench

* change from 6.1.0 to 6.0.0 data in last column

* fixing a few version numbers

* add rocprofiler-sdk version

* fix omnitrace version

* adding full matrix, 2 different views

* add copying csv in conf.py

* 6.2 content edits, and change subheadings to remove :, renamed a few as Leo suggested

* add Framework anchor within compat matrix, and fix linting error

* categorized tools

* update Cub/Thrust versions, abbreviate Management

* remove the dedicated histtorical page

* WIP commit, added anchors and in compat matrix, along with anchor test code

* check 6.1.1 and 6.0.2 versions, add anchors thru table

* audit 6.2 RC4 versions against table, remove clang-ocl, and update hip-other version

* avoid linting
2024-07-31 13:31:24 -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
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
Young Hui
a4d6a8259c add runtimes banner graphic 2024-07-30 11:53:06 -04:00
Peter Park
59df2fc110 Update license.md for 6.2 (#119)
* add omniperf, omnitrace, rocprofiler-sdk, and rocpydecode to license.md

* remove clang-ocl

* fix rocpydecode license
2024-07-30 10:57:58 -04:00
Young Hui
f56aca0d31 add new compilers banner graphic 2024-07-29 16:07:37 -04:00
dependabot[bot]
4643ee1d74 Bump rocm-docs-core from 1.6.0 to 1.6.1 in /docs/sphinx (#3468)
Bumps [rocm-docs-core](https://github.com/ROCm/rocm-docs-core) from 1.6.0 to 1.6.1.
- [Release notes](https://github.com/ROCm/rocm-docs-core/releases)
- [Changelog](https://github.com/ROCm/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/ROCm/rocm-docs-core/compare/v1.6.0...v1.6.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-07-26 16:46:10 -06:00
Sam Wu
8cb0813fac Set env var for canonical URL (#3465) 2024-07-26 15:36:59 -06: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
dependabot[bot]
8dd8596057 Bump rocm-docs-core from 1.5.0 to 1.6.0 in /docs/sphinx (#3458)
Bumps [rocm-docs-core](https://github.com/ROCm/rocm-docs-core) from 1.5.0 to 1.6.0.
- [Release notes](https://github.com/ROCm/rocm-docs-core/releases)
- [Changelog](https://github.com/ROCm/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/ROCm/rocm-docs-core/compare/v1.5.0...v1.6.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-07-26 10:09:16 -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
Sam Wu
235191535c Remove unused configurations in conf.py (#3444) 2024-07-22 09:40:38 -06:00
Sam Wu
b08cef45cd Merge remote-tracking branch 'upstream/roc-6.1.x' into develop 2024-07-19 17:06:31 -06:00
Sam Wu
7dcf79f95e Sync develop branch 2024-07-18 16:03:44 -06:00
b-sumner
f3dcb40950 Update using-gpu-sanitizer.md with new known issues (#3423) 2024-07-18 14:10:38 -07:00
Sam Wu
e800ec1847 Remove protocol from canonical url 2024-07-18 09:56:33 -06:00
Sam Wu
867d8e294e Set environment variables for RTD builds (#113)
* Format conf.py with black and isort

* Set env vars for RTD builds

* Define html_context

* Use rocm-stg for canonical url
2024-07-17 16:37:28 -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
091fa3ef8e update AI framework image (#3406)
* update AI framework image

* remove old image
2024-07-16 11:02:07 -07:00
randyh62
2a34212ddd reorg ROCm landing page (#112)
* reorg ROCm landing page

* Conceptual
2024-07-16 09:17:34 -07:00
spolifroni-amd
f3cc6be6dd Removed TransferBench from the tools list (#3421) 2024-07-15 13:46:56 -04:00
dependabot[bot]
a3bb1d5e4f Bump sphinx-reredirects from 0.1.4 to 0.1.5 in /docs/sphinx (#3419)
Bumps [sphinx-reredirects](https://github.com/documatt/sphinx-reredirects) from 0.1.4 to 0.1.5.
- [Commits](https://github.com/documatt/sphinx-reredirects/compare/v0.1.4...v0.1.5)

---
updated-dependencies:
- dependency-name: sphinx-reredirects
  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-07-15 09:15:14 -06:00
Sam Wu
a36295c880 Sync develop branch 2024-07-09 12:43:37 -06:00
dependabot[bot]
9d6e415dde Bump certifi from 2024.2.2 to 2024.7.4 in /docs/sphinx (#3399)
Bumps [certifi](https://github.com/certifi/python-certifi) from 2024.2.2 to 2024.7.4.
- [Commits](https://github.com/certifi/python-certifi/compare/2024.02.02...2024.07.04)

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

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-07-08 11:49:11 -06:00
dependabot[bot]
0e52d354a3 Bump rocm-docs-core from 1.4.1 to 1.5.0 in /docs/sphinx (#3396)
Bumps [rocm-docs-core](https://github.com/ROCm/rocm-docs-core) from 1.4.1 to 1.5.0.
- [Release notes](https://github.com/ROCm/rocm-docs-core/releases)
- [Changelog](https://github.com/ROCm/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/ROCm/rocm-docs-core/compare/v1.4.1...v1.5.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-07-04 17:01:52 -06:00
randyh62
b601290c28 Framework image update (#104)
* added professional graphic 

to replace hand modified

* Update deep-learning-rocm.rst

update image reference

* Delete docs/data/how-to/framework_install_2024_05_23-update.png

replace with renamed file with correct date

* Add files via upload

updated dat in file name

* Update deep-learning-rocm.rst

corrected image name to reflect new date

* Update deep-learning-rocm.rst

corrected file name

* Add files via upload

correct name

* Delete docs/data/how-to/framework_install_2024_07-04.png

name format incorrect

* Update deep-learning-rocm.rst

correct image name
2024-07-04 09:23:23 -07:00
Sam Wu
83c87d2191 Merge pull request #3391 from ROCm/develop
Merge develop into roc-6.1.x
2024-07-03 15:09:25 -06:00
randyh62
8678e351fa update CLR docs reference (#3389)
* update CLR docs reference

* Apply suggestions from code review

Co-authored-by: Peter Park <peter.park@amd.com>

---------

Co-authored-by: amitkumar-amd <Amit.Kumar6@amd.com>
Co-authored-by: Peter Park <peter.park@amd.com>
2024-07-03 16:59:26 -04: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
Sam Wu
8311130829 New template for changelog (#100)
* Use components.xml instead of default.xml

* Rm unused var

* Use category instead of group

* Add group and category

* Change changelog template

* Conditional display

* Remove sort

* Add mappings

* Jinja does not track state

* Handle dupe logic in python

* Construct doc page and repo url

* Add repo url

* Add doc page

* Avoid using bare URL

* Add None key

* Test release notes
2024-07-03 09:17:21 -06:00
Sam Wu
d991252467 Sync develop branch 2024-07-02 13:59:50 -06:00
dependabot[bot]
8ad4435420 Bump rocm-docs-core from 1.4.0 to 1.4.1 in /docs/sphinx (#3375)
Bumps [rocm-docs-core](https://github.com/ROCm/rocm-docs-core) from 1.4.0 to 1.4.1.
- [Release notes](https://github.com/ROCm/rocm-docs-core/releases)
- [Changelog](https://github.com/ROCm/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/ROCm/rocm-docs-core/compare/v1.4.0...v1.4.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-07-02 10:44:57 -06: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