Skip to content

Commit a5d4afd

Browse files
committed
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 9bd5027)
1 parent 9c96864 commit a5d4afd

File tree

3 files changed

+15
-2
lines changed

3 files changed

+15
-2
lines changed

.wordlist.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ GeLU
88
Gemm
99
GoogleTest
1010
hipSPARSELt
11+
html
1112
LeakyReLU
13+
myst
1214
NONINFRINGEMENT
1315
ReLU
1416
rocSPARSELt

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,12 @@ It sits between the application and a 'worker' SPARSE library, marshalling
55
inputs into the backend library and marshalling results back to the
66
application. hipSPARSELt exports an interface that does not require the client
77
to change, regardless of the chosen backend. Currently, hipSPARSELt supports
8-
[rocSPARSELt](library/src/hcc_detial/rocsparselt) and [cuSPARSELt v0.4](https://docs.nvidia.com/cuda/cusparselt)
8+
[rocSPARSELt](library/src/hcc_detial/rocsparselt) and [NVIDIA CUDA cuSPARSELt v0.4](https://docs.nvidia.com/cuda/cusparselt)
99
as backends.
1010

11+
> [!NOTE]
12+
> 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).
13+
1114
## Installing pre-built packages
1215

1316
Download pre-built packages either from the

docs/license.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1-
<!-- markdownlint-disable first-line-h1 -->
1+
---
2+
myst:
3+
html_meta:
4+
"description": "hipSPARSELt licensing information"
5+
"keywords": "hipSPARSELt, ROCm, API, documentation, license"
6+
---
7+
8+
# License
9+
210
```{include} ../LICENSE.md
311
```

0 commit comments

Comments
 (0)