Commit Graph

19 Commits

Author SHA1 Message Date
Adel Johar
01bad4c3d9 [rocm-libraries] ROCm/rocm-libraries#8205 (commit f58120c)
[Docs] Standardize precision support reference pages across
 components (#8205)

## Motivation

The goal of this PR is to standardize the precision support reference
page format across all components, while also reducing the maintenance
of burden of having to manually update the YAML data file in
https://rocm.docs.amd.com/en/latest/reference/precision-support.html

## Technical Details

- Each component maintains its own YAML file which will be eventually
used in
https://rocm.docs.amd.com/en/latest/reference/precision-support.html
- A new precision support reference page is introduced which will not
override existing data type/precision support content; it will serve as
the overview/summary that will be linked in the ROCm reference page

## Test Plan

- Built locally, viewed each component manually

## Test Result

<!-- Briefly summarize test outcomes. -->

## Submission Checklist

- [x] Look over the contributing guidelines at
https://github.com/ROCm/ROCm/blob/develop/CONTRIBUTING.md#pull-requests.
2026-06-19 15:08:04 +00:00
peterjunpark
da0ae0f97e [rocm-libraries] ROCm/rocm-libraries#7380 (commit 50b369d)
docs(composablekernel): update install pages for 7.13 (#7380)

## Motivation

Update instructions to install prebuilt packages. Generally, point to
ROCm Core SDK install instructions. List a more granular package if
useful to users.

Preview:
https://rocm.docs.amd.com/projects/composable_kernel/en/users-peterjunpark-ck-7.13-install/install/Composable-Kernel-install.html

>[!NOTE]
>Some links appear as plain text in the preview b/c the target page
isn't publicly accessible yet.

Related to:
- [x] composablekernel https://github.com/ROCm/rocm-libraries/pull/7380
  - [x] hipblas https://github.com/ROCm/rocm-libraries/pull/7378
  - [x] hipblaslt https://github.com/ROCm/rocm-libraries/pull/7379
  - [x] hipcub https://github.com/ROCm/rocm-libraries/pull/7377
  - [x] hipdnn https://github.com/ROCm/rocm-libraries/pull/7376
  - [x] hipfft https://github.com/ROCm/rocm-libraries/pull/7375
  - [x] hiprand https://github.com/ROCm/rocm-libraries/pull/7374
  - [x] hipsolver https://github.com/ROCm/rocm-libraries/pull/7371
  - [x] hipsparse https://github.com/ROCm/rocm-libraries/pull/7373
  - [x] hipsparselt https://github.com/ROCm/rocm-libraries/pull/7372
  - [x] miopen https://github.com/ROCm/rocm-libraries/pull/7370
  - [x] rocblas https://github.com/ROCm/rocm-libraries/pull/7369
  - [x] rocfft https://github.com/ROCm/rocm-libraries/pull/7368
  - [x] rocprim https://github.com/ROCm/rocm-libraries/pull/7367
  - [x] rocrand https://github.com/ROCm/rocm-libraries/pull/7366
  - [x] rocsolver https://github.com/ROCm/rocm-libraries/pull/7364
  - [x] rocsparse https://github.com/ROCm/rocm-libraries/pull/7365
  - [x] rocthrust https://github.com/ROCm/rocm-libraries/pull/7363
  - [x] rocwmma https://github.com/ROCm/rocm-libraries/pull/7362

<!-- Explain the purpose of this PR and the goals it aims to achieve.
-->

## Technical Details

<!-- Explain the changes along with any relevant GitHub links. -->

## JIRA ID

<!-- If applicable, mention the JIRA ID resolved by this PR (Example:
Resolves SWDEV-12345). -->
<!-- Do not post any JIRA links here. -->

## Test Plan

<!-- Explain any relevant testing done to verify this PR. -->

## Test Result

<!-- Briefly summarize test outcomes. -->

## Submission Checklist

- [ ] Look over the contributing guidelines at
https://github.com/ROCm/ROCm/blob/develop/CONTRIBUTING.md#pull-requests.
2026-05-15 07:57:41 -07:00
spolifroni-amd
d775806672 [rocm-libraries] ROCm/rocm-libraries#4431 (commit ca33816)
[CK] updated github repo link (#4431)

The location of the github repo has changed; the landing page of the
docs needs to reflect this.

Updated only the git repo links in the docs folder.

Also added info to the install doc about how to do a sparse checkout.

Updated some refs that were messed up while I was at it.

---------

Co-authored-by: Illia Silin <98187287+illsilin@users.noreply.github.com>
2026-02-26 10:35:42 -08:00
spolifroni-amd
d2f1541976 [rocm-libraries] ROCm/rocm-libraries#4300 (commit 07e9d56)
[CK] add inter/intrawave scheduling concept doc
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

## Proposed changes

Adding information about inter/intrawave scheduling
2026-02-07 00:11:11 +00:00
spolifroni-amd
0cc83cb8e8 CK: removed the api reference (#3571)
* removed the api reference

* updating to the latest rocm-docs-core min version

* fixed a formatting issue with buffer views

* removed reference links from code snippets

* removed reference links from code snippets

---------

Co-authored-by: John Afaganis <john.afaganis@amd.com>
2026-01-27 07:36:47 -08:00
spolifroni-amd
d9d4c9c3df [composable_kernel] initial draft of the ck tile conceptual doc (#3242)
* Adding CK Tile documentation

* Updates based on feedback

* Fix tile window API description

* Fix remaining images

* add documentation about flush_cache and rotating_buffer functionality in ck_tile

* Supplement the documentation

* light edit of the ck tile conceptual doc

* Fixes for ruff check.

* Fixes for ruff check 2.

* Fixes for ruff check 3.

---------

Co-authored-by: Vidyasagar <vanantha@amd.com>
Co-authored-by: AviralGoelAMD <aviral.goel@amd.com>
Co-authored-by: ThomasNing <thomas.ning@amd.com>
Co-authored-by: Vidyasagar Ananthan <vidyasagar.ananthan@amd.com>
2025-12-04 11:09:21 -08:00
spolifroni-amd
e11f694eda first commit of the glossary (#2702)
* first commit of the glossary

* minor changes

* Update docs/reference/Composable-Kernel-Glossary.rst

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

* Update docs/reference/Composable-Kernel-Glossary.rst

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

* Update Composable-Kernel-Glossary.rst

---------

Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>
Co-authored-by: Vidyasagar Ananthan <vanantha@amd.com>
2025-09-08 10:55:32 -07:00
spolifroni-amd
096bf2de41 updating the doxyfile and the index.rst so that it gets the full API (#2416)
* updating the doxyfile and the index.rst so that it gets the full API

* added recommended doxygen values
2025-07-07 07:29:36 -07:00
spolifroni-amd
cfae863431 updated Doxyfile and added the class list (#2147)
* updated Doxyfile and added the class list

* Update Doxyfile
2025-04-30 14:58:40 -07:00
spolifroni-amd
2c8132126c fixed broken github link (#2063) 2025-04-08 10:20:31 -07:00
Adel Johar
fc073b483e Docs: Add precision support reference page (#1973)
* Docs: Add precision support reference page

* edit of the precision type content

* added more description on scalars

---------

Co-authored-by: spolifroni-amd <sandra.polifroni@amd.com>
Co-authored-by: Aviral Goel <aviral.goel@amd.com>
2025-03-28 08:12:27 -06:00
spolifroni-amd
a426f67301 creation of install doc and refactor of doc in general (#1908)
* creation of install doc and refactor of doc in general

* updates based on review comments

* updated based on review comments

* updated readme and contributors markdown

* added extra note to not use -j on its own

* added note about smoke tests and regression tests

* made changes as per Illia's feedback

---------

Co-authored-by: Aviral Goel <aviral.goel@amd.com>
2025-03-27 15:13:18 -06:00
peter
501a6b68eb docs: fix broken contributing link (#1244) 2024-04-16 11:32:14 -04:00
randyh62
12441af014 Doc reorg2 (#1189)
* doc_reorg2 updated TOC

* doc_reorg2 updates

* fix conflicts, add grid
2024-03-12 18:25:48 -07:00
randyh62
402a930a4a Randyh docfix (#1130)
* Update LICENSE

update to 2024

* Update index.rst

change license.md to license.html

* fix syntax

---------

Co-authored-by: illsilin <Illia.Silin@amd.com>
2024-01-16 09:00:37 -08:00
randyh62
a39163814e doc reorg and edits (#1112)
* doc reorg and edits

* Update wrapper.rst with changes from PR #1098

* Update docs/dockerhub.rst

Co-authored-by: Bartlomiej Wroblewski <bwroblewski10@gmail.com>

* Update docs/index.rst

Co-authored-by: Bartlomiej Wroblewski <bwroblewski10@gmail.com>

* Update docs/what-is-ck.rst

Co-authored-by: Bartlomiej Wroblewski <bwroblewski10@gmail.com>

* Update docs/what-is-ck.rst

Restored to 4 bullets, with additional text for wrapper.

Co-authored-by: Bartlomiej Wroblewski <bwroblewski10@gmail.com>

* Update docs/Contributors_Guide.rst

Co-authored-by: Lisa <lisajdelaney@gmail.com>

* Update API_Reference_Guide.rst

using sentence case for title

* updated index structure per Lisa

* separate docker hub and tutorial

---------

Co-authored-by: Bartlomiej Wroblewski <bwroblewski10@gmail.com>
Co-authored-by: Lisa <lisajdelaney@gmail.com>
Co-authored-by: Illia Silin <98187287+illsilin@users.noreply.github.com>
2024-01-05 11:04:01 -08:00
Bartłomiej Kocot
836b7e557d Introduce wrapper library (#1071)
* Introduce wrapper library

* Update cmake files

* Revert "Update cmake files"

This reverts commit c27f88b565.

* Fix comments
2023-12-06 11:58:59 +01:00
Bartlomiej Wroblewski
8c13df07bf Improve formatting of docs; Add a note about the DL_KERNELS flag (#825)
* Improve formatting of docs; Add a note about the DL_KERNELS flag

* Change the recommended version of ROCm to 5.6
2023-08-03 15:50:38 +02:00
Sam Wu
f80776d937 standardize docs (#655) 2023-03-23 20:58:59 -07:00