kernels-bot commited on
Commit
cdf508c
·
verified ·
1 Parent(s): ff0ac72

Uploaded using `kernel-builder`.

Browse files
Files changed (1) hide show
  1. README.md +15 -14
README.md CHANGED
@@ -1,25 +1,26 @@
1
  ---
 
2
  license: bsd-3-clause
3
- tags:
4
- - kernels
5
  ---
6
 
7
- ![Status](https://hubwebhook.dholtz.com/shield?repo=kernels-community/rotary)
8
 
9
- ## rotary
10
 
11
- rotary embedding kernel from [Flash Attention](https://github.com/Dao-AILab/flash-attention/tree/main/csrc/rotary).
 
 
12
 
13
- Kernel source: https://github.com/huggingface/kernels-community/tree/main/rotary
 
14
 
 
 
15
 
16
- ### Performance
 
 
17
 
18
- <img class="dark:hidden border border-gray-200 dark:border-gray-700 rounded-lg" src="media/benches_light_animation.svg" />
19
- <img class="hidden dark:block border border-gray-200 dark:border-gray-700 rounded-lg" src="media/benches_dark_animation.svg" />
20
 
21
- <img class="dark:hidden border border-gray-200 dark:border-gray-700 rounded-lg" src="media/benches_light_latency.svg" />
22
- <img class="hidden dark:block border border-gray-200 dark:border-gray-700 rounded-lg" src="media/benches_dark_latency.svg" />
23
-
24
- <img class="dark:hidden border border-gray-200 dark:border-gray-700 rounded-lg" src="media/benches_light_throughput.svg" />
25
- <img class="hidden dark:block border border-gray-200 dark:border-gray-700 rounded-lg" src="media/benches_dark_throughput.svg" />
 
1
  ---
2
+ library_name: kernels
3
  license: bsd-3-clause
 
 
4
  ---
5
 
6
+ This is the repository card of kernels-community/rotary 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.
7
 
8
+ ## How to use
9
 
10
+ ```python
11
+ # make sure `kernels` is installed: `pip install -U kernels`
12
+ from kernels import get_kernel
13
 
14
+ kernel_module = get_kernel("kernels-community/rotary")
15
+ apply_rotary = kernel_module.apply_rotary
16
 
17
+ apply_rotary(...)
18
+ ```
19
 
20
+ ## Available functions
21
+ - `apply_rotary`
22
+ - `apply_rotary_transformers`
23
 
24
+ ## Benchmarks
 
25
 
26
+ Benchmarking script is available for this kernel. Run `kernels benchmark kernels-community/rotary`.