From e01f13e80357c69ad3bddf6372d0c1f45c8666df Mon Sep 17 00:00:00 2001 From: Peter Park Date: Thu, 27 Jun 2024 12:49:37 -0700 Subject: [PATCH] VER2 Mockup of new release notes template for 6.2 (#97) Add new components.xml --------- Co-authored-by: Sam Wu <22262939+samjwu@users.noreply.github.com> --- RELEASE.md | 281 ++++++++++++++++++++++------------- docs/sphinx/_toc.yml.in | 8 +- docs/sphinx/requirements.in | 2 +- docs/sphinx/requirements.txt | 84 +++++------ tools/autotag/components.xml | 71 +++++++++ 5 files changed, 296 insertions(+), 150 deletions(-) create mode 100644 tools/autotag/components.xml diff --git a/RELEASE.md b/RELEASE.md index c6fd86a5a..80ff9835f 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -1,4 +1,4 @@ -# ROCm 6.1.2 release notes +# AMD ROCm 6.2 Release Notes @@ -11,136 +11,213 @@ -ROCm 6.1.2 includes enhancements to SMI tools and improvements to some libraries. +The release notes provide a comprehensive summary of changes since the previous AMD ROCm release. -### OS support +This document includes the following sections: -ROCm 6.1.2 has been tested against a pre-release version of Ubuntu 22.04.5 (kernel: 5.15 [GA], 6.8 [HWE]). +* {ref}`Release highlights ` +* {ref}`Operating system and hardware support notes ` +* {ref}`ROCm components versioning ` +* {ref}`Detailed component notes ` +* {ref}`ROCm platform known issues ` +* {ref}`ROCm platform upcoming changes ` -### AMD SMI +```{eval-rst} +The :doc:`Compatibility matrix <../compatibility/compatibility-matrix>` page summarizes ROCm compatibility across +successive major and minor releases. +``` -AMD SMI for ROCm 6.1.2 +Previous ROCm release notes are available in the previous versions of the documentation. Browse previous +versions of ROCm documentation in {doc}`../release/versions`. -#### Additions +(rn-highlights)= +## Release highlights + +AMD ROCm 6.2 introduces some fancy new features and improves the taste of spinach. + +This section also describes other highlights. + +### System stability + +Submerging your hardware in water improves the flow of data. + +### rocDecode + +It now tastes great and is less filling. + +(rn-os-hw-support)= +## Operating system and hardware support notes + +AMD ROCm 6.2 adds the following operating system support: + +* MI300A: Ubuntu 22.04.4 and RHEL 9.3 +* MI300X: Ubuntu 22.04.4 + +Future releases will add additional operating systems to match the general offering. + +For more information about the complete list of supported operating systems and hardware, see the system requirements +page for {doc}`Linux ` and +{doc}`Windows `. + +(rn-components-ver)= +## Components + +The ROCm components are versioned independently. In addition to listing each component, this section also notes upgraded components + +```{eval-rst} +.. csv-table:: + :header: "Category", "Group", "Name", "Version", "Repository" + :stub-columns: 2 + :widths: 1 1 1 1 1 + + "Libraries", "Machine learning and computer vision", :doc:`Composable Kernel `, 1.1, ``__ + "", "", :doc:`MIGraphX `, 1.0, ``__ + "", "", :doc:`MIOpen `, 1.0, ``__ + "", "", :doc:`MIVisionX `, 1.1.0 ⇒ :ref:`1.1.1 `, ``__ + "", "", :doc:`rocAL `, 2.1.5, ``__ + "", "", :doc:`rocDecode `, 1.1.0, ``__ + "", "", :doc:`rocPyDecode `, 1.1.0, ``__ + "", "", :doc:`ROCm Performance Primitives (RPP) `, 4.4.1, ``__ + "", "Communication", :doc:`RCCL `, 2.18.6, ``__ + "", "Math", :doc:`half `, 1.0.0, ``__ + "", "", :doc:`hipBLAS `, 1.4.12, ``__ + "", "", :doc:`hipBLASLt `, 1.4.12, ``__ + "", "", :doc:`hipFFT `, 1.4.12, ``__ + "", "", :doc:`hipfort `, 1.4.12, ``__ + "", "", :doc:`hipRAND `, 1.4.12, ``__ + "", "", :doc:`hipSOLVER `, 1.4.12, ``__ + "", "", :doc:`hipSPARSE `, 1.4.12, ``__ + "", "", :doc:`hipSPARSELt `, 1.4.12, ``__ + "", "", :doc:`rocALUTION `, 1.4.12, ``__ + "", "", :doc:`rocBLAS `, 6.5.0 ⇒ :ref:`6.5.1 `, ``__ + "", "", :doc:`rocFFT `, 1.4.12, ``__ + "", "", :doc:`rocRAND `, 1.4.12, ``__ + "", "", :doc:`rocSOLVER `, 1.4.12, ``__ + "", "", :doc:`rocSPARSE `, 1.4.12, ``__ + "", "", :doc:`rocWMMA `, 1.4.12, ``__ + "", "", :doc:`Tensile `, 1.4.12, ``__ + "", "Primitives", :doc:`hipCUB `, 1.0.0, ``__ + "", "", :doc:`hipTensor `, 1.0.0, ``__ + "", "", :doc:`rocPRIM `, 1.0.0, ``__ + "", "", :doc:`rocThrust `, 10.10.11, ``__ + "Tools", "Development", :doc:`HIPIFY `, 0.9.18, ``__ + "", "", :doc:`ROCdbgapi `, 0.16.1, ``__ + "", "", :doc:`ROCmCC `, 0.9.18, ``__ + "", "", :doc:`ROCm CMake `, 0.1.1, ``__ + "", "", :doc:`ROCm Debugger `, 0.9.18, ``__ + "", "", :doc:`ROCr Debug Agent `, 0.9.18, ``__ + "", "Performance", :doc:`Omniperf `, 2.0, ``__ + "", "", :doc:`Omnitrace `, 2.0.1, ``__ + "", "", :doc:`ROCm Bandwidth Test `, 2.0.1, ``__ + "", "", :doc:`ROCProfiler `, 1.19.1, ``__ + "", "", rocprofiler-sdk, 1.19.1, ``__ + "", "", :doc:`ROCTracer `, 2.0.0, ``__ + "", "System", :doc:`AMD SMI `, 1.2.4 ⇒ :ref:`1.2.5 `, ``__ + "", "", :doc:`rocminfo `, 2.0.0, ``__ + "", "", :doc:`ROCm Data Center Tool `, 2.0.0, ``__ + "", "", :doc:`ROCm SMI `, 2.0.0, ``__ + "", "", :doc:`ROCm Validation Suite `, 2.0.0, ``__ + "", "", :doc:`TransferBench `, 2.0.0, ``__ + "Compilers", "", :doc:`FLANG `, 0.9.10, ``__ + "", "", :doc:`hipCC `, 1.0, ``__ + "", "", LLVM (amdclang), 3.0.1, ``__ + "Runtimes", "", :doc:`AMD Common Language Runtime (CLR) `, 1.0.0, ``__ + "", "", :doc:`HIP `, 1.0, ``__ + "", "", :doc:`ROCR-Runtime `, 3.0.1, ``__ +``` + +(rn-components-det)= +## Detailed component notes + +(mivisionx)= +### MIVisionX (1.1.1) + +#### Changes + +* Describes changes to existing functionality or the addition of new functionality. +* You no longer need to clap to improve performance. + +#### Removals + +* Describes functionality or support that has been removed in this version. Quite often this information will have been noted in the Upcoming changes section +* Support for Microsoft Windows 95 has been removed. + +#### Resolved issues + +* Describes resolved since the previous version of this component. It should include information from earlier versions. +* Your ROCm applications can now run in the dark. + +#### Optimizations + +* Describes how the component has been optimized or improved. +* Works even better on a Commodore 64. + +#### Known issues + +* Describes known issues related to this specific component. We have a different section for the ROCm platform known issues. +* Component 1 doesn't operate as expected with an endless loop. + +#### Upcoming changes + +* Describes upcoming changes that we’re very confident will be introduced. Must be careful not to overpromise (especially on release numbers or dates). + This section should also include deprecation notices. Items in this section should be rolled forward until the change is introduced. +* In a future release, the hardware will generate electricity instead of consuming it. + +(rocblas)= +### rocBLAS (6.5.1) + +#### Changes + +* Describes changes to existing functionality or the addition of new functionality. +* You no longer need to clap to improve performance. + +#### Optimizations + +* Describes how the component has been optimized or improved. +* Works even better on a Commodore 64. + +(amdsmi)= +### AMD SMI (1.2.5) + +#### Changes * Added process isolation and clean shader APIs and CLI commands. * `amdsmi_get_gpu_process_isolation()` * `amdsmi_set_gpu_process_isolation()` * `amdsmi_set_gpu_clear_sram_data()` * Added the `MIN_POWER` metric to output provided by `amd-smi static --limit`. - -#### Optimizations - -* Updated the `amd-smi monitor --pcie` output to prevent delays with the `monitor` command. - -#### Changes - * Updated `amismi_get_power_cap_info` to return values in uW instead of W. * Updated Python library return types for `amdsmi_get_gpu_memory_reserved_pages` and `amdsmi_get_gpu_bad_page_info`. * Updated the output of `amd-smi metric --ecc-blocks` to show counters available from blocks. -#### Fixes +#### Removals + +* Removed the `amdsmi_get_gpu_process_info` API from the Python library. It was removed from the C library in an earlier release. + +#### Resolved issues * `amdsmi_get_gpu_board_info()` no longer returns junk character strings. * `amd-smi metric --power` now correctly details power output for RDNA3, RDNA2, and MI1x devices. * Fixed the `amdsmitstReadWrite.TestPowerCapReadWrite` test for RDNA3, RDNA2, and MI100 devices. * Fixed an issue with the `amdsmi_get_gpu_memory_reserved_pages` and `amdsmi_get_gpu_bad_page_info` Python interface calls. -#### Removals +#### Optimizations -* Removed the `amdsmi_get_gpu_process_info` API from the Python library. It was removed from the C library in an earlier release. +* Updated the `amd-smi monitor --pcie` output to prevent delays with the `monitor` command. ```{note} See the AMD SMI [detailed changelog](https://github.com/ROCm/amdsmi/blob/rocm-6.1.x/CHANGELOG.md) with code samples for more information. ``` -### ROCm SMI +(rn-known-issues)= +## ROCm platform known issues -ROCm SMI for ROCm 6.1.2 +AMD ROCm known issues are noted on [GitHub](https://github.com/ROCm/ROCm/labels/Verified%20Issue). This section also notes resolved issues. +For known issues related to individual components, review the content in [Detailed component notes](rn-components-det). -#### Additions - -* Added the ring hang event to the `amdsmi_evt_notification_type_t` enum. - -#### Fixes - -* Fixed an issue causing ROCm SMI to incorrectly report GPU utilization for RDNA3 GPUs. See the issue on [GitHub](https://github.com/ROCm/ROCm/issues/3112). -* Fixed the parsing of `pp_od_clk_voltage` in `get_od_clk_volt_info` to work better with MI-series hardware. - -## Library changes in ROCm 6.1.2 - -| Library | Version | -|---------|---------| -| AMDMIGraphX | [2.9](https://github.com/ROCm/AMDMIGraphX/releases/tag/rocm-6.1.2) | -| composable_kernel | [0.2.0](https://github.com/ROCm/composable_kernel/releases/tag/rocm-6.1.2) | -| hipBLAS | [2.1.0](https://github.com/ROCm/hipBLAS/releases/tag/rocm-6.1.2) | -| hipBLASLt | [0.7.0](https://github.com/ROCm/hipBLASLt/releases/tag/rocm-6.1.2) | -| hipCUB | [3.1.0](https://github.com/ROCm/hipCUB/releases/tag/rocm-6.1.2) | -| hipFFT | [1.0.14](https://github.com/ROCm/hipFFT/releases/tag/rocm-6.1.2) | -| hipRAND | [2.10.17](https://github.com/ROCm/hipRAND/releases/tag/rocm-6.1.2) | -| hipSOLVER | [2.1.1](https://github.com/ROCm/hipSOLVER/releases/tag/rocm-6.1.2) | -| hipSPARSE | [3.0.1](https://github.com/ROCm/hipSPARSE/releases/tag/rocm-6.1.2) | -| hipSPARSELt | [0.2.0](https://github.com/ROCm/hipSPARSELt/releases/tag/rocm-6.1.2) | -| hipTensor | [1.2.0](https://github.com/ROCm/hipTensor/releases/tag/rocm-6.1.2) | -| MIOpen | [3.1.0](https://github.com/ROCm/MIOpen/releases/tag/rocm-6.1.2) | -| MIVisionX | [2.5.0](https://github.com/ROCm/MIVisionX/releases/tag/rocm-6.1.2) | -| rccl | [2.18.6](https://github.com/ROCm/rccl/releases/tag/rocm-6.1.2) | -| rocALUTION | [3.1.1](https://github.com/ROCm/rocALUTION/releases/tag/rocm-6.1.2) | -| rocBLAS | 4.1.0 ⇒ [4.1.2](https://github.com/ROCm/rocBLAS/releases/tag/rocm-6.1.2) | -| rocDecode | 0.5.0 ⇒ [0.6.0](https://github.com/ROCm/rocDecode/releases/tag/rocm-6.1.2) | -| rocFFT | [1.0.27](https://github.com/ROCm/rocFFT/releases/tag/rocm-6.1.2) | -| rocm-cmake | [0.12.0](https://github.com/ROCm/rocm-cmake/releases/tag/rocm-6.1.2) | -| rocPRIM | [3.1.0](https://github.com/ROCm/rocPRIM/releases/tag/rocm-6.1.2) | -| rocRAND | [3.0.1](https://github.com/ROCm/rocRAND/releases/tag/rocm-6.1.2) | -| rocSOLVER | [3.25.0](https://github.com/ROCm/rocSOLVER/releases/tag/rocm-6.1.2) | -| rocSPARSE | [3.1.2](https://github.com/ROCm/rocSPARSE/releases/tag/rocm-6.1.2) | -| rocThrust | [3.0.1](https://github.com/ROCm/rocThrust/releases/tag/rocm-6.1.2) | -| rocWMMA | [1.4.0](https://github.com/ROCm/rocWMMA/releases/tag/rocm-6.1.2) | -| rpp | [1.5.0](https://github.com/ROCm/rpp/releases/tag/rocm-6.1.2) | -| Tensile | [4.40.0](https://github.com/ROCm/Tensile/releases/tag/rocm-6.1.2) | - -### RCCL - -RCCL 2.18.6 for ROCm 6.1.2 - -#### Changes - -* Reduced `NCCL_TOPO_MAX_NODES` to limit stack usage and avoid stack overflow. - -### rocBLAS - -rocBLAS 4.1.2 for ROCm 6.1.2 - -#### Optimizations - -* Tuned BBS TN and TT operations on the CDNA3 architecture. - -#### Fixes - -* Fixed an issue related to obtaining solutions for BF16 TT operations. - -### rocDecode - -rocDecode 0.6.0 for ROCm 6.1.2 - -#### Additions - -* Added support for FFmpeg v5.x. - -#### Optimizations - -* Updated error checking in the `rocDecode-setup.py` script. - -#### Changes - -* Updated core dependencies. -* Updated to support the use of public LibVA headers. - -#### Fixes - -* Fixed some package dependencies. - -## Upcoming changes +(rn-upcoming)= +## ROCm platform upcoming changes +The section notes upcoming changes related to the AMD ROCm platform. For upcoming changes related to individual components, review the content in [Detailed component notes](rn-components-det). * A future release will enable the use of HIPCC compiled binaries `hipcc.bin` and `hipconfig.bin` by default. No action is needed by users; you may continue calling high-level Perl scripts `hipcc` and `hipconfig`. `hipcc.bin` and `hipconfig.bin` will be invoked by the high-level Perl scripts. To revert to the previous behavior and invoke `hipcc.pl` and `hipconfig.pl`, set the `HIP_USE_PERL_SCRIPTS` environment variable to `1`. * A subsequent release will remove high-level HIPCC Perl scripts from `hipcc` and `hipconfig`. This release will remove the `HIP_USE_PERL_SCRIPTS` environment variable. It will rename `hipcc.bin` and `hipconfig.bin` to `hipcc` and `hipconfig` respectively. No action is needed by the users. To revert to the previous behavior, invoke `hipcc.pl` and `hipconfig.pl` explicitly. diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in index 6b511231f..1013a8b43 100644 --- a/docs/sphinx/_toc.yml.in +++ b/docs/sphinx/_toc.yml.in @@ -9,10 +9,10 @@ subtrees: - file: what-is-rocm.rst - file: about/release-notes.md title: Release notes - subtrees: - - entries: - - file: about/changelog.md - title: Changelog + # subtrees: + # - entries: + # - file: about/changelog.md + # title: Changelog - url: https://github.com/ROCm/ROCm/labels/Verified%20Issue title: Known issues diff --git a/docs/sphinx/requirements.in b/docs/sphinx/requirements.in index cdee26699..e0a45158f 100644 --- a/docs/sphinx/requirements.in +++ b/docs/sphinx/requirements.in @@ -1,2 +1,2 @@ -rocm-docs-core==1.1.1 +rocm-docs-core==1.4.0 sphinx-reredirects==0.1.3 diff --git a/docs/sphinx/requirements.txt b/docs/sphinx/requirements.txt index b81481721..1137c046b 100644 --- a/docs/sphinx/requirements.txt +++ b/docs/sphinx/requirements.txt @@ -1,14 +1,14 @@ # -# This file is autogenerated by pip-compile with Python 3.8 +# This file is autogenerated by pip-compile with Python 3.10 # by the following command: # -# pip-compile --resolver=backtracking docs/sphinx/requirements.in +# pip-compile requirements.in # -accessible-pygments==0.0.4 +accessible-pygments==0.0.5 # via pydata-sphinx-theme -alabaster==0.7.13 +alabaster==0.7.16 # via sphinx -babel==2.14.0 +babel==2.15.0 # via # pydata-sphinx-theme # sphinx @@ -16,7 +16,7 @@ beautifulsoup4==4.12.3 # via pydata-sphinx-theme breathe==4.35.0 # via rocm-docs-core -certifi==2024.2.2 +certifi==2024.6.2 # via requests cffi==1.16.0 # via @@ -26,17 +26,17 @@ charset-normalizer==3.3.2 # via requests click==8.1.7 # via sphinx-external-toc -cryptography==42.0.5 +cryptography==42.0.8 # via pyjwt deprecated==1.2.14 # via pygithub -docutils==0.19 +docutils==0.21.2 # via # breathe # myst-parser # pydata-sphinx-theme # sphinx -fastjsonschema==2.19.1 +fastjsonschema==2.20.0 # via rocm-docs-core gitdb==4.0.11 # via gitpython @@ -50,61 +50,57 @@ jinja2==3.1.4 # via # myst-parser # sphinx -markdown-it-py==2.2.0 +markdown-it-py==3.0.0 # via # mdit-py-plugins # myst-parser markupsafe==2.1.5 # via jinja2 -mdit-py-plugins==0.3.5 +mdit-py-plugins==0.4.1 # via myst-parser mdurl==0.1.2 # via markdown-it-py -myst-parser==1.0.0 +myst-parser==3.0.1 # via rocm-docs-core -packaging==24.0 +packaging==24.1 # via # pydata-sphinx-theme # sphinx pycparser==2.22 # via cffi -pydata-sphinx-theme==0.14.4 +pydata-sphinx-theme==0.15.3 # via # rocm-docs-core # sphinx-book-theme pygithub==2.3.0 # via rocm-docs-core -pygments==2.17.2 +pygments==2.18.0 # via # accessible-pygments # pydata-sphinx-theme # sphinx pyjwt[crypto]==2.8.0 - # via - # pygithub - # pyjwt + # via pygithub pynacl==1.5.0 # via pygithub -pytz==2024.1 - # via babel pyyaml==6.0.1 # via # myst-parser # rocm-docs-core # sphinx-external-toc -requests==2.31.0 +requests==2.32.3 # via # pygithub # sphinx -rocm-docs-core==1.1.1 +rocm-docs-core==1.4.0 # via -r requirements.in -smmap==5.0.0 +smmap==5.0.1 # via gitdb snowballstemmer==2.2.0 # via sphinx soupsieve==2.5 # via beautifulsoup4 -sphinx==5.3.0 +sphinx==7.3.7 # via # breathe # myst-parser @@ -116,37 +112,39 @@ sphinx==5.3.0 # sphinx-external-toc # sphinx-notfound-page # sphinx-reredirects -sphinx-book-theme==1.0.1 +sphinx-book-theme==1.1.3 # via rocm-docs-core sphinx-copybutton==0.5.2 # via rocm-docs-core -sphinx-design==0.5.0 +sphinx-design==0.6.0 # via rocm-docs-core -sphinx-external-toc==0.3.1 +sphinx-external-toc==1.0.1 # via rocm-docs-core -sphinx-notfound-page==1.0.0 +sphinx-notfound-page==1.0.2 # via rocm-docs-core sphinx-reredirects==0.1.3 - # via -r docs/sphinx/requirements.in -sphinxcontrib-applehelp==1.0.4 + # via -r requirements.in +sphinxcontrib-applehelp==1.0.8 # via sphinx -sphinxcontrib-devhelp==1.0.2 +sphinxcontrib-devhelp==1.0.6 # via sphinx -sphinxcontrib-htmlhelp==2.0.1 +sphinxcontrib-htmlhelp==2.0.5 # via sphinx sphinxcontrib-jsmath==1.0.1 # via sphinx -sphinxcontrib-qthelp==1.0.3 +sphinxcontrib-qthelp==1.0.7 # via sphinx -sphinxcontrib-serializinghtml==1.1.5 +sphinxcontrib-serializinghtml==1.1.10 # via sphinx -typing-extensions==4.5.0 - # via pydata-sphinx-theme -urllib3==1.26.18 - # via requests -wrapt==1.14.1 - # via deprecated -zipp==3.18.1 +tomli==2.0.1 + # via sphinx +typing-extensions==4.12.2 # via - # importlib-metadata - # importlib-resources + # pydata-sphinx-theme + # pygithub +urllib3==2.2.1 + # via + # pygithub + # requests +wrapt==1.16.0 + # via deprecated diff --git a/tools/autotag/components.xml b/tools/autotag/components.xml new file mode 100644 index 000000000..41ec61a17 --- /dev/null +++ b/tools/autotag/components.xml @@ -0,0 +1,71 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +