Skip to content

Commit

Permalink
Add metadata and note to readme file (#158)
Browse files Browse the repository at this point in the history
* Add missing metadata info and append note to README file

* Fix incorrect link

* Fix linting errors

(cherry picked from commit 9bd5027)
  • Loading branch information
amd-jnovotny committed Oct 28, 2024
1 parent 9c96864 commit a5d4afd
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 2 deletions.
2 changes: 2 additions & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ GeLU
Gemm
GoogleTest
hipSPARSELt
html
LeakyReLU
myst
NONINFRINGEMENT
ReLU
rocSPARSELt
Expand Down
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 9 additions & 1 deletion docs/license.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
<!-- markdownlint-disable first-line-h1 -->
---
myst:
html_meta:
"description": "hipSPARSELt licensing information"
"keywords": "hipSPARSELt, ROCm, API, documentation, license"
---

# License

```{include} ../LICENSE.md
```

0 comments on commit a5d4afd

Please sign in to comment.