From fab437971532203a70ac5372928dab24741efe2c Mon Sep 17 00:00:00 2001 From: Sam Wu Date: Thu, 27 Jul 2023 12:43:11 -0600 Subject: [PATCH] Add 5.5.1 release notes (#2342) * add 5.5.1 release notes * fix markdown linting violations * fix release notes --------- Co-authored-by: Saad Rahim <44449863+saadrahim@users.noreply.github.com> --- CHANGELOG.md | 31 ++++++++++++++----- RELEASE.md | 15 ++++++++- docs/release/gpu_os_support.md | 2 +- docs/release/windows_support.md | 2 -- docs/rocm.md | 4 ++- tools/autotag/templates/rocm_changes/5.5.1.md | 3 +- 6 files changed, 44 insertions(+), 13 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a4e9ba853..307fa08aa 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -20,9 +20,22 @@ The release notes for the ROCm platform. ### What's New in This Release +#### HIP SDK for Windows + +AMD is pleased to announce the availability of the HIP SDK for Windows as part +of the ROCm platform. The +[HIP SDK OS and GPU support page](https://rocm.docs.amd.com/en/docs-5.5.1/release/windows_support.html) +lists the versions of Windows and GPUs validated by AMD. HIP SDK features on +Windows are described in detail in our +[What is ROCm?](https://rocm.docs.amd.com/en/docs-5.5.1/rocm.html#rocm-on-windows) +page and differs from the Linux feature set. Visit +[Quick Start](https://rocm.docs.amd.com/en/docs-5.5.1/deploy/windows/quick_start.html#) +page to get started. Known issues are tracked on +[GitHub](https://github.com/RadeonOpenCompute/ROCm/issues?q=is%3Aopen+label%3A5.5.1+label%3A%22Verified+Issue%22+label%3AWindows). + #### HIP API Change -The following HIP API is updated in the ROCm v5.5.1 release, +The following HIP API is updated in the ROCm 5.5.1 release: ##### `hipDeviceSetCacheConfig` @@ -1158,6 +1171,8 @@ The `hipcc` and `hipconfig` Perl scripts are deprecated. In a future release, co > > There will be a transition period where the Perl scripts and compiled binaries are available before the scripts are removed. There will be no functional difference between the Perl scripts and their compiled binary counterpart. No user action is required. Once these are available, users can optionally switch to `hipcc.bin` and `hipconfig.bin`. The `hipcc`/`hipconfig` soft link will be assimilated to point from `hipcc`/`hipconfig` to the respective compiled binaries as the default option. +(5_4_0_filesystem_reorg_deprecation_notice)= + ##### Linux Filesystem Hierarchy Standard for ROCm ROCm packages have adopted the Linux foundation filesystem hierarchy standard in this release to ensure ROCm components follow open source conventions for Linux-based distributions. While moving to a new filesystem hierarchy, ROCm ensures backward compatibility with its 5.1 version or older filesystem hierarchy. See below for a detailed explanation of the new filesystem hierarchy and backward compatibility. @@ -1268,9 +1283,8 @@ The test was incorrectly using the `hipDeviceAttributePageableMemoryAccess` devi `hipHostMalloc()` allocates memory with fine-grained access by default when the environment variable `HIP_HOST_COHERENT=1` is used. -For more information, refer to the HIP Programming Guide at +For more information, refer to {doc}`hip:.doxygen/docBin/html/index`. - #### SoftHang with `hipStreamWithCUMask` test on AMD Instinct™ @@ -2584,7 +2598,8 @@ The new APIs for virtual memory management are as follows: hipError_t hipMemUnmap(void* ptr, size_t size); ``` -For more information, refer to the HIP API documentation at +For more information, refer to the HIP API documentation at +{doc}`hip:.doxygen/docBin/html/modules`. ##### Planned HIP Changes in Future Releases @@ -2600,7 +2615,8 @@ This release introduces a new ROCm C++ library for accelerating mixed precision rocWMMA is released as a header library and includes test and sample projects to validate and illustrate example usages of the C++ API. GEMM matrix multiplication is used as primary validation given the heavy precedent for the library. However, the usage portfolio is growing significantly and demonstrates different ways rocWMMA may be consumed. -For more information, refer to . +For more information, refer to +[Communication Libraries](../../../../docs/reference/gpu_libraries/communication.md). #### OpenMP Enhancements in This Release @@ -3194,7 +3210,8 @@ ROCDebugger Machine Interface (MI) extends support to lanes. The following enhan - MI varobjs are now lane-aware. -For more information, refer to the ROC Debugger User Guide at . +For more information, refer to the ROC Debugger User Guide at +{doc}`ROCgdb `. ##### Enhanced - clone-inferior Command @@ -3216,7 +3233,7 @@ This release includes support for AMD Radeon™ Pro W6800, in addition to other - Various other bug fixes and performance improvements -For more information, see +For more information, see {doc}`Documentation `. #### Checkpoint Restore Support With CRIU diff --git a/RELEASE.md b/RELEASE.md index 635ff6feb..a96f204c6 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -20,9 +20,22 @@ The release notes for the ROCm platform. ### What's New in This Release +#### HIP SDK for Windows + +AMD is pleased to announce the availability of the HIP SDK for Windows as part +of the ROCm platform. The +[HIP SDK OS and GPU support page](https://rocm.docs.amd.com/en/docs-5.5.1/release/windows_support.html) +lists the versions of Windows and GPUs validated by AMD. HIP SDK features on +Windows are described in detail in our +[What is ROCm?](https://rocm.docs.amd.com/en/docs-5.5.1/rocm.html#rocm-on-windows) +page and differs from the Linux feature set. Visit +[Quick Start](https://rocm.docs.amd.com/en/docs-5.5.1/deploy/windows/quick_start.html#) +page to get started. Known issues are tracked on +[GitHub](https://github.com/RadeonOpenCompute/ROCm/issues?q=is%3Aopen+label%3A5.5.1+label%3A%22Verified+Issue%22+label%3AWindows). + #### HIP API Change -The following HIP API is updated in the ROCm v5.5.1 release, +The following HIP API is updated in the ROCm 5.5.1 release: ##### `hipDeviceSetCacheConfig` diff --git a/docs/release/gpu_os_support.md b/docs/release/gpu_os_support.md index ff486eb80..d42ab544b 100644 --- a/docs/release/gpu_os_support.md +++ b/docs/release/gpu_os_support.md @@ -74,4 +74,4 @@ Use Driver Shipped with ROCm ## CPU Support ROCm requires CPUs that support PCIe™ Atomics. Modern CPUs after the release of -1st generation AMD Zen CPU and Intel™ Haswell support PCIe Atomics. \ No newline at end of file +1st generation AMD Zen CPU and Intel™ Haswell support PCIe Atomics. diff --git a/docs/release/windows_support.md b/docs/release/windows_support.md index 654ec0205..c1d95e134 100644 --- a/docs/release/windows_support.md +++ b/docs/release/windows_support.md @@ -28,7 +28,6 @@ AMD ROCm™ Platform supports the following Windows SKU. | AMD Radeon™ Pro W5500 | RDNA1 | gfx1012 | ❌ | ❌ | | AMD Radeon™ Pro VII | GCN5.1 | gfx906 | ❌ | ❌ | - ::: :::{tab-item} Radeon™ @@ -45,7 +44,6 @@ AMD ROCm™ Platform supports the following Windows SKU. | AMD Radeon™ RX 6700 | RDNA2 | gfx1032 | ✅ | ❌ | | AMD Radeon™ RX 6600 | RDNA2 | gfx1032 | ❌ | ❌ | - ::: :::: diff --git a/docs/rocm.md b/docs/rocm.md index 73aa378e9..415162860 100644 --- a/docs/rocm.md +++ b/docs/rocm.md @@ -29,7 +29,7 @@ Starting with ROCm 5.5, the HIP SDK brings a subset of ROCm to developers on Win The collection of features enabled on Windows is referred to as the HIP SDK. These features allow developers to use the HIP runtime, HIP math libraries and HIP Primitive libraries. The following table shows the differences -between Windows and Linux releases. +between Windows and Linux releases. |Component|Linux|Windows| |---------|-----|-------| @@ -56,10 +56,12 @@ features in subsequent revisions. The 5.5 Windows Installer collectively groups the Math and Primitives libraries. ``` + ```{note} GPU support on Windows and Linux may differ. You must refer to Windows and Linux GPU support tables separately. ``` + ```{note} HIP Ray Tracing is not distributed via ROCm in Linux. ``` diff --git a/tools/autotag/templates/rocm_changes/5.5.1.md b/tools/autotag/templates/rocm_changes/5.5.1.md index 7faaf152c..358a0a869 100644 --- a/tools/autotag/templates/rocm_changes/5.5.1.md +++ b/tools/autotag/templates/rocm_changes/5.5.1.md @@ -3,6 +3,7 @@ ### What's New in This Release #### HIP SDK for Windows + AMD is pleased to announce the availability of the HIP SDK for Windows as part of the ROCm platform. The [HIP SDK OS and GPU support page](https://rocm.docs.amd.com/en/docs-5.5.1/release/windows_support.html) @@ -16,7 +17,7 @@ page to get started. Known issues are tracked on #### HIP API Change -The following HIP API is updated in the ROCm v5.5.1 release: +The following HIP API is updated in the ROCm 5.5.1 release: ##### `hipDeviceSetCacheConfig`