Skip to content

Commit

Permalink
Readme Cleanup (ROCm#2037)
Browse files Browse the repository at this point in the history
  • Loading branch information
@saadrahim
saadrahim authored Apr 14, 2023
1 parent 0434279 commit 19c0ba1
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 147 deletions.
131 changes: 4 additions & 127 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
# ROCm™ Repository Updates
# AMD ROCm™

This repository contains the manifest file for ROCm™ releases, changelogs, and
release information. The file default.xml contains information for all
repositories and the associated commit used to build the current ROCm release.

The default.xml file uses the repo Manifest format.

The develop branch of this repository contains content for the next
ROCm release.

## How to build documentation via Sphinx

```bash
Expand All @@ -16,132 +19,6 @@ pip3 install -r .sphinx/requirements.txt
python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
```

## ROCm v5.4.3 Release Notes

ROCm v5.4.3 is now released. For ROCm v5.4.3 documentation, refer to
<https://docs.amd.com>.

## ROCm v5.4.2 Release Notes

ROCm v5.4.2 is now released. For ROCm v5.4.2 documentation, refer to
<https://docs.amd.com>.

## ROCm v5.4.1 Release Notes

ROCm v5.4.1 is now released. For ROCm v5.4.1 documentation, refer to
<https://docs.amd.com>.

## ROCm v5.4 Release Notes

ROCm v5.4 is now released. For ROCm v5.4 documentation, refer to
<https://docs.amd.com>.

## ROCm v5.3.3 Release Notes

ROCm v5.3.3 is now released. For ROCm v5.3.3 documentation, refer to
<https://docs.amd.com>.

## ROCm v5.3.2 Release Notes

ROCm v5.3.2 is now released. For ROCm v5.3.2 documentation, refer to
<https://docs.amd.com>.

## ROCm v5.3 Release Notes

ROCm v5.3 is now released. For ROCm v5.3 documentation, refer to
<https://docs.amd.com>.

## ROCm v5.2.3 Release Notes

The ROCm v5.2.3 patch release is now available. The details are listed below.
Highlights of this release include enhancements in RCCL version compatibility
and minor bug fixes in the HIP Runtime.

Additionally, ROCm releases will return to use of the
[ROCm](https://github.com/RadeonOpenCompute/ROCm) repository for
version-controlled release notes henceforth.

**NOTE**: This release of ROCm is validated with the AMDGPU release v22.20.1.

All users of the ROCm v5.2.1 release and below are encouraged to upgrade. Refer
to <https://docs.amd.com> for documentation associated with this release.

## Introducing Preview Support for Ubuntu 20.04.5 HWE

Refer to the following article for information on the preview support for
Ubuntu 20.04.5 HWE.

<https://www.amd.com/en/support/kb/release-notes/rn-amdgpu-unified-linux-22-20>

## Changes in This Release

### Ubuntu 18.04 End of Life

Support for Ubuntu 18.04 ends in this release. Future releases of ROCm will not
provide prebuilt packages for Ubuntu 18.04.

### HIP and Other Runtimes

#### HIP Runtime

##### Fixes

- A bug was discovered in the HIP graph capture implementation in the ROCm
v5.2.0 release. If the same kernel is called twice (with different argument
values) in a graph capture, the implementation only kept the argument values
for the second kernel call.
- A bug was introduced in the `hiprtc` implementation in the ROCm v5.2.0
release. This bug caused the `hiprtcGetLoweredName` call to fail for named
expressions with whitespace in it.

**Example:** The named expression `my_sqrt<complex<double>>` passed but
`my_sqrt<complex<double>>` failed.

### ROCm Libraries

#### RCCL

##### Added

- Compatibility with NCCL 2.12.10
- Packages for test and benchmark executables on all supported OSes using CPack
- Adding custom signal handler - opt-in with `RCCL_ENABLE_SIGNALHANDLER=1`
- Additional details provided if Binary File Descriptor library (BFD) is
pre-installed.
- Adding experimental support for using multiple ranks per device
- Requires using a new interface to create communicator
(`ncclCommInitRankMulti`), refer to the interface documentation for
details.
- To avoid potential deadlocks, user might have to set an environment
variables increasing the number of hardware queues. For example,

```cpp
export GPU_MAX_HW_QUEUES=16
```

- Adding support for reusing ports in NET/IB channels
- Opt-in with `NCCL_IB_SOCK_CLIENT_PORT_REUSE=1` and
`NCCL_IB_SOCK_SERVER_PORT_REUSE=1`
- When "`Call to bind failed: Address already in use`" error happens in
large-scale AlltoAll (for example, >=64 MI200 nodes), users are suggested
to opt-in either one or both of the options to resolve the massive port
usage issue
- Avoid using `NCCL_IB_SOCK_SERVER_PORT_REUSE` when
`NCCL_NCHANNELS_PER_NET_PEER` is tuned >1

##### Removed

- Removed experimental clique-based kernels

### Development Tools

No notable changes in this release for development tools, including the
compiler, profiler, and debugger.

### Deployment and Management Tools

No notable changes in this release for deployment and management tools.

## Older ROCm™ Releases

For release information for older ROCm™ releases, refer to
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AMD ROCm Documentation
# AMD ROCm™ Platform Documentation

Welcome to AMD ROCm's documentation!
Welcome to AMD ROCm™ Platform's documentation!

:::::{grid} 1 1 2 2
:gutter: 1
Expand Down
38 changes: 20 additions & 18 deletions docs/release/gpu_os_support.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,16 @@

## OS Support

ROCm supports the operating systems listed below.
:::{table} Supported OSes with validated kernel versions
:widths: auto
AMD ROCm™ Platform supports the operating systems listed below.

| OS | Validated Kernel |
|:------------------:|:------------------:|
| RHEL 9.1 | `5.14` |
| RHEL 8.6 to 8.7 | `4.18` |
| SLES 15 SP4 | |
| Ubuntu 20.04.5 LTS | `5.15` |
| Ubuntu 22.04.1 LTS | `5.15`, OEM `5.17` |
:::

## Virtualization Support

ROCm supports virtualization for select GPUs only as shown below.
Expand All @@ -32,11 +31,11 @@ ROCm supports virtualization for select GPUs only as shown below.
Use Driver Shipped with ROCm
| GPU | Architecture | Product | [LLVM Target](https://www.llvm.org/docs/AMDGPUUsage.html#processors) | Linux | Windows |
|:-----------------:|:---------------:|:-------:|:--------------------------------------------------------------------:|:------------------------------------:|:-----------:|
| Instinct™ MI250X | CDNA2 | Full | gfx90a | Supported | Unsupported |
| Instinct™ MI250 | CDNA2 | Full | gfx90a | Supported | Unsupported |
| Instinct™ MI210 | CDNA2 | Full | gfx90a | Supported | Unsupported |
| Instinct™ MI100 | CDNA | Full | gfx908 | Supported | Unsupported |
| Instinct™ MI50 | Vega | Full | gfx906 | Supported | Unsupported |
| AMD Instinct™ MI250X | CDNA2 | Full | gfx90a | Supported | Unsupported |
| AMD Instinct™ MI250 | CDNA2 | Full | gfx90a | Supported | Unsupported |
| AMD Instinct™ MI210 | CDNA2 | Full | gfx90a | Supported | Unsupported |
| AMD Instinct™ MI100 | CDNA | Full | gfx908 | Supported | Unsupported |
| AMD Instinct™ MI50 | Vega | Full | gfx906 | Supported | Unsupported |

:::

Expand All @@ -46,8 +45,8 @@ Use Driver Shipped with ROCm
[Use Radeon Pro Driver](https://www.amd.com/en/support/linux-drivers)
| GPU | Architecture | SW Level | [LLVM Target](https://www.llvm.org/docs/AMDGPUUsage.html#processors) | Linux | Windows |
|:-----------------:|:---------------:|:--------:|:--------------------------------------------------------------------:|:------------------------------------:|:-----------:|
| Radeon™ Pro W6800 | RDNA2 | Full | gfx1030 | Supported | Supported |
| Radeon™ Pro V620 | RDNA2 | Full | gfx1030 | Supported | Unsupported |
| AMD Radeon™ Pro W6800 | RDNA2 | Full | gfx1030 | Supported | Supported |
| AMD Radeon™ Pro V620 | RDNA2 | Full | gfx1030 | Supported | Unsupported |

:::

Expand All @@ -57,9 +56,11 @@ Use Driver Shipped with ROCm
[Use Radeon Pro Driver](https://www.amd.com/en/support/linux-drivers)
| GPU | Architecture | SW Level | [LLVM Target](https://www.llvm.org/docs/AMDGPUUsage.html#processors) | Linux | Windows |
|:------------------:|:--------------:|:----------:|:--------------------------------------------------------------------:|:------------------------------------:|:-----------:|
| Radeon™ RX 6900 XT | RDNA2 |HIP SDK | gfx1030 | Supported | Supported |
| Radeon™ RX 6600 | RDNA2 |HIP Runtime | gfx1031 | Supported | Supported |
| Radeon™ R9 Fury | Fiji |Full | gfx803 | Community | Unsupported |
| AMD Radeon™ RX 6900 XT | RDNA2 |HIP SDK | gfx1030 | Supported | Supported |
| AMD Radeon™ RX 6600 | RDNA2 |HIP Runtime | gfx1031 | Supported | Supported |
| AMD Radeon™ VII | Vega |Full | gfx906 | Supported | Unsupported |
| AMD Radeon™ R9 Fury | Fiji |Full | gfx803 | Community | Unsupported |


:::

Expand All @@ -69,14 +70,15 @@ Use Driver Shipped with ROCm

::::{tab-set}

:::{tab-item} Instinct™
:::{tab-item} AMD Instinct™
:sync: instinct

Instinct™ products support the full stack available in ROCm.
Instinct™ accelerators support the full stack available in ROCm. Instinct™
accelerators are Linux only.

:::

:::{tab-item} Radeon Pro™
:::{tab-item} AMD Radeon Pro™
:sync: radeonpro

ROCm software support varies by GPU type and Operating System. ROCm ecosystem
Expand All @@ -91,7 +93,7 @@ described below:

:::

:::{tab-item} Radeon™
:::{tab-item} AMD Radeon™
:sync: radeon
ROCm software support varies by GPU type and Operating System. ROCm ecosystem
products are three software stack enablement levels that correspond as described
Expand Down

0 comments on commit 19c0ba1

Please sign in to comment.