From f937a452750483571edc910eec89f102e762a309 Mon Sep 17 00:00:00 2001 From: Torre Zuk Date: Mon, 28 Mar 2022 13:28:16 -0600 Subject: [PATCH] new usage --- README.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 449ba8cd..3672a797 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,14 @@ # rocBLAS-Examples -Examples for using rocBLAS (Radeon Open Compute Basic Linear Algebra Subprograms) which is a GPU exploiting implementation of BLAS. +Examples for using rocBLAS (Radeon Open Compute Basic Linear Algebra Subprograms) which is a GPU exploiting implementation of BLAS. # rocBLAS -rocBLAS is AMD's library for [BLAS](http://www.netlib.org/blas/) on [ROCm](https://rocm.github.io/install.html). -It is implemented in the [HIP](https://github.com/ROCm-Developer-Tools/HIP) +rocBLAS is AMD's library for [BLAS](http://www.netlib.org/blas/) on [ROCmTM](https://rocm.github.io/install.html). +It is implemented in the [HIP](https://github.com/ROCm-Developer-Tools/HIP) programming language and optimized for AMD's GPUs. |Acronym | Expansion | |-------------|-------------------------------------------------------------| |**BLAS** | **B**asic **L**inear **A**lgebra **S**ubprograms | -|**ROCm** | **R**adeon **O**pen **C**ompute platfor**m** | |**HIP** | **H**eterogeneous-Compute **I**nterface for **P**ortability | ## Documentation @@ -17,7 +16,7 @@ Documentation for each example is contained in the README.md of each example's d The examples utilize C++ and some shared helper code which is all contained in the common directory. The design patterns used in common may be utilized but are intended to keep the focus of individual examples on the rocBLAS calling structure. ## Prerequisites -* rocBLAS and it's prerequisites +* rocBLAS and it's prerequisites * ROCm version 3.5 or later (rocBLAS version 2.22 or later) * As this repo is not tied to specific ROCm releases we recommend building against the latest release of ROCm or the master branch of rocBLAS @@ -25,7 +24,7 @@ If you require rocBLAS it is available at [https://github.com/ROCmSoftwarePlatform/rocBLAS](https://github.com/ROCmSoftwarePlatform/rocBLAS) ## Installing -This repository can be cloned into any directory where you want to build the examples. +This repository can be cloned into any directory where you want to build the examples. ## Building These examples require that you have an installation of rocBLAS on your machine. You do not require sudo or other access to build these examples which default to compile with gcc but can also use the hipcc compiler from the rocBLAS installation. The compiler must support the c++14 standard. The use of hipcc can be set by uncommenting a line in the Makefiles. The Makefiles support building against a locally built but not installed version of rocBLAS by setting the environment variable ROCBLAS_PATH, e.g. @@ -33,7 +32,7 @@ These examples require that you have an installation of rocBLAS on your machine. After cloning this repository you can build all the examples using make in the top-level directory, or run make in a sub-level directory to build a specific example: - cd Level-1/swap + cd Level-1/swap make ./swap @@ -42,5 +41,5 @@ Level-1/swap is the simplest example and is a good starting point to read over t Note when compiling with gcc we are defining both the newer -D__HIP_PLATFORM_AMD__ and the deprecated -D__HIP_PLATFORM_HCC__ to allow building against various rocm releases. ## Contributing -Additional examples should be added in the Applications directory. The directory name should indicate the application domain and examples must contain a README.md file. Additional examples may use the common code but should not modify it. +Additional examples should be added in the Applications directory. The directory name should indicate the application domain and examples must contain a README.md file. Additional examples may use the common code but should not modify it.