add utilities to generate template repo cards#210
Conversation
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
| except Exception: | ||
| return None |
There was a problem hiding this comment.
Can raise here instead as well.
danieldk
left a comment
There was a problem hiding this comment.
Awesome! Small comment on the __init__ parsing.
|
I have addressed #210 (comment). Additionally, I have added support to log "Supported backends" and "Supported CUDA backends" when they are available through Example: https://huggingface.co/sayakpaul/example-kernels-repocard LMK your thoughts and I will start addressing the rest of the stuff. |
|
Updated a bunch of stuff and the following is a summary:
Here's how an updated kernel card looks like: https://huggingface.co/sayakpaul/example-kernels-repocard Once I have another round of feedback, I will work on the following:
LMK. |
| @@ -0,0 +1,36 @@ | |||
| from pathlib import Path | |||
There was a problem hiding this comment.
Example script. Will be removed.
As discussed internally, this PR adds utilities to easily generate template repository cards for the kernels built with
kernelsandkernel-builder.For now, the repository card contains basic info, which IMO, is sufficient for a v1. But of course, feedback is welcome.
If we run
We should expect to get an
activation.md, looking like so:Unfold
library_name: kernels
license: apache-2.0
This is the repository card of {repo_id} that has been pushed on the Hub. It was built to be used with the
kernelslibrary. This card was automatically generated.How to use
Benchmarks
[TODO: provide benchmarks if available]
Code source
[TODO: provide original code source and other relevant citations if available]
Notes
[TODO: provide additional notes about this kernel if needed]
On the Hub, this would preview much better, of course. You can preview here.
TODOs
upload-cardCLI commandexample_usage.pyscriptFrom Slack
I agree to this. I will work on it in this PR later.
@danieldk @drbh the above are some TODOs that came to mind, but the list isn't limited to that. Would love an initial review of this draft and address anything.