Kernels

Upload README.md with huggingface_hub

#1
by sayakpaul HF Staff - opened
Files changed (1) hide show
  1. README.md +45 -0
README.md ADDED
@@ -0,0 +1,45 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ library_name: kernels
3
+ license: apache-2.0
4
+ ---
5
+
6
+ <!-- This model card has automatically been generated. You
7
+ should probably proofread and complete it, then remove this comment. -->
8
+
9
+
10
+ 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.
11
+
12
+
13
+ ## How to use
14
+
15
+ ```python
16
+ # make sure `kernels` is installed: `pip install -U kernels`
17
+ from kernels import get_kernel
18
+
19
+ kernel_module = get_kernel("kernels-community/liger-kernels") # <- change the ID if needed
20
+ layers = kernel_module.layers
21
+
22
+ layers(...)
23
+ ```
24
+
25
+ ## Available functions
26
+
27
+ - `layers`
28
+
29
+ ## Supported backends
30
+
31
+ - cuda
32
+ - rocm
33
+ - xpu
34
+
35
+ ## Benchmarks
36
+
37
+ [TODO: provide benchmarks if available]
38
+
39
+ ## Source code
40
+
41
+ [TODO: provide original source code and other relevant citations if available]
42
+
43
+ ## Notes
44
+
45
+ [TODO: provide additional notes about this kernel if needed]