Upload README.md with huggingface_hub

#1
by sayakpaul HF Staff - opened
Files changed (1) hide show
  1. README.md +40 -4
README.md CHANGED
@@ -1,8 +1,44 @@
1
  ---
2
- tags:
3
- - kernels
4
  ---
5
 
6
- # cv_utils
 
7
 
8
- This is a build for some kernel utilities for computer vision, including generic_nms and connected_components
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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/cv_utils") # <- change the ID if needed
20
+ cc_2d = kernel_module.cc_2d
21
+
22
+ cc_2d(...)
23
+ ```
24
+
25
+ ## Available functions
26
+
27
+ - `cc_2d`
28
+ - `generic_nms`
29
+
30
+ ## Supported backends
31
+
32
+ - cuda
33
+
34
+ ## Benchmarks
35
+
36
+ [TODO: provide benchmarks if available]
37
+
38
+ ## Source code
39
+
40
+ [TODO: provide original source code and other relevant citations if available]
41
+
42
+ ## Notes
43
+
44
+ [TODO: provide additional notes about this kernel if needed]