Upload README.md with huggingface_hub

README.md

@@ -1,8 +1,53 @@
 ---
-tags:
-- kernels
-- cuda
+library_name: kernels
+license: apache-2.0
 ---
-# SageAttention
 
-This is a build of the [SageAttention](https://github.com/thu-ml/SageAttention) compatible with kernels library
+<!-- This model card has automatically been generated. You
+should probably proofread and complete it, then remove this comment. -->
+
+
+This is the repository card of {repo_id} that has been pushed on the Hub. It was built to be used with the [`kernels` library](https://github.com/huggingface/kernels). This card was automatically generated.
+
+
+## How to use
+
+```python
+# make sure `kernels` is installed: `pip install -U kernels`
+from kernels import get_kernel
+
+kernel_module = get_kernel("kernels-community/sage_attention") # <- change the ID if needed
+per_block_int8 = kernel_module.per_block_int8
+
+per_block_int8(...)
+```
+
+## Available functions
+
+- `per_block_int8`
+- `per_warp_int8`
+- `sub_mean`
+- `per_channel_fp8`
+- `sageattn`
+
+## Supported backends
+
+- cuda
+
+## CUDA Capabilities
+
+- 9.0a
+- 8.9
+- 8.0
+
+## Benchmarks
+
+[TODO: provide benchmarks if available]
+
+## Source code
+
+[TODO: provide original source code and other relevant citations if available]
+
+## Notes
+
+[TODO: provide additional notes about this kernel if needed]