diff --git a/docs/index.md b/docs/index.md index fdae64c1f..d62b002e7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -23,56 +23,40 @@ Installation instructions are available from: ROCm documentation is organized into the following categories: ::::{grid} 1 2 2 2 +:gutter: 3 :class-container: rocm-doc-grid -:::{grid-item-card} -:class-card: sd-text-black -:img-top: ./data/banner-compatibility.jpg -:img-alt: Compatibility information -:padding: 2 +:::{grid-item-card} Compatibility +:class-body: rocm-card-banner rocm-hue-2 * [Compatibility matrix](./compatibility/compatibility-matrix.rst) * {doc}`Linux system requirements` * {doc}`Windows system requirements` * {doc}`Third-party support` -* {doc}`User/kernel space` -* {doc}`Docker` -* [OpenMP](./about/compatibility/openmp.md) -* {doc}`ROCm on Radeon GPUs` +* {doc}`User and kernel-space support matrix` +* {doc}`Docker image support matrix` +* {doc}`Use ROCm on Radeon GPUs` ::: -:::{grid-item-card} -:class-card: sd-text-black -:img-top: ./data/banner-howto.jpg -:img-alt: How-to documentation -:padding: 2 +:::{grid-item-card} How to +:class-body: rocm-card-banner rocm-hue-7 * [Using ROCm for AI](./how-to/rocm-for-ai/index.rst) * [Using ROCm for HPC](./how-to/rocm-for-hpc/index.rst) * [Fine-tuning LLMs and inference optimization](./how-to/llm-fine-tuning-optimization/index.rst) * [System optimization](./how-to/system-optimization/index.rst) - * [AMD Instinct MI300X](./how-to/system-optimization/mi300x.rst) - * [AMD Instinct MI300A](./how-to/system-optimization/mi300a.rst) - * [AMD Instinct MI200](./how-to/system-optimization/mi200.md) - * [AMD Instinct MI100](./how-to/system-optimization/mi100.md) - * [AMD Instinct RDNA2](./how-to/system-optimization/w6000-v620.md) * [AMD Instinct MI300X tuning guides](./how-to/tuning-guides/mi300x/index.rst) - * [System tuning](./how-to/tuning-guides/mi300x/system.rst) - * [Workload tuning](./how-to/tuning-guides/mi300x/workload.rst) * [System debugging](./how-to/system-debugging.md) -* [GPU-enabled MPI](./how-to/gpu-enabled-mpi.rst) +* [Using MPI](./how-to/gpu-enabled-mpi.rst) * [Using advanced compiler features](./conceptual/compiler-topics.md) * [Setting the number of CUs](./how-to/setting-cus) -* [GitHub examples](https://github.com/amd/rocm-examples) +* [ROCm examples](https://github.com/amd/rocm-examples) ::: -:::{grid-item-card} -:class-card: sd-text-black -:img-top: ./data/banner-conceptual.jpg -:img-alt: Conceptual documentation -:padding: 2 +:::{grid-item-card} Conceptual +:class-body: rocm-card-banner rocm-hue-8 -* [GPU architecture](./conceptual/gpu-arch.md) +* [GPU architecture overview](./conceptual/gpu-arch.md) * [GPU memory](./conceptual/gpu-memory.md) * [File structure (Linux FHS)](./conceptual/file-reorg.md) * [GPU isolation techniques](./conceptual/gpu-isolation.md) @@ -83,21 +67,12 @@ ROCm documentation is organized into the following categories: ::: -:::{grid-item-card} -:class-card: sd-text-black -:img-top: ./data/banner-reference.jpg -:img-alt: Reference documentation -:padding: 2 +:::{grid-item-card} Reference +:class-body: rocm-card-banner rocm-hue-6 -* [Libraries](./reference/api-libraries.md) - * [Artificial intelligence](#artificial-intelligence-apis) - * [C++ primitives](#cpp-primitives) - * [Communication](#communication-libraries) - * [Math](#math-apis) - * [Random number generators](#random-number-apis) - * [HIP runtime](#hip-runtime) -* [ROCm tools and compilers](./reference/rocm-tools.md) -* [GPU hardware specifications](./reference/gpu-arch-specs.rst) +* [ROCm libraries](./reference/api-libraries.md) +* [ROCm tools, compilers, and runtimes](./reference/rocm-tools.md) +* [Accelerator and GPU hardware specifications](./reference/gpu-arch-specs.rst) * [Precision support](./reference/precision-support.rst) ::: diff --git a/docs/reference/api-libraries.md b/docs/reference/api-libraries.md index c580059fb..fb11b7a54 100644 --- a/docs/reference/api-libraries.md +++ b/docs/reference/api-libraries.md @@ -9,15 +9,13 @@ # ROCm libraries ::::{grid} 1 2 2 2 +:gutter: 3 :class-container: rocm-doc-grid (artificial-intelligence-apis)= -:::{grid-item-card} -:class-card: sd-text-black -:img-top: ../data/reference/banner-ai.jpg -:img-alt: Artificial intelligence APIs -:padding: 2 +:::{grid-item-card} Machine Learning and Computer Vision +:class-body: rocm-card-banner rocm-hue-3 * {doc}`Composable Kernel ` * {doc}`MIGraphX ` @@ -31,11 +29,8 @@ (cpp-primitives)= -:::{grid-item-card} -:class-card: sd-text-black -:img-top: ../data/reference/banner-cpp-primitives.jpg -:img-alt: C++ primitives -:padding: 2 +:::{grid-item-card} Primitives +:class-body: rocm-card-banner rocm-hue-12 * {doc}`hipCUB ` * {doc}`hipTensor ` @@ -45,40 +40,23 @@ (communication-libraries)= -:::{grid-item-card} -:class-card: sd-text-black -:img-top: ../data/reference/banner-communication.jpg -:img-alt: Communication APIs -:padding: 2 +:::{grid-item-card} Communication +:class-body: rocm-card-banner rocm-hue-7 * {doc}`RCCL ` ::: -(hip-runtime)= - -:::{grid-item-card} -:class-card: sd-text-black -:img-top: ../data/reference/banner-hip.jpg -:img-alt: HIP APIs -:padding: 2 - -* {doc}`HIP runtime ` -* {doc}`HIPIFY ` -::: - (math-apis)= -:::{grid-item-card} -:class-card: sd-text-black -:img-top: ../data/reference/banner-math.jpg -:img-alt: Math APIs -:padding: 2 +:::{grid-item-card} Math +:class-body: rocm-card-banner rocm-hue-6 * [half](https://github.com/ROCm/half) * {doc}`hipBLAS ` / {doc}`rocBLAS ` * {doc}`hipBLASLt ` * {doc}`hipFFT ` / {doc}`rocFFT ` * {doc}`hipfort ` +* {doc}`hipRAND ` / {doc}`rocRAND ` * {doc}`hipSOLVER ` / {doc}`rocSOLVER ` * {doc}`hipSPARSE ` / {doc}`rocSPARSE ` * {doc}`hipSPARSELt ` @@ -87,16 +65,4 @@ * [Tensile](https://github.com/ROCm/Tensile) ::: -(random-number-apis)= - -:::{grid-item-card} -:class-card: sd-text-black -:img-top: ../data/reference/banner-random-number.jpg -:img-alt: Random number APIs -:padding: 2 - -* {doc}`hipRAND ` -* {doc}`rocRAND ` -::: - :::: diff --git a/docs/reference/rocm-tools.md b/docs/reference/rocm-tools.md index 0e332b774..fca21b892 100644 --- a/docs/reference/rocm-tools.md +++ b/docs/reference/rocm-tools.md @@ -9,15 +9,13 @@ # ROCm tools, compilers, and runtimes ::::{grid} 1 2 2 2 +:gutter: 3 :class-container: rocm-doc-grid (system-tools)= -:::{grid-item-card} -:class-card: sd-text-black -:img-top: ../data/reference/banner-system.jpg -:img-alt: System tools -:padding: 2 +:::{grid-item-card} System Management +:class-body: rocm-card-banner rocm-hue-1 * {doc}`AMD SMI ` * {doc}`ROCm Data Center Tool ` @@ -28,11 +26,8 @@ (performance-tools)= -:::{grid-item-card} -:class-card: sd-text-black -:img-top: ../data/reference/banner-performance.jpg -:img-alt: Performance tools -:padding: 2 +:::{grid-item-card} Performance +:class-body: rocm-card-banner rocm-hue-6 * {doc}`Omniperf ` * {doc}`Omnitrace ` @@ -44,11 +39,8 @@ (development-tools)= -:::{grid-item-card} -:class-card: sd-text-black -:img-top: ../data/reference/banner-development.jpg -:img-alt: Development tools -:padding: 2 +:::{grid-item-card} Development +:class-body: rocm-card-banner rocm-hue-1 * {doc}`ROCm CMake ` * {doc}`HIPIFY ` @@ -59,11 +51,8 @@ (compilers)= -:::{grid-item-card} -:class-card: sd-text-black -:img-top: ../data/reference/banner-compilers.jpg -:img-alt: Compilers -:padding: 2 +:::{grid-item-card} Compilers +:class-body: rocm-card-banner rocm-hue-8 * {doc}`ROCm Compilers ` * {doc}`HIPCC ` @@ -72,11 +61,8 @@ (runtimes)= -:::{grid-item-card} -:class-card: sd-text-black -:img-top: ../data/reference/banner-runtimes.jpg -:img-alt: Runtimes -:padding: 2 +:::{grid-item-card} Runtimes +:class-body: rocm-card-banner rocm-hue-12 * {doc}`AMD Common Language Runtime (CLR) ` * {doc}`HIP ` diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in index 7436bc39f..2fa739e0c 100644 --- a/docs/sphinx/_toc.yml.in +++ b/docs/sphinx/_toc.yml.in @@ -100,11 +100,17 @@ subtrees: - file: compatibility/compatibility-matrix.rst title: Compatibility matrix - url: https://rocm.docs.amd.com/projects/install-on-linux/en/${branch}/reference/system-requirements.html - title: Linux + title: Linux system requirements - url: https://rocm.docs.amd.com/projects/install-on-windows/en/${branch}/reference/system-requirements.html - title: Windows + title: Windows system requirements - url: https://rocm.docs.amd.com/projects/install-on-linux/en/${branch}/reference/3rd-party-support-matrix.html - title: Third-party + title: Third-party support + - url: https://rocm.docs.amd.com/projects/install-on-linux/en/latest/reference/user-kernel-space-compat-matrix.html + title: User and kernel-space support matrix + - url: https://rocm.docs.amd.com/projects/install-on-linux/en/latest/reference/docker-image-support-matrix.html + title: Docker image support matrix + - url: https://rocm.docs.amd.com/projects/radeon/en/latest/index.html + title: Use ROCm on Radeon GPUs - caption: Conceptual entries: diff --git a/docs/sphinx/requirements.in b/docs/sphinx/requirements.in index e3612a9c1..b41fb7c38 100644 --- a/docs/sphinx/requirements.in +++ b/docs/sphinx/requirements.in @@ -1,2 +1,2 @@ -rocm-docs-core==1.6.2 +rocm-docs-core==1.7.1 sphinx-reredirects diff --git a/docs/sphinx/requirements.txt b/docs/sphinx/requirements.txt index eb8347285..ab33f991f 100644 --- a/docs/sphinx/requirements.txt +++ b/docs/sphinx/requirements.txt @@ -92,7 +92,7 @@ requests==2.32.3 # via # pygithub # sphinx -rocm-docs-core==1.6.2 +rocm-docs-core==1.7.1 # via -r requirements.in smmap==5.0.1 # via gitdb diff --git a/docs/temp/conceptual-index.md b/docs/temp/conceptual-index.md deleted file mode 100644 index c18e53ae4..000000000 --- a/docs/temp/conceptual-index.md +++ /dev/null @@ -1,54 +0,0 @@ -# Conceptual documentation - -:::::{grid} 1 1 2 2 -:gutter: 1 - -:::{grid-item-card} -**[Compiler nomenclature](./compiler-disambiguation.md)** - -ROCm ships multiple compilers of varying origins and purposes. This article -disambiguates compiler naming used throughout the documentation. - -::: - -:::{grid-item-card} -**[Using CMake](./cmake-packages.rst)** - -ROCm components ship with 1st party CMake support. This article details how that -support works and how to use it. - -::: - -:::{grid-item-card} -**[Linux folder structure reorganization](./file-reorg.md)** - -ROCm™ packages have adopted the Linux foundation file system hierarchy standard -to ensure ROCm components follow open source conventions for Linux-based -distributions. - -::: - -:::{grid-item-card} -**[GPU isolation techniques](./gpu-isolation.md)** - -Restricting the access of applications to a subset of GPUs, aka isolating GPUs -allows users to hide GPU resources from programs. - -::: - -:::{grid-item-card} -**[GPU architectures](./gpu-arch.md)** - -AMD documentation around architectural details from both the CDNA and RDNA -product lines. - -::: - -:::{grid-item-card} -**[GPU memory](./gpu-memory.md)** - -Learn about the different types of memory allocations. - -::: - -::::: diff --git a/docs/temp/gpu_libraries.md b/docs/temp/gpu_libraries.md deleted file mode 100644 index bc41ae67c..000000000 --- a/docs/temp/gpu_libraries.md +++ /dev/null @@ -1 +0,0 @@ -# GPU Libraries diff --git a/docs/temp/how-to-index.md b/docs/temp/how-to-index.md deleted file mode 100644 index 4f163d5c5..000000000 --- a/docs/temp/how-to-index.md +++ /dev/null @@ -1,34 +0,0 @@ -# How-to documentation - -:::::{grid} 1 1 2 2 -:gutter: 1 - -:::{grid-item-card} -**[Tuning guides](./tuning-guides/index.md)** - -Use case-specific system setup and tuning guides. - -::: - -:::{grid-item-card} -**[Deep-learning guide](./deep-learning-rocm.md)** - -Installation of various deep learning frameworks and applications. - -::: - -:::{grid-item-card} -**[GPU-enabled MPI](./gpu-enabled-mpi.rst)** - -This chapter exemplifies how to set up Open MPI with the ROCm platform. - -::: - -:::{grid-item-card} -**[System debugging guide](./system-debugging.md)** - -Useful commands to debug misbehaving ROCm installations. - -::: - -::::: diff --git a/docs/temp/install-index.md b/docs/temp/install-index.md deleted file mode 100644 index ba0502c63..000000000 --- a/docs/temp/install-index.md +++ /dev/null @@ -1,30 +0,0 @@ -# ROCm tutorials - -:::::{grid} 1 1 2 2 -:gutter: 1 - -:::{grid-item-card} -**[Installing ROCm](./install/index.md)** - -Learn how to install ROCm on Linux and Windows. - -::: - -:::{grid-item-card} -**[ROCm examples](https://github.com/amd/rocm-examples)** - -Sample code demonstrating the HIP API and ROCm-accelerated domain libraries. - -::: - -:::{grid-item-card} -**Artificial intelligence** - -Detailed walkthroughs of specific artificial intelligence use cases using ROCm acceleration. - -* [Implementing Inception v3 on ROCm with PyTorch](../conceptual/ai-pytorch-inception.md) -* [Optimizing inference with MIGraphX](../conceptual/ai-migraphx-optimization.md) - -::: - -::::: diff --git a/docs/temp/kernel_userspace.md b/docs/temp/kernel_userspace.md deleted file mode 100644 index 41d37e5ad..000000000 --- a/docs/temp/kernel_userspace.md +++ /dev/null @@ -1 +0,0 @@ -# Kernel and User Space Compatibility diff --git a/docs/temp/packaging_guidelines.md b/docs/temp/packaging_guidelines.md deleted file mode 100644 index d71298388..000000000 --- a/docs/temp/packaging_guidelines.md +++ /dev/null @@ -1 +0,0 @@ -# Packaging Guidelines diff --git a/docs/temp/rocm-a-z.md b/docs/temp/rocm-a-z.md deleted file mode 100644 index 91721ed66..000000000 --- a/docs/temp/rocm-a-z.md +++ /dev/null @@ -1,64 +0,0 @@ -# ROCm A-Z - -:::{table} -:name: rocm-a-z - -| ROCm product | Description | -| :---------------- | :------------ | -| [AMD Compute Language Runtimes (CLR)](https://github.com/ROCm/clr) | Contains source code for AMD's compute languages runtimes: {doc}`HIP ` and OpenCL | -| [AMDMIGraphX](https://github.com/ROCm/AMDMIGraphX/) | A graph inference engine that accelerates machine learning model inference | -| [AOMP](https://github.com/ROCm/aomp/) | A scripted build of [LLVM](https://github.com/ROCm/llvm-project) and supporting software | -| [Asynchronous Task and Memory Interface (ATMI)](https://github.com/ROCm/atmi/) | A runtime framework for efficient task management in heterogeneous CPU-GPU systems | -| [Composable Kernel](https://rocm.docs.amd.com/projects/composable_kernel/en/latest/) | A library that aims to provide a programming model for writing performance critical kernels for machine learning workloads across multiple architectures | -| [Flang](https://github.com/ROCm/flang/) | An out-of-tree Fortran compiler targeting LLVM | -| [Half-precision floating point library (half)](https://github.com/ROCm/half/) | A C++ header-only library that provides an IEEE 754 conformant, 16-bit half-precision floating-point type along with corresponding arithmetic operators, type conversions, and common mathematical functions | -| {doc}`HIP ` | AMD’s GPU programming language extension and the GPU runtime | -| [hipBLAS](https://github.com/ROCm/hipBLAS/) | A BLAS-marshaling library that supports [rocBLAS](https://rocm.docs.amd.com/projects/rocBLAS/en/latest/) and cuBLAS backends | -| [HIPCC](https://rocm.docs.amd.com/projects/HIPCC/en/latest/) | A compiler driver utility that calls Clang or NVCC and passes the appropriate include and library options for the target compiler and HIP infrastructure | -| [hipCUB](https://rocm.docs.amd.com/projects/hipCUB/en/latest/) | A thin header-only wrapper library on top of [rocPRIM](https://rocm.docs.amd.com/projects/rocPRIM/en/latest/) or CUB that allows project porting using the CUB library to the HIP layer | -| [hipFFT](https://rocm.docs.amd.com/projects/hipFFT/en/latest/) | An FFT-marshalling library that supports rocFFT or cuFFT backends | -| [hipfort](https://rocm.docs.amd.com/projects/hipfort/en/latest/) | A Fortran interface library for accessing GPU Kernels | -| {doc}`HIPIFY ` | A set of tools for translating CUDA source code into portable HIP C++ | -| [hipify-clang](https://rocm.docs.amd.com/projects/HIPIFY/en/latest/hipify-clang.html) | A Clang-based tool for translating CUDA sources into HIP sources | -| [hipify-perl](https://rocm.docs.amd.com/projects/HIPIFY/en/latest/hipify-perl.html) | An autogenerated, perl-based script that translates CUDA source code into portable HIP C++ | -| [hipSOLVER](https://rocm.docs.amd.com/projects/hipSOLVER/en/latest/) | A LAPACK-marshalling library that supports [rocSOLVER](https://rocm.docs.amd.com/projects/rocSOLVER/en/latest/) and cuSOLVER backends | -| [hipSPARSE](https://rocm.docs.amd.com/projects/hipSPARSE/en/latest/) | A SPARSE-marshalling library that supports [rocSPARSE](https://rocm.docs.amd.com/projects/rocSPARSE/en/latest/) and cuSPARSE backends | -| [hipTensor](https://github.com/ROCm/hipTensor) | AMD's C++ library for accelerating tensor primitives based on the composable kernel library | -| [LLVM](https://github.com/ROCm/llvm-project) | A toolkit for the construction of highly optimized compilers, optimizers, and run-time environments | -| [MIGraphX](https://rocm.docs.amd.com/projects/AMDMIGraphX/en/latest/) | A graph inference engine that accelerates machine learning model inference | -| [MIOpen](https://rocm.docs.amd.com/projects/MIOpen/en/latest/) | An open source deep-learning library | -| [MIOpenGEMM](https://github.com/ROCm/MIOpenGEMM) | An OpenCL general matrix multiplication (GEMM) API and kernel generator | -| [MIOpenTensile](https://github.com/ROCm/MIOpenTensile) | Provides host-callable interfaces to Tensile library | -| [MIVisionX](https://rocm.docs.amd.com/projects/MIVisionX/en/latest/doxygen/html/index.html) | A set of comprehensive computer vision and machine learning libraries, utilities, and applications | -| [Radeon Compute Profiler (RCP)](https://github.com/GPUOpen-Tools/radeon_compute_profiler/) | A performance analysis tool that gathers data from the API run-time and GPU for OpenCL and ROCm/HSA applications | -| [RCCL](https://rocm.docs.amd.com/projects/rccl/en/latest/) | A standalone library that provides multi-GPU and multi-node collective communication primitives | -| [rocAL](https://rocm.docs.amd.com/projects/rocAL/en/latest/doxygen/html/index.html) | An augmentation library designed to decode and process images and videos | -| [rocALUTION](https://rocm.docs.amd.com/projects/rocALUTION/en/latest/) | A sparse linear algebra library for exploring fine-grained parallelism on ROCm runtime and toolchains | -| [RocBandwidthTest](https://github.com/ROCm/rocm_bandwidth_test/) | Captures the performance characteristics of buffer copying and kernel read/write operations | -| [rocBLAS](https://rocm.docs.amd.com/projects/rocBLAS/en/latest/)| A BLAS implementation (in the HIP programming language) on the ROCm runtime and toolchains | -| [rocFFT](https://rocm.docs.amd.com/projects/rocFFT/en/latest/) | A software library for computing fast Fourier transforms (FFTs) written in HIP | -| [ROCK-Kernel-Driver](https://github.com/ROCm/ROCK-Kernel-Driver/) | An AMDGPU Driver with KFD that is used by ROCm | -| [ROCm Augmentation Library (rocAL)](https://rocm.docs.amd.com/projects/rocAL/en/latest/doxygen/html/index.html) | An augmentation library designed to decode and process images and videos | -| [ROCmCC](https://rocm.docs.amd.com/en/latest/reference/rocmcc/rocmcc.html) | A Clang/LLVM-based compiler | -| [ROCm cmake](https://github.com/ROCm/rocm-cmake) | A collection of CMake modules for common build and development tasks | -| [ROCm Data Center Tool](https://rocm.docs.amd.com/projects/rdc/en/latest/) | Simplifies administration and addresses key infrastructure challenges in AMD GPUs in cluster and data-center environments | -| [ROCm Debug Agent Library (ROCdebug-agent)](https://github.com/ROCm/rocr_debug_agent/) | A library that can print the state of all AMD GPU wavefronts that caused a queue error by sending a SIGQUIT signal to the process while the program is running | -| [ROCm Debugger (ROCgdb)](https://rocm.docs.amd.com/projects/ROCgdb/en/latest/) | A source-level debugger for Linux, based on the GNU Debugger (GDB) | -| [ROCm Debugger API (ROCdbgapi)](https://rocm.docs.amd.com/projects/ROCdbgapi/en/latest/) | The ROCm debugger library | -| [rocminfo](https://github.com/ROCm/rocminfo/) | Reports system information | -| [ROCm SMI](https://github.com/ROCm/rocm_smi_lib/) | A C library for Linux that provides a user space interface for applications to monitor and control GPU applications | -| [ROCm Validation Suite](https://rocm.docs.amd.com/projects/ROCmValidationSuite/en/latest/) | A tool for detecting and troubleshooting common problems affecting AMD GPUs running in a high-performance computing environment | -| [rocPRIM](https://rocm.docs.amd.com/projects/rocPRIM/en/latest/) | A header-only library for HIP parallel primitives | -| [ROCProfiler](https://rocm.docs.amd.com/projects/rocprofiler/en/latest/profiler_home_page.html) | A profiling tool for HIP applications | -| [rocRAND](https://rocm.docs.amd.com/projects/rocRAND/en/latest/) | Provides functions that generate pseudorandom and quasirandom numbers | -| [ROCR-Runtime](https://github.com/ROCm/ROCR-Runtime/) | User-mode API interfaces and libraries necessary for host applications to launch compute kernels on available HSA ROCm kernel agents | -| [rocSOLVER](https://rocm.docs.amd.com/projects/rocSOLVER/en/latest/) | An implementation of LAPACK routines on the ROCm platform, implemented in the HIP programming language and optimized for AMD’s latest discrete GPUs | -| [rocSPARSE](https://rocm.docs.amd.com/projects/rocSPARSE/en/latest/) | Exposes a common interface that provides BLAS for sparse computation implemented on ROCm runtime and toolchains (in the HIP programming language) | -| [rocThrust](https://rocm.docs.amd.com/projects/rocThrust/en/latest/) | A parallel algorithm library | -| [ROCT-Thunk-Interface](https://github.com/ROCm/ROCT-Thunk-Interface/) | User-mode API interfaces used to interact with the ROCk driver | -| [ROCTracer](https://rocm.docs.amd.com/projects/roctracer/en/latest/) | Intercepts runtime API calls and traces asynchronous activity | -| [rocWMMA](https://rocm.docs.amd.com/projects/rocWMMA/en/latest/index.html) | A C++ library for accelerating mixed-precision matrix multiply-accumulate (MMA) operations | -| [Tensile](https://github.com/ROCm/Tensile) | A tool for creating benchmark-driven backend libraries for GEMMs, GEMM-like problems, and general N-dimensional tensor contractions | -| [TransferBench](https://rocm.docs.amd.com/projects/TransferBench/en/latest/) | A utility to benchmark simultaneous transfers between user-specified devices (CPUs/GPUs) | - -::: diff --git a/docs/temp/troubleshooting.md b/docs/temp/troubleshooting.md deleted file mode 100644 index 5234ee939..000000000 --- a/docs/temp/troubleshooting.md +++ /dev/null @@ -1,50 +0,0 @@ -# Troubleshooting - -**Q: What do I do if I get this error when trying to run PyTorch:** - -```bash -hipErrorNoBinaryForGPU: Unable to find code object for all current devices! -``` - -Ans: The error denotes that the installation of PyTorch and/or other -dependencies or libraries do not support the current GPU. - -**Workaround:** - -To implement a workaround, follow these steps: - -1. Confirm that the hardware supports the ROCm stack. Refer to -{ref}`linux-support` and {ref}`windows-support`. - -2. Determine the gfx target. - - ```bash - rocminfo | grep gfx - ``` - -3. Check if PyTorch is compiled with the correct gfx target. - - ```bash - TORCHDIR=$( dirname $( python3 -c 'import torch; print(torch.__file__)' ) ) - roc-obj-ls -v $TORCHDIR/lib/libtorch_hip.so # check for gfx target - ``` - -:::{note} - Recompile PyTorch with the right gfx target if compiling from the source if - the hardware is not supported. For wheels or Docker installation, contact - ROCm support [^ROCm_issues]. -::: - -**Q: Why am I unable to access Docker or GPU in user accounts?** - -Ans: Ensure that the user is added to docker, video, and render Linux groups as -described in the ROCm Installation Guide at {ref}`linux_group_permissions`. - -**Q: Can I install PyTorch directly on bare metal?** - -Ans: Bare-metal installation of PyTorch is supported through wheels. Refer to -Option 2: Install PyTorch Using Wheels Package. See {doc}`PyTorch for ROCm` for more information. - -**Q: How do I profile PyTorch workloads?** - -Ans: Use the PyTorch Profiler to profile GPU kernels on ROCm.