From 9ce0845083dce20624977af8a590b10764914e5b Mon Sep 17 00:00:00 2001 From: Anders Smedegaard Pedersen Date: Sun, 1 Dec 2024 22:25:36 +0100 Subject: [PATCH] update readme.md (#117) --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 427c2b1..c462bb6 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,11 @@ # hip-rs -A rust wrapper for HIP + +[![codecov](https://codecov.io/github/smedegaard/hip-rs/branch/main/graph/badge.svg?token=2J63ET3KII)](https://codecov.io/github/smedegaard/hip-rs) + +> [!CAUTION] +> hip-rs is **not to be used** for anything else that hobby projects. + +A rust wrapper for HIP. + +> The Heterogeneous-computing Interface for Portability (HIP) API is a C++ runtime API and kernel language that lets developers create portable applications running in heterogeneous systems, using CPUs and AMD GPUs or NVIDIA GPUs from a single source code. HIP provides a simple marshalling language to access either the AMD ROCM back-end, or NVIDIA CUDA back-end, to build and run application kernels. +> — the [HIP documentation](https://rocm.docs.amd.com/projects/HIP/en/latest/what_is_hip.html)