mirror of
https://github.com/ROCm/ROCm.git
synced 2026-02-04 19:35:02 -05:00
8e3d51c31d
* Fix Radeon link and point at R6.1.3 as absolute link (#3757) * Update ROCm manifest to 6.2.1 * Update ROCm branch name * Add 6.2.1 to version list (#3770) * Add links to GH issues in 6.2.1 release notes (#3769) * add MAD page * link to GitHub issues in release notes known issues * update templates for 6.2.1 * Revert "add MAD page" This reverts commit9cce72bba3. * update wordlist for spellcheck linter * add rccl note * update rocal version change heading to be more obvious * make rocal note more specific * fix missing space * fix capitalization * Update RCCL known issue wording (#3775) * add MAD page * fix wording in RCCL known issue * Revert "add MAD page" This reverts commitc81d0f3b0a. * update llvm version for 6.2.1 (#3779) * Fix broken links in 6.2.1 release notes (#3782) * External CI: Replace libomp dependencies with aomp (#3781) Add roctracer dependency for hipBLAS and rocWMMA testing * External CI: Add rocprofiler v1 and v2 smoke tests (#3784) * External CI: ROCgdb smoke tests (#3785) - Since this is an autotools project and not cmake, build and test on gfx942 system instead of separating into two jobs. Pipeline time is short anyway. - Follow build instructions to update build flags and to incorporate the ROCdbgapi. - Results are not parsed and graphed, but the log contents are printed at the end. This was helpful for debugging and will be kept in the pipeline, as the make check-gdb command's output was not helpful on its own. * External CI: rocPyDecode Smoke Test (#3786) * External CI: omniperf pipeline (#3788) - Referred to public documentation, source, and iterative attempts to create and improve build and test pipeline. - ctest failures are due to the test node not having expected marketing name string and override not working. - The fix should be on the omniperf repo side of things, so this pull request should be fine as is. * External CI: create omniperf pipeline IDs, update nightly build (#3790) * Fixed greater than to be less than in rocFFT changes * fix footnote for 6.1.0 (#3791) * fix footnote for 6.1.0 * fix empty columns in historical KFD title * External CI: Publish wheel as artifact for rocPyDecode (#3796) * External CI: fix hip-tests symlink creation (#3799) * Docs: Add Ubuntu 24.04.1 (#3801) * add ubuntu 24.04.1 * add 24.04.1 to bottom os section * fix heading and template * Update compatibility-matrix.rst for OpenMP version * Update compatibility-matrix-historical-6.0.csv for OpenMP version * rm ubuntu 24.04.1 from 6.2.0 * Update docs/compatibility/compatibility-matrix.rst Co-authored-by: Young Hui - AMD <145490163+yhuiYH@users.noreply.github.com> * rm duplicate ubuntu in historical --------- Co-authored-by: Young Hui - AMD <145490163+yhuiYH@users.noreply.github.com> * External CI: fixes for rocMLIR and nightly build (#3800) * External CI: fix symlinks for rocMLIR and nightly build * add pipeline IDs for hip-tests * fix hip-test ID typo * remove llvm-alt license (#3727) * remove llvm-alt license * fix linting error * External CI: enable ROCR-Runtime tests (#3809) * External CI: default branches for hip-tests, omniperf (#3811) * External CI: torch and torchvision smoke tests (#3810) * External CI: torch and torchvision smoke tests - Fixed issues with package name and version for the vision wheel that prevented it from installing. A patch is used until my pull request in vision repo is merged. - Referred to rocAutomation scripts to pick which test scripts to run out of the many in the torch and vision repo, and iteratively tested suggested scripts to see which ones completed in a timely manner. - Leveraging pytest-azurepipelines module to automatically parse and graph results from these tests. * External CI: omnitrace build pipeline (#3812) * External CI: omnitrace build pipeline starter - Adding initial set of dependencies and build flags. * External CI: omnitrace build pipeline - Add bison, rccl, texinfo dependencies based on build failures. - Add AMDGPU_TARGETS flag - Add ROCm binaries to PATH for clang-format and other tools used. * Fix indentation --------- Co-authored-by: Daniel Su <danielsu@amd.com> * External CI: AMDMIGraphX Build Fix (#3814) - Swap to default gcc on OS to resolve build errors from recent commits. - Added libdnnl-dev dependency from iterative attempts with compiler change. - Referred to the passing GitHub checks to observe the compilers that was used. - Build CK jit lib and include in AMDMIGraphX build. * External CI: test fixes w/ roctracer, list omniperf as partially succeeding (#3815) * External CI: rpp tests (#3816) * External CI: Build pipeline for rocprofiler-sdk (#3819) * External CI: Pipeline for rocprofiler-sdk * Add rocprofiler dependency * External CI: rocprofiler-sdk build pipeline --------- Co-authored-by: Daniel Su <danielsu@amd.com> * External CI: Fix/add missing pipeline IDs (#3818) * External CI: omnitrace tests (#3822) * Update tags to 6.2.2 (#3827) * External CI: add roctracer to roc/hipSOLVER test deps (#3825) * External CI: add rocprofiler-sdk pipeline IDs (#3824) * External CI: AMDMIGraphX Smoke Tests (#3830) Co-authored-by: Daniel Su <danielsu@amd.com> * External CI: MIOpen tests (#3837) * Point to release history instead of deprecated changelog (#3836) * External CI: filter out hipTensor extended tests (#3838) * added revised note re. radeon gpus (#3839) * Restructured the contributions section. (#3715) * testing if this file is editable * changed 'kebob-case' to 'dash-case' * Restructured the page to be more straightforward and provide additional repo information * forgot to save * Moved the topic sentence * Wrong accent on the a in diataxis * Removed the feedback info from contributing and moved it to Feedback * fixed spelling errors * fixed some wording and removed second person text * consolidated Build and Structure into Contribute; edited toolchai to (hopefully) conform to style guide; updated toc * updated the titles in the toc * made changes based on feedback * it's better when you save * removed structure and build; fixed something for the linter * added rst to wordlist * added customizations to wordlist * 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> * updated the radeon note (#3850) * External CI: Fix rocPyDecode wheel creation (#3852) - Set values for expected environment variables. - Accompanying changes required in rocPyDecode repo. Pull request will be made. * External CI: pytorch vision patch removal (#3855) My pull request applying this patch was merged upstream, so this is no longer needed and will break the pipeline since it can no longer be applied. * Build(deps): Bump rocm-docs-core from 1.8.1 to 1.8.2 in /docs/sphinx (#3807) Bumps [rocm-docs-core](https://github.com/ROCm/rocm-docs-core) from 1.8.1 to 1.8.2. - [Release notes](https://github.com/ROCm/rocm-docs-core/releases) - [Changelog](https://github.com/ROCm/rocm-docs-core/blob/v1.8.2/CHANGELOG.md) - [Commits](https://github.com/ROCm/rocm-docs-core/compare/v1.8.1...v1.8.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> * updated the radeon note, as it were (#3857) * updated the radeon note, as it were * updated the note again * Set devops team as codeowners for rocm-build (#3860) * Set ext CI as codeowners for rocm-build * Update CODEOWNERS to rocm-devops * External CI: Add option to pull mainline branch for dependencies (#3689) * External CI: Add option to pull mainline branch for dependencies * Missing parameter for mainline branch dependencies. * External CI: mainline branch definitions * Removed MIGraphX optimization page (#3848) * External CI: add a global variable to control gfx942 tests (#3864) * External CI: update component default/mainline branches (#3871) * External CI: Stop building gfx90a (#3872) Save on VM resources until infrastructure has test targets. * External CI: add libstdc++-12 to rocMLIR (#3874) * Add building doc section (#3873) * External CI: programmatically get latest aqlprofile (#3876) * External CI: use ctest for rocm-examples (#3877) * External CI: Tensile pipeline (#3884) * 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 * add oversubscription conceptual doc (#3885) (cherry picked from commitd0ecf51b0c) * External CI: Add pipeline to build upstream boost (#3896) * Update bitsandbytes branch in docs (#3898) * Documentation: Add reference to precision-support floating-point types (#3899) * External CI: use Boost template for MIOpen (#3903) * External CI: create rocprofiler-systems pipeline (#3906) * External CI: omnitrace/rocprof-sys pipeline IDs (#3908) * External CI: MIOpen parse test results (#3913) * External CI: Use pip to install latest cmake on test system (#3915) * added a link to the compatibility matrix (#3904) * added a link to the compatibility matrix * removed quotes * docs: Remove invalid amd_iommu=on parameter Per kernel-parameters.txt, there is no "on" option for amd_iommu. While intel_iommu has it, amd_iommu is automatically on unless specified otherwise. For more info, see these 2 links: https://www.kernel.org/doc/Documentation/admin-guide/kernel-parameters.txt75aa74d52f/drivers/iommu/amd/init.c (L3481)Signed-off-by: Kent Russell <kent.russell@amd.com> * External CI: hipBLASLt build now requires python packaging module (#3926) https://github.com/ROCm/hipBLASLt/pull/1250/files#diff-fee2e6f068b33fca3a1dc49392de8848dbf05c3f4632b680abb1052523e5a30fR35 * External CI: Moved location of upstream pytorch build scripts (#3930) https://github.com/pytorch/pytorch/pull/138103 * External CI: disable rocMLIR tests (#3931) * External CI: disable rocMLIR tests * roctracer AMDGPU_TARGETS flag * External CI: create a GPU diagnostics template (#3932) * External CI: Add CK into pytorch build environment (#3934) * External CI: add support to disable individual component tests (#3938) * External CI: AMDMIGraphX greater-equal pip dependencies (#3939) * Build(deps): Bump rocm-docs-core from 1.8.2 to 1.8.3 in /docs/sphinx (#3933) Bumps [rocm-docs-core](https://github.com/ROCm/rocm-docs-core) from 1.8.2 to 1.8.3. - [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.8.2...v1.8.3) --- 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> * External CI: rocDecode add libva-amdgpu-dev dependency (#3940) * External CI: enumerate GPUs in gpu-diagnostics (#3942) * External CI: move gpu-diag directly before tests (#3943) * External CI: fix HIP_PIPELINE_ID (#3944) --------- Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: Kent Russell <kent.russell@amd.com> Co-authored-by: Jeffrey Novotny <jnovotny@amd.com> Co-authored-by: Sam Wu <22262939+samjwu@users.noreply.github.com> Co-authored-by: Wang, Yanyao <yanyao.wang@amd.com> Co-authored-by: Yanyao Wang <yanywang@amd.com> Co-authored-by: Peter Park <peter.park@amd.com> Co-authored-by: Young Hui - AMD <145490163+yhuiYH@users.noreply.github.com> Co-authored-by: Joseph Macaranas <145489236+amd-jmacaran@users.noreply.github.com> Co-authored-by: Daniel Su <danielsu@amd.com> Co-authored-by: Sandra Polifroni <sandra.polifroni@amd.com> Co-authored-by: randyh62 <42045079+randyh62@users.noreply.github.com> Co-authored-by: Michael Benavidez <michael.benavidez@amd.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: MKKnorr <MKKnorr@web.de> Co-authored-by: Kent Russell <kent.russell@amd.com> Co-authored-by: Joseph Greathouse <jlgreathouse@users.noreply.github.com>
4.1 KiB
4.1 KiB
<head>
</head>
Contributing to the ROCm documentation
The ROCm documentation, like all of ROCm, is open source and available on GitHub. You can contribute to the ROCm documentation by forking the appropriate repository, making your changes, and opening a pull request.
To provide feedback on the ROCm documentation, including submitting an issue or suggesting a feature, see Providing feedback about the ROCm documentation.
The ROCm repositories
The repositories for ROCm and all ROCm components are available on GitHub.
| Module | Documentation location |
|---|---|
| ROCm framework | https://github.com/ROCm/ROCm/tree/develop/docs |
| ROCm installation for Linux | https://github.com/ROCm/rocm-install-on-linux/tree/develop/docs |
| ROCm HIP SDK installation for Windows | https://github.com/ROCm/rocm-install-on-windows/tree/develop/docs |
Individual components have their own repositories with their own documentation in their own docs folders.
The sub-folders within the docs folders across ROCm are typically structured as follows:
| Sub-folder name | Documentation type |
|---|---|
install |
Installation instructions, build instructions, and prerequisites |
conceptual |
Important concepts |
how-to |
How to implement specific use cases |
tutorials |
Tutorials |
reference |
API references and other reference resources |
Editing and adding to the documentation
The ROCm documentation is written in reStructuredText (rst) and Github-flavoured Markdown, and follows the Google developer documentation style guide. reStructuredText is preferred when adding content to the documentation.
To edit or add to the documentation:
-
Fork the repository you want to add to or edit.
-
Clone your fork locally.
-
Create a new local branch cut from the
developbranch of the repository. -
Make your changes to the documentation.
-
Optionally, build the documentation locally before creating a pull request by running the following commands from within the
docsfolder:pip3 install -r sphinx/requirements.txt # You only need to run this command once python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/htmlThe output files will be located in the
docs/_buildfolder. Opendocs/_build/html/index.htmlto view the documentation.For more information on ROCm build tools, see Documentation toolchain.
-
Push your changes. A GitHub link will be returned in the output of the
git pushcommand. Open this link in a browser to create the pull request.The documentation is built as part of the checks on pull request, along with spell checking and linting. Scroll to the bottom of your pull request to view all the checks.
Verify that the linking and spell checking have passed, and that the documentation was built successfully. New words or acronyms can be added to the wordlist file as needed.
The Read The Docs build of your pull request can be accessed by clicking on the Details link next to the Read The Docs build check. Verify that your changes are in the build and look as expected.
Your pull request will be reviewed by a member of the ROCm documentation team.
See the GitHub documentation for information on how to fork and clone a repository, and how to create and push a local branch.
By creating a pull request (PR), you agree to allow your contribution to be licensed under the terms of the
LICENSE.txt file in the corresponding repository. Different repositories can use different licenses.