From a5d4afd9efc4e6116e13daab093eeed4400b7231 Mon Sep 17 00:00:00 2001 From: Jeffrey Novotny Date: Thu, 17 Oct 2024 08:56:32 -0400 Subject: [PATCH] Add metadata and note to readme file (#158) * Add missing metadata info and append note to README file * Fix incorrect link * Fix linting errors (cherry picked from commit 9bd5027dcbdf27ee4ad0de5cc1d8d9e07b10b9c9) --- .wordlist.txt | 2 ++ README.md | 5 ++++- docs/license.md | 10 +++++++++- 3 files changed, 15 insertions(+), 2 deletions(-) diff --git a/.wordlist.txt b/.wordlist.txt index a27edba3..114631b8 100644 --- a/.wordlist.txt +++ b/.wordlist.txt @@ -8,7 +8,9 @@ GeLU Gemm GoogleTest hipSPARSELt +html LeakyReLU +myst NONINFRINGEMENT ReLU rocSPARSELt diff --git a/README.md b/README.md index 770e9985..be1fcee2 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,12 @@ It sits between the application and a 'worker' SPARSE library, marshalling inputs into the backend library and marshalling results back to the application. hipSPARSELt exports an interface that does not require the client to change, regardless of the chosen backend. Currently, hipSPARSELt supports -[rocSPARSELt](library/src/hcc_detial/rocsparselt) and [cuSPARSELt v0.4](https://docs.nvidia.com/cuda/cusparselt) +[rocSPARSELt](library/src/hcc_detial/rocsparselt) and [NVIDIA CUDA cuSPARSELt v0.4](https://docs.nvidia.com/cuda/cusparselt) as backends. +> [!NOTE] +> The published hipSPARSELt documentation is available at [hipSPARSELt](https://rocm.docs.amd.com/projects/hipSPARSELt/en/latest/index.html) in an organized, easy-to-read format, with search and a table of contents. The documentation source files reside in the hipsparselt/docs folder of this repository. As with all ROCm projects, the documentation is open source. For more information, see [Contribute to ROCm documentation](https://rocm.docs.amd.com/en/latest/contribute/contributing.html). + ## Installing pre-built packages Download pre-built packages either from the diff --git a/docs/license.md b/docs/license.md index 6b9e2c13..b79b126f 100644 --- a/docs/license.md +++ b/docs/license.md @@ -1,3 +1,11 @@ - +--- +myst: + html_meta: + "description": "hipSPARSELt licensing information" + "keywords": "hipSPARSELt, ROCm, API, documentation, license" +--- + +# License + ```{include} ../LICENSE.md ```