drbh HF Staff commited on
Commit
1e65f33
·
verified ·
1 Parent(s): 654fc62

Uploaded using `kernel-builder`.

Browse files
Files changed (1) hide show
  1. README.md +55 -0
README.md ADDED
@@ -0,0 +1,55 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ library_name: kernels
3
+ {% if license %}license: {{ license }}
4
+ {% endif %}---
5
+
6
+ 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.
7
+
8
+ ## How to use
9
+ {% if functions %}
10
+
11
+ ```python
12
+ # make sure `kernels` is installed: `pip install -U kernels`
13
+ from kernels import get_kernel
14
+
15
+ kernel_module = get_kernel("{{ repo_id }}")
16
+ {{ functions[0] }} = kernel_module.{{ functions[0] }}
17
+
18
+ {{ functions[0] }}(...)
19
+ ```
20
+ {% else %}
21
+
22
+ Usage example not available.
23
+ {% endif %}
24
+
25
+ ## Available functions
26
+ {% if functions %}
27
+ {% for func in functions %}
28
+ - `{{ func }}`
29
+ {% endfor %}
30
+ {% else %}
31
+
32
+ Function list not available.
33
+ {% endif %}
34
+ {% if layers %}
35
+
36
+ ## Available layers
37
+ {% for layer in layers %}
38
+ - `{{ layer }}`
39
+ {% endfor %}
40
+ {% endif %}
41
+
42
+ ## Benchmarks
43
+ {% if has_benchmark %}
44
+
45
+ Benchmarking script is available for this kernel. Run `kernels benchmark {{ repo_id }}`.
46
+ {% else %}
47
+
48
+ No benchmark available yet.
49
+ {% endif %}
50
+ {% if upstream %}
51
+
52
+ ## Source code
53
+
54
+ Source code of this kernel originally comes from {{ upstream }} and it was repurposed for compatibility with `kernels`.
55
+ {% endif %}