diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 43a0890c9..641e7513f 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,6 +9,13 @@ sphinx: formats: [htmlzip] python: - version: "3.8" install: - requirements: docs/.sphinx/requirements.txt + +build: + os: "ubuntu-20.04" + tools: + python: "3.8" + jobs: + pre_build: + - python -m sphinx -b linkcheck docs/ _build/linkcheck diff --git a/docs/.sphinx/_toc.yml.in b/docs/.sphinx/_toc.yml.in index 3042a46ec..0a9b7f50e 100644 --- a/docs/.sphinx/_toc.yml.in +++ b/docs/.sphinx/_toc.yml.in @@ -7,7 +7,6 @@ root: index subtrees: - caption: Release Info entries: - - file: release - file: release/gpu_os_support - url: https://github.com/RadeonOpenCompute/ROCm/labels/Verified%20Issue title: Known Issues @@ -16,7 +15,6 @@ subtrees: - entries: - file: release/docker_support_matrix - file: reference/framework_compatibility/framework_compatibility - - file: reference/kernel_userspace_compatibility/kernel_userspace_comp - file: release/licensing - caption: Deploy ROCm @@ -33,9 +31,6 @@ subtrees: - file: how_to/quick_start_windows title: Windows - file: deploy/docker - - file: deploy/spack - - file: deploy/build_source - - caption: APIs and Reference entries: @@ -173,7 +168,6 @@ subtrees: - caption: How to Guides entries: - - file: how_to/docker_gpu_isolation - file: how_to/deep_learning_rocm subtrees: - entries: diff --git a/docs/.sphinx/requirements.txt b/docs/.sphinx/requirements.txt index 343205363..4494dec8e 100644 --- a/docs/.sphinx/requirements.txt +++ b/docs/.sphinx/requirements.txt @@ -1,8 +1,8 @@ # -# 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 requirements.in +# pip-compile .sphinx/requirements.in # accessible-pygments==0.0.3 # via pydata-sphinx-theme @@ -187,7 +187,7 @@ requests==2.28.1 # pygithub # sphinx rocm-docs-core==0.6.0 - # via -r requirements.in + # via -r .sphinx/requirements.in six==1.16.0 # via # asttokens diff --git a/docs/conf.py b/docs/conf.py index 319d4223d..29bcb958b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -9,6 +9,37 @@ shutil.copy2('../CONTRIBUTING.md','./contributing.md') from rocm_docs import ROCmDocs +# working anchors that linkcheck cannot find +linkcheck_anchors_ignore = [ + 'd90e61', + 'd1667e113', + 'd2999e60', + 'building-from-source', + 'use-the-rocm-build-tool-rbuild', + 'use-cmake-to-build-migraphx', + 'example' +] +linkcheck_ignore = [ + # site to be built + "https://rocmdocs.amd.com/projects/ROCmCC/en/latest/", + "https://rocmdocs.amd.com/projects/RVS/en/latest/", + "https://rocmdocs.amd.com/projects/amdsmi/en/latest/", + "https://rocmdocs.amd.com/projects/rdc/en/latest/", + "https://rocmdocs.amd.com/projects/rocmsmi/en/latest/", + "https://rocmdocs.amd.com/projects/roctracer/en/latest/", + "https://rocmdocs.amd.com/projects/MIGraphX/en/latest/", + "https://rocmdocs.amd.com/projects/rocprofiler/en/latest/", + "https://github.com/ROCm-Developer-Tools/HIP-VS/blob/master/README.md", + "https://rocmdocs.amd.com/projects/HIPIFY/en/develop/", + # correct links that linkcheck times out on + r"https://www.amd.com/system/files/.*.pdf", + "https://www.amd.com/en/developer/aocc.html", + "https://www.amd.com/en/support/linux-drivers", + "https://www.amd.com/en/technologies/infinity-hub", + r"https://bitbucket.org/icl/magma/*", + "http://cs231n.stanford.edu/" +] + docs_core = ROCmDocs("ROCm Docs 5.6.0 Alpha") docs_core.setup() docs_core.disable_main_doc_link() diff --git a/docs/data/framework_compatibility/with_pytorch.png b/docs/data/framework_compatibility/with_pytorch.png new file mode 100644 index 000000000..dd5595b80 Binary files /dev/null and b/docs/data/framework_compatibility/with_pytorch.png differ diff --git a/docs/data/framework_compatibility/with_tensorflow.png b/docs/data/framework_compatibility/with_tensorflow.png new file mode 100644 index 000000000..3a9ebd66e Binary files /dev/null and b/docs/data/framework_compatibility/with_tensorflow.png differ diff --git a/docs/deploy.md b/docs/deploy.md index dc89860a2..280a4485d 100644 --- a/docs/deploy.md +++ b/docs/deploy.md @@ -21,7 +21,7 @@ Docker ^^^ - [Guide](deploy/docker) -- [Dockerhub](https://hub.docker.com/u/rocm/#!) +- [Dockerhub](https://hub.docker.com/u/rocm/) :::: diff --git a/docs/deploy/build_source.md b/docs/deploy/build_source.md deleted file mode 100644 index 43dc7a747..000000000 --- a/docs/deploy/build_source.md +++ /dev/null @@ -1 +0,0 @@ -# Build from Source diff --git a/docs/deploy/spack.md b/docs/deploy/spack.md deleted file mode 100644 index 483ec4f9b..000000000 --- a/docs/deploy/spack.md +++ /dev/null @@ -1 +0,0 @@ -# Spack diff --git a/docs/how_to/docker_gpu_isolation.md b/docs/how_to/docker_gpu_isolation.md deleted file mode 100644 index 1f861651d..000000000 --- a/docs/how_to/docker_gpu_isolation.md +++ /dev/null @@ -1,5 +0,0 @@ -# Docker GPU Isolation Techniques - -## GPU Passthrough - -## Environment Variable diff --git a/docs/how_to/pytorch_install/pytorch_install.md b/docs/how_to/pytorch_install/pytorch_install.md index c3124725b..a08cd5d78 100644 --- a/docs/how_to/pytorch_install/pytorch_install.md +++ b/docs/how_to/pytorch_install/pytorch_install.md @@ -63,7 +63,7 @@ and choose the "ROCm" compute platform. {numref}`Installation-Matrix-from-Pytorc --- align: center --- -Installation Matrix from Pytorch.org +Installation Matrix from Pytorch ``` To install PyTorch using the wheels package, follow these installation steps: diff --git a/docs/how_to/system_debugging.md b/docs/how_to/system_debugging.md index c45f343e6..c1db17e43 100644 --- a/docs/how_to/system_debugging.md +++ b/docs/how_to/system_debugging.md @@ -1,3 +1,68 @@ # System Debugging Guide -Pull from +## ROCm Language and System Level Debug, Flags, and Environment Variables + +Kernel options to avoid: the Ethernet port getting renamed every time you change graphics cards, `net.ifnames=0 biosdevname=0` + +## ROCr Error Code + +- 2 Invalid Dimension + +- 4 Invalid Group Memory + +- 8 Invalid (or Null) Code + +- 32 Invalid Format + +- 64 Group is too large + +- 128 Out of VGPRs + +- 0x80000000 Debug Options + +## Command to Dump Firmware Version and Get Linux Kernel Version + +`sudo cat /sys/kernel/debug/dri/1/amdgpu_firmware_info` + +`uname -a` + +## Debug Flags + +Debug messages when developing/debugging base ROCm driver. You could enable the printing from `libhsakmt.so` by setting an environment variable, `HSAKMT_DEBUG_LEVEL`. Available debug levels are 3-7. The higher level you set, the more messages will print. + +- `export HSAKMT_DEBUG_LEVEL=3` : Only pr_err() prints. + +- `export HSAKMT_DEBUG_LEVEL=4` : pr_err() and pr_warn() print. + +- `export HSAKMT_DEBUG_LEVEL=5` : We currently do not implement “notice”. Setting to 5 is same as setting to 4. + +- `export HSAKMT_DEBUG_LEVEL=6` : pr_err(), pr_warn(), and pr_info print. + +- `export HSAKMT_DEBUG_LEVEL=7` : Everything including pr_debug prints. + +## ROCr Level Environment Variables for Debug + +`HSA_ENABLE_SDMA=0` + +`HSA_ENABLE_INTERRUPT=0` + +`HSA_SVM_GUARD_PAGES=0` + +`HSA_DISABLE_CACHE=1` + +## Turn Off Page Retry on GFX9/Vega Devices + +`sudo –s` + +`echo 1 > /sys/module/amdkfd/parameters/noretry` + +## HIP Environment Variables 3.x + +### OpenCL Debug Flags + +`AMD_OCL_WAIT_COMMAND=1 (0 = OFF, 1 = On)` + +## PCIe-Debug + +Refer to ROCm PCIe Debug, https://rocmdocs.amd.com/en/latest/Other_Solutions/PCIe-Debug.html#pcie-debug. +For information on how to debug and profile HIP applications, see https://rocmdocs.amd.com/projects/HIP/en/latest/how_to_guides/debugging.html diff --git a/docs/reference/all.md b/docs/reference/all.md index 5fd77c129..9a981509e 100644 --- a/docs/reference/all.md +++ b/docs/reference/all.md @@ -8,7 +8,7 @@ :::{grid-item-card} [HIP](./hip) HIP is both AMD's GPU programming language extension and the GPU runtime. -- [HIP Runtime API Manual](https://rocmdocs.amd.com/projects/hipBLAS/en/rtd/) +- [HIP Runtime API Manual](https://rocmdocs.amd.com/projects/hipBLAS/en/latest/) - [Examples](https://github.com/amd/rocm-examples/tree/develop/HIP-Basic) ::: @@ -50,8 +50,8 @@ Libraries related to AI. :::{grid-item-card} [Computer Vision](./computer_vision) Computer vision related projects. -- [MIVisionX](https://rocmdocs.amd.com/projects/MIVisionX/en/develop) -- [rocAL](https://rocmdocs.amd.com/projects/rocAL/en/develop) +- [MIVisionX](https://rocmdocs.amd.com/projects/MIVisionX/en/latest) +- [rocAL](https://rocmdocs.amd.com/projects/rocAL/en/latest) ::: diff --git a/docs/reference/framework_compatibility/framework_compatibility.md b/docs/reference/framework_compatibility/framework_compatibility.md index 9bced739f..240298bd3 100644 --- a/docs/reference/framework_compatibility/framework_compatibility.md +++ b/docs/reference/framework_compatibility/framework_compatibility.md @@ -1,8 +1,37 @@ # Framework Compatibility -Pull content from -. -Only the frameworks content. Link to kernel/user space guide. +The ROCm release supports the most recent and two prior releases of PyTorch and TensorFlow. -Also pull content from - +Legends: + +Blue: Shows compatibility tested versions + +Gray: Not tested + +![With PyTorch](../../data/framework_compatibility/with_pytorch.png) + +![With TensorFlow](../../data/framework_compatibility/with_tensorflow.png) + +## Supported Frameworks + +This section contains the latest release notes for each framework compatible with ROCm™ and Deep Learning (DL) applications. + +The ROCm 5.4 platform supports the following frameworks: + +• PyTorch v1.12.1 + +• MAGMA v2.5.4 + +• TensorFlow v2.10.0 + +### PyTorch + +For the latest release of PyTorch, refer to https://github.com/pytorch/pytorch/releases/ + +### MAGMA + +For the latest release of MAGMA, refer to https://icl.utk.edu/magma/index.html + +### TensorFlow + +For the latest release of TensorFlow, refer to https://github.com/tensorflow/tensorflow/releases diff --git a/docs/reference/gpu_libraries/fft.md b/docs/reference/gpu_libraries/fft.md index 300b6d4c9..10d70ac5a 100644 --- a/docs/reference/gpu_libraries/fft.md +++ b/docs/reference/gpu_libraries/fft.md @@ -5,21 +5,20 @@ ROCm libraries for FFT are as follows: :::::{grid} 1 1 2 2 :gutter: 1 -:::{grid-item-card} [rocFFT](https://rocmdocs.amd.com/projects/rocFFT/en/rtd/) +:::{grid-item-card} [rocFFT](https://rocmdocs.amd.com/projects/rocFFT/en/latest/) rocFFT is an AMD GPU optimized library for FFT. -- [Documentation](https://rocmdocs.amd.com/projects/rocFFT/en/rtd/) +- [Documentation](https://rocmdocs.amd.com/projects/rocFFT/en/latest/) - [Changelog](https://github.com/ROCmSoftwarePlatform/rocFFT/blob/develop/CHANGELOG.md) -- [Examples](https://github.com/amd/rocm-examples/tree/develop/Libraries/rocFFT) ::: -:::{grid-item-card} [hipFFT](https://rocmdocs.amd.com/projects/hipFFT/en/rtd/) +:::{grid-item-card} [hipFFT](https://rocmdocs.amd.com/projects/hipFFT/en/latest/) hipFFT is a compatibility layer for GPU accelerated FFT optimized for AMD GPUs using rocFFT. hipFFT allows for a common interface for other non AMD GPU FFT libraries. -- [Documentation](https://rocmdocs.amd.com/projects/hipFFT/en/rtd/) +- [Documentation](https://rocmdocs.amd.com/projects/hipFFT/en/latest/) - [Changelog](https://github.com/ROCmSoftwarePlatform/hipFFT/blob/develop/CHANGELOG.md) ::: diff --git a/docs/reference/gpu_libraries/rand.md b/docs/reference/gpu_libraries/rand.md index 52c5f935b..d8c7152b5 100644 --- a/docs/reference/gpu_libraries/rand.md +++ b/docs/reference/gpu_libraries/rand.md @@ -3,21 +3,21 @@ :::::{grid} 1 1 2 2 :gutter: 1 -:::{grid-item-card} [rocRAND](https://rocmdocs.amd.com/projects/rocRAND/en/rtd/) +:::{grid-item-card} [rocRAND](https://rocmdocs.amd.com/projects/rocRAND/en/latest/) rocRAND is an AMD GPU optimized library for pseudo-random number generators (PRNG). -- [Documentation](https://rocmdocs.amd.com/projects/rocRAND/en/rtd/) +- [Documentation](https://rocmdocs.amd.com/projects/rocRAND/en/latest/) - [Changelog](https://github.com/ROCmSoftwarePlatform/rocRAND/blob/develop/CHANGELOG.md) - [Examples](https://github.com/amd/rocm-examples/tree/develop/Libraries/rocRAND) ::: -:::{grid-item-card} [hipRAND](https://rocmdocs.amd.com/projects/hipRAND/en/rtd/) +:::{grid-item-card} [hipRAND](https://rocmdocs.amd.com/projects/hipRAND/en/latest/) hipRAND is a compatibility layer for GPU accelerated FFT optimized for AMD GPUs using rocFFT. hipFFT allows for a common interface for other non AMD GPU FFT libraries. -- [Documentation](https://rocmdocs.amd.com/projects/hipRAND/en/rtd/) +- [Documentation](https://rocmdocs.amd.com/projects/hipRAND/en/latest/) - [Changelog](https://github.com/ROCmSoftwarePlatform/hipRAND/blob/develop/CHANGELOG.md) ::: diff --git a/docs/reference/kernel_userspace_compatibility/kernel_userspace_comp.md b/docs/reference/kernel_userspace_compatibility/kernel_userspace_comp.md deleted file mode 100644 index f706b7a34..000000000 --- a/docs/reference/kernel_userspace_compatibility/kernel_userspace_comp.md +++ /dev/null @@ -1 +0,0 @@ -# Kernel User Space Compatibility Reference diff --git a/docs/reference/management_tools.md b/docs/reference/management_tools.md index 38e9872bf..848a683d8 100644 --- a/docs/reference/management_tools.md +++ b/docs/reference/management_tools.md @@ -4,11 +4,11 @@ :gutter: 1 :::{grid-item-card} [AMD SMI](https://rocmdocs.amd.com/projects/amdsmi/en/latest/) -GO AMD SMI provides GO binding for [E-SMI In-Band C library](https://github.com/amd/esmi_ib_library.git), -[ROCm SMI Library](https://github.com/RadeonOpenCompute/rocm_smi_lib.git), and any +GO AMD SMI provides GO binding for [E-SMI In-Band C library](https://github.com/amd/esmi_ib_library), +[ROCm SMI Library](https://github.com/RadeonOpenCompute/rocm_smi_lib), and any GO language application that needs to link with these libraries and call the APIs from the GO application. The GO binding are imported in the -[AMD SMI Exporter](https://github.com/amd/amd_smi_exporter.git) to export information +[AMD SMI Exporter](https://github.com/amd/amd_smi_exporter) to export information provided by the AMD E-SMI inband library and the ROCm SMI GPU library to the Prometheus server. - [Documentation](https://rocmdocs.amd.com/projects/amdsmi/en/latest/) diff --git a/docs/reference/rocmcc/rocmcc.md b/docs/reference/rocmcc/rocmcc.md index 1f5db3c9a..3085bb54c 100644 --- a/docs/reference/rocmcc/rocmcc.md +++ b/docs/reference/rocmcc/rocmcc.md @@ -121,7 +121,7 @@ the same compiler entry point, provided AMD provides high-performance compiler optimizations for Zen-based processors in AOCC. For more information, refer to -[https://developer.amd.com/amd-aocc/](https://developer.amd.com/amd-aocc/). +[https://www.amd.com/en/developer/aocc.html](https://www.amd.com/en/developer/aocc.html). #### `-famd-opt` diff --git a/docs/release.md b/docs/release.md deleted file mode 100644 index 38bf0d779..000000000 --- a/docs/release.md +++ /dev/null @@ -1 +0,0 @@ -# Release Notes diff --git a/docs/release/compatibility.md b/docs/release/compatibility.md index 9ccd656b3..f08d72fac 100644 --- a/docs/release/compatibility.md +++ b/docs/release/compatibility.md @@ -1 +1,5 @@ # Compatibility + +[Frameworks Support Matrix](docker_support_matrix.md) + +[Framework Compatibility](../reference/framework_compatibility/framework_compatibility) diff --git a/docs/release/docker_support_matrix.md b/docs/release/docker_support_matrix.md index ba67ee31c..5f5def35e 100644 --- a/docs/release/docker_support_matrix.md +++ b/docs/release/docker_support_matrix.md @@ -8,7 +8,7 @@ The software support matrices for ROCm container releases is listed. #### `Ubuntu+ rocm5.6_internal_testing +169530b` -* [ROCm5.6](http://repo.radeon.com/rocm/apt/latest/) +* [ROCm5.6](https://repo.radeon.com/rocm/apt/latest/) * [Python 3.8](https://www.python.org/downloads/release/python-380/) * [Torch 2.0.0](https://github.com/ROCmSoftwarePlatform/pytorch/tree/rocm5.6_internal_testing) * [Apex 0.1](https://github.com/ROCmSoftwarePlatform/apex/tree/v0.1) @@ -17,11 +17,11 @@ The software support matrices for ROCm container releases is listed. * [MAGMA](https://bitbucket.org/icl/magma/src/master/) * [UCX 1.10.0](https://github.com/openucx/ucx/tree/v1.10.0) * [OMPI 4.0.3](https://github.com/open-mpi/ompi/tree/v4.0.3) -* [OFED 5.4.3](http://content.mellanox.com/ofed/MLNX_OFED-5.3-1.0.5.0/MLNX_OFED_LINUX-5.3-1.0.5.0-ubuntu20.04-x86_64.tgz) +* [OFED 5.4.3](https://content.mellanox.com/ofed/MLNX_OFED-5.3-1.0.5.0/MLNX_OFED_LINUX-5.3-1.0.5.0-ubuntu20.04-x86_64.tgz) #### `CentOS7+ rocm5.6_internal_testing +169530b` -* [ROCm5.6](http://repo.radeon.com/rocm/apt/latest/) +* [ROCm5.6](https://repo.radeon.com/rocm/apt/latest/) * [Python 3.8](https://www.python.org/downloads/release/python-380/) * [Torch 2.0.0](https://github.com/ROCmSoftwarePlatform/pytorch/tree/rocm5.6_internal_testing) * [Apex 0.1](https://github.com/ROCmSoftwarePlatform/apex/tree/v0.1) @@ -31,7 +31,7 @@ The software support matrices for ROCm container releases is listed. #### `1.13 +bfeb431` -* [ROCm5.6](http://repo.radeon.com/rocm/apt/latest/) +* [ROCm5.6](https://repo.radeon.com/rocm/apt/latest/) * [Python 3.8](https://www.python.org/downloads/release/python-380/) * [Torch 1.13.1](https://github.com/ROCmSoftwarePlatform/pytorch/tree/release/1.13) * [Apex 0.1](https://github.com/ROCmSoftwarePlatform/apex/tree/v0.1) @@ -40,11 +40,11 @@ The software support matrices for ROCm container releases is listed. * [MAGMA](https://bitbucket.org/icl/magma/src/master/) * [UCX 1.10.0](https://github.com/openucx/ucx/tree/v1.10.0) * [OMPI 4.0.3](https://github.com/open-mpi/ompi/tree/v4.0.3) -* [OFED 5.4.3](http://content.mellanox.com/ofed/MLNX_OFED-5.3-1.0.5.0/MLNX_OFED_LINUX-5.3-1.0.5.0-ubuntu20.04-x86_64.tgz) +* [OFED 5.4.3](https://content.mellanox.com/ofed/MLNX_OFED-5.3-1.0.5.0/MLNX_OFED_LINUX-5.3-1.0.5.0-ubuntu20.04-x86_64.tgz) #### `1.12 +05d5d04` -* [ROCm5.6](http://repo.radeon.com/rocm/apt/latest/) +* [ROCm5.6](https://repo.radeon.com/rocm/apt/latest/) * [Python 3.8](https://www.python.org/downloads/release/python-380/) * [Torch 1.12.1](https://github.com/ROCmSoftwarePlatform/pytorch/tree/release/1.12) * [Apex 0.1](https://github.com/ROCmSoftwarePlatform/apex/tree/v0.1) @@ -53,36 +53,36 @@ The software support matrices for ROCm container releases is listed. * [MAGMA](https://bitbucket.org/icl/magma/src/master/) * [UCX 1.10.0](https://github.com/openucx/ucx/tree/v1.10.0) * [OMPI 4.0.3](https://github.com/open-mpi/ompi/tree/v4.0.3) -* [OFED 5.4.3](http://content.mellanox.com/ofed/MLNX_OFED-5.3-1.0.5.0/MLNX_OFED_LINUX-5.3-1.0.5.0-ubuntu20.04-x86_64.tgz) +* [OFED 5.4.3](https://content.mellanox.com/ofed/MLNX_OFED-5.3-1.0.5.0/MLNX_OFED_LINUX-5.3-1.0.5.0-ubuntu20.04-x86_64.tgz) ### TensorFlow #### `tensorflow_develop-upstream-QA-rocm56 +c88a9f4` -* [ROCm5.6](http://repo.radeon.com/rocm/apt/latest/) +* [ROCm5.6](https://repo.radeon.com/rocm/apt/latest/) * [Python 3.9](https://www.python.org/downloads/release/python-390/) -* `tensorflow-rocm` 2.13.0 -* [OFED 5.3](http://content.mellanox.com/ofed/MLNX_OFED-5.3-1.0.5.0/MLNX_OFED_LINUX-5.3-1.0.5.0-ubuntu20.04-x86_64.tgz) +* [tensorflow-rocm 2.13.0]() +* [OFED 5.3](https://content.mellanox.com/ofed/MLNX_OFED-5.3-1.0.5.0/MLNX_OFED_LINUX-5.3-1.0.5.0-ubuntu20.04-x86_64.tgz) * [OMPI 4.0.7](https://github.com/open-mpi/ompi/tree/v4.0.7) * [Horovod 0.27.0](https://github.com/horovod/horovod/tree/v0.27.0) * [Tensorboard 2.12.0](https://github.com/tensorflow/tensorboard/tree/2.12.0) #### `r2.11-rocm-enhanced +5be4141` -* [ROCm5.6](http://repo.radeon.com/rocm/apt/latest/) +* [ROCm5.6](https://repo.radeon.com/rocm/apt/latest/) * [Python 3.9](https://www.python.org/downloads/release/python-390/) -* `tensorflow-rocm` 2.11.0 -* [OFED 5.3](http://content.mellanox.com/ofed/MLNX_OFED-5.3-1.0.5.0/MLNX_OFED_LINUX-5.3-1.0.5.0-ubuntu20.04-x86_64.tgz) +* [tensorflow-rocm 2.11.0](https://pypi.org/project/tensorflow-rocm/2.11.0.540/) +* [OFED 5.3](https://content.mellanox.com/ofed/MLNX_OFED-5.3-1.0.5.0/MLNX_OFED_LINUX-5.3-1.0.5.0-ubuntu20.04-x86_64.tgz) * [OMPI 4.0.7](https://github.com/open-mpi/ompi/tree/v4.0.7) * [Horovod 0.27.0](https://github.com/horovod/horovod/tree/v0.27.0) * [Tensorboard 2.11.2](https://github.com/tensorflow/tensorboard/tree/2.11.2) #### `r2.10-rocm-enhanced +72789a3` -* [ROCm5.6](http://repo.radeon.com/rocm/apt/latest/) +* [ROCm5.6](https://repo.radeon.com/rocm/apt/latest/) * [Python 3.9](https://www.python.org/downloads/release/python-390/) -* `tensorflow-rocm` 2.10.1 -* [OFED 5.3](http://content.mellanox.com/ofed/MLNX_OFED-5.3-1.0.5.0/MLNX_OFED_LINUX-5.3-1.0.5.0-ubuntu20.04-x86_64.tgz) +* [tensorflow-rocm 2.10.1](https://pypi.org/project/tensorflow-rocm/2.10.1.540/) +* [OFED 5.3](https://content.mellanox.com/ofed/MLNX_OFED-5.3-1.0.5.0/MLNX_OFED_LINUX-5.3-1.0.5.0-ubuntu20.04-x86_64.tgz) * [OMPI 4.0.7](https://github.com/open-mpi/ompi/tree/v4.0.7) * [Horovod 0.27.0](https://github.com/horovod/horovod/tree/v0.27.0) * [Tensorboard 2.10.1](https://github.com/tensorflow/tensorboard/tree/2.10.1) diff --git a/docs/release/licensing.md b/docs/release/licensing.md index eefa7a8c3..100d03ef3 100644 --- a/docs/release/licensing.md +++ b/docs/release/licensing.md @@ -25,9 +25,9 @@ The table is ordered to follow ROCm's manifest file. | [hipamd](https://github.com/ROCm-Developer-Tools/hipamd/) | [MIT](https://github.com/ROCm-Developer-Tools/hipamd/blob/develop/LICENSE.txt) | | [ROCclr](https://github.com/ROCm-Developer-Tools/ROCclr/) | [MIT](https://github.com/ROCm-Developer-Tools/ROCclr/blob/develop/LICENSE.txt) | | [HIPIFY](https://github.com/ROCm-Developer-Tools/HIPIFY/) | [MIT](https://github.com/ROCm-Developer-Tools/HIPIFY/blob/amd-staging/LICENSE.txt) | -| [HIPCC](https://github.com/ROCm-Developer-Tools/HIPCC/blob/) | [MIT](https://github.com/ROCm-Developer-Tools/HIPCC/blob/develop/LICENSE.txt) | +| [HIPCC](https://github.com/ROCm-Developer-Tools/HIPCC/blob/develop/LICENSE.txt) | [MIT](https://github.com/ROCm-Developer-Tools/HIPCC/blob/develop/LICENSE.txt) | | [llvm-project](https://github.com/ROCm-Developer-Tools/llvm-project/) | [Apache](https://github.com/ROCm-Developer-Tools/llvm-project/blob/main/LICENSE.TXT) | -| rocm-llvm-alt | [AMD Proprietary License](https://www.amd.com/en/support/gpu-pro-eula) +| rocm-llvm-alt | [AMD Proprietary License]() | [ROCm-Device-Libs](https://github.com/RadeonOpenCompute/ROCm-Device-Libs/) | [The University of Illinois/NCSA](https://github.com/RadeonOpenCompute/ROCm-Device-Libs/blob/amd-stg-open/LICENSE.TXT) | | [atmi](https://github.com/RadeonOpenCompute/atmi/) | [MIT](https://github.com/RadeonOpenCompute/atmi/blob/master/LICENSE.txt) | | [ROCm-CompilerSupport](https://github.com/RadeonOpenCompute/ROCm-CompilerSupport/) | [The University of Illinois/NCSA](https://github.com/RadeonOpenCompute/ROCm-CompilerSupport/blob/amd-stg-open/LICENSE.txt) | @@ -65,8 +65,8 @@ The table is ordered to follow ROCm's manifest file. | [flang](https://github.com/ROCm-Developer-Tools/flang/) | [Apache 2.0](https://github.com/ROCm-Developer-Tools/flang/blob/master/LICENSE.txt) | Open sourced ROCm components are released via public GitHub -repositories, packages on repo.radeon.com and other distribution channels. -Proprietary products are only available on repo.radeon.com. Currently, only +repositories, packages on https://repo.radeon.com and other distribution channels. +Proprietary products are only available on https://repo.radeon.com. Currently, only one component of ROCm, rocm-llvm-alt is governed by a proprietary license. Proprietary components are organized in a proprietary subdirectory in the package repositories to distinguish from open sourced packages. diff --git a/docs/under_construction.md b/docs/under_construction.md new file mode 100644 index 000000000..6131bf6ee --- /dev/null +++ b/docs/under_construction.md @@ -0,0 +1,5 @@ +# Under Construction + +ROCm beta documentation is not complete yet. + +Please check back again later. diff --git a/docs/understand/compiler_disambiguation.md b/docs/understand/compiler_disambiguation.md index 0d4d8adcf..30d60ba7d 100644 --- a/docs/understand/compiler_disambiguation.md +++ b/docs/understand/compiler_disambiguation.md @@ -1,4 +1,14 @@ # ROCm Compilers Disambiguation -Pull from - +The following table summarizes the widely used terms in this document. + +## Compiler Terms + +| Term | Description | +| - | - | +| `amdclang++` | Clang/LLVM-based compiler that is part of `rocm-llvm` package. The source code is available at https://github.com/RadeonOpenCompute/llvm-project. | +| AOCC | Closed-source clang-based compiler that includes additional CPU optimizations. Offered as part of ROCm via the `rocm-llvm-alt` package. See for details, https://developer.amd.com/amd-aocc/. | +| HIP-Clang | Informal term for the `amdclang++` compiler | +| HIPify | Tools including `hipify-clang` and `hipify-perl`, used to automatically translate CUDA source code into portable HIP C++. The source code is available at https://github.com/ROCm-Developer-Tools/HIPIFY | +| `hipcc` | HIP compiler driver. A utility that invokes `clang` or `nvcc` depending on the target and passes the appropriate include and library options for the target compiler and HIP infrastructure. The source code is available at https://github.com/ROCm-Developer-Tools/HIPCC. | +| ROCmCC | Clang/LLVM-based compiler. ROCmCC in itself is not a binary but refers to the overall compiler. | diff --git a/docs/understand/installing_linux.md b/docs/understand/installing_linux.md index a8c82969e..9bcb1071e 100644 --- a/docs/understand/installing_linux.md +++ b/docs/understand/installing_linux.md @@ -47,8 +47,6 @@ terms of this agreement, do not install, copy or use the AQL Profiler and/or the AOCC CPU Optimizations. ``` -Access the EULA agreement at: - For the rest of the ROCm packages, you can find the licensing information at the following location: `/opt/rocm/share/doc//` diff --git a/mdlrc-style.rb b/mdlrc-style.rb index 5f20119ad..0c21f9c9d 100644 --- a/mdlrc-style.rb +++ b/mdlrc-style.rb @@ -8,10 +8,14 @@ rule 'MD029', :style => :ordered # Allow in-line HTML exclude_rule 'MD033' +exclude_rule 'MD034' + exclude_rule 'MD041' + + # False positives, see: https://github.com/markdownlint/markdownlint/issues/374 exclude_rule 'MD005' # False positives, see: https://github.com/markdownlint/markdownlint/issues/313 -exclude_rule 'MD007' \ No newline at end of file +exclude_rule 'MD007'