Add source to metadata

docs/source/builder/writing-kernels.md

@@ -190,6 +190,11 @@ The following sections enumerate all supported options for `build.toml`.
   branch named `v<version>`.
 - `backends` (required): a list of supported backends. Must be one or
   more of `cpu`, `cuda`, `metal`, `rocm`, or `xpu`.
+- `upstream`: URL of the original upstream repository where the kernel
+  source code comes from.
+- `source`: URL of the kernel-builder formatted source repository. This
+  repository must contain a `build.toml` and `flake.nix` so that it can be
+  pulled and built with the kernel builder.
 - `python-depends` (**experimental**): a list of additional Python dependencies
   that the kernel requires. The only supported dependencies are `einops`
   and `nvidia-cutlass-dsl`.

docs/source/kernel-requirements.md

@@ -71,6 +71,10 @@ metadata. Currently the following top-level keys are supported:
 - `version` (`int`, required): the kernel version number.
 - `license` (`str`, required): the kernel license in. Refer to the
   list of [supported license identifiers](https://huggingface.co/docs/hub/repositories-licenses).
+- `upstream` (`str`, optional): URL of the original upstream repository
+  where the kernel source code comes from.
+- `source` (`str`, optional): URL of the kernel-builder formatted source
+  repository (must contain `build.toml` and `flake.nix`).
 - `backend` (`dict`, required): information about the compute backend that
   this build variant supports.
 - `python-depends` (`list[str]`, optional): list of Python dependencies

examples/kernels/cutlass-gemm-tvm-ffi/CARD.md

@@ -49,8 +49,14 @@ No benchmark available yet.
 {% endif %}
 {% if upstream %}
 
-## Source code
+## Upstream
 
-Source code of this kernel originally comes from {{ upstream }} and it was repurposed for compatibility with `kernels`.
+The original source code for this kernel comes from {{ upstream }}.
+{% endif %}
+{% if source %}
+
+## Source
+
+The kernel-builder formatted source for this kernel is available at {{ source }}.
 {% endif %}
 

examples/kernels/cutlass-gemm/CARD.md

@@ -49,8 +49,14 @@ No benchmark available yet.
 {% endif %}
 {% if upstream %}
 
-## Source code
+## Upstream
 
-Source code of this kernel originally comes from {{ upstream }} and it was repurposed for compatibility with `kernels`.
+The original source code for this kernel comes from {{ upstream }}.
+{% endif %}
+{% if source %}
+
+## Source
+
+The kernel-builder formatted source for this kernel is available at {{ source }}.
 {% endif %}
 

examples/kernels/extra-data/CARD.md

@@ -49,8 +49,14 @@ No benchmark available yet.
 {% endif %}
 {% if upstream %}
 
-## Source code
+## Upstream
 
-Source code of this kernel originally comes from {{ upstream }} and it was repurposed for compatibility with `kernels`.
+The original source code for this kernel comes from {{ upstream }}.
+{% endif %}
+{% if source %}
+
+## Source
+
+The kernel-builder formatted source for this kernel is available at {{ source }}.
 {% endif %}
 

examples/kernels/relu-backprop-compile/CARD.md

@@ -49,8 +49,14 @@ No benchmark available yet.
 {% endif %}
 {% if upstream %}
 
-## Source code
+## Upstream
 
-Source code of this kernel originally comes from {{ upstream }} and it was repurposed for compatibility with `kernels`.
+The original source code for this kernel comes from {{ upstream }}.
+{% endif %}
+{% if source %}
+
+## Source
+
+The kernel-builder formatted source for this kernel is available at {{ source }}.
 {% endif %}
 

examples/kernels/relu-compiler-flags/CARD.md

@@ -49,8 +49,14 @@ No benchmark available yet.
 {% endif %}
 {% if upstream %}
 
-## Source code
+## Upstream
 
-Source code of this kernel originally comes from {{ upstream }} and it was repurposed for compatibility with `kernels`.
+The original source code for this kernel comes from {{ upstream }}.
+{% endif %}
+{% if source %}
+
+## Source
+
+The kernel-builder formatted source for this kernel is available at {{ source }}.
 {% endif %}
 

examples/kernels/relu-metal-cpp/CARD.md

@@ -49,8 +49,14 @@ No benchmark available yet.
 {% endif %}
 {% if upstream %}
 
-## Source code
+## Upstream
 
-Source code of this kernel originally comes from {{ upstream }} and it was repurposed for compatibility with `kernels`.
+The original source code for this kernel comes from {{ upstream }}.
+{% endif %}
+{% if source %}
+
+## Source
+
+The kernel-builder formatted source for this kernel is available at {{ source }}.
 {% endif %}
 

examples/kernels/relu-nki/CARD.md

@@ -49,8 +49,14 @@ No benchmark available yet.
 {% endif %}
 {% if upstream %}
 
-## Source code
+## Upstream
 
-Source code of this kernel originally comes from {{ upstream }} and it was repurposed for compatibility with `kernels`.
+The original source code for this kernel comes from {{ upstream }}.
+{% endif %}
+{% if source %}
+
+## Source
+
+The kernel-builder formatted source for this kernel is available at {{ source }}.
 {% endif %}
 

examples/kernels/relu-specific-torch/CARD.md

@@ -49,8 +49,14 @@ No benchmark available yet.
 {% endif %}
 {% if upstream %}
 
-## Source code
+## Upstream
 
-Source code of this kernel originally comes from {{ upstream }} and it was repurposed for compatibility with `kernels`.
+The original source code for this kernel comes from {{ upstream }}.
+{% endif %}
+{% if source %}
+
+## Source
+
+The kernel-builder formatted source for this kernel is available at {{ source }}.
 {% endif %}
 

examples/kernels/relu-torch-bounds/CARD.md

@@ -49,8 +49,14 @@ No benchmark available yet.
 {% endif %}
 {% if upstream %}
 
-## Source code
+## Upstream
 
-Source code of this kernel originally comes from {{ upstream }} and it was repurposed for compatibility with `kernels`.
+The original source code for this kernel comes from {{ upstream }}.
+{% endif %}
+{% if source %}
+
+## Source
+
+The kernel-builder formatted source for this kernel is available at {{ source }}.
 {% endif %}
 

examples/kernels/relu-tvm-ffi/CARD.md

@@ -49,8 +49,14 @@ No benchmark available yet.
 {% endif %}
 {% if upstream %}
 
-## Source code
+## Upstream
 
-Source code of this kernel originally comes from {{ upstream }} and it was repurposed for compatibility with `kernels`.
+The original source code for this kernel comes from {{ upstream }}.
+{% endif %}
+{% if source %}
+
+## Source
+
+The kernel-builder formatted source for this kernel is available at {{ source }}.
 {% endif %}
 

examples/kernels/relu/CARD.md

@@ -49,8 +49,13 @@ No benchmark available yet.
 {% endif %}
 {% if upstream %}
 
-## Source code
+## Upstream
 
-Source code of this kernel originally comes from {{ upstream }} and it was repurposed for compatibility with `kernels`.
+The original source code for this kernel comes from {{ upstream }}.
 {% endif %}
+{% if source %}
 
+## Source
+
+The kernel-builder formatted source for this kernel is available at {{ source }}.
+{% endif %}

examples/kernels/silu-and-mul-bad-registration/CARD.md

@@ -49,8 +49,14 @@ No benchmark available yet.
 {% endif %}
 {% if upstream %}
 
-## Source code
+## Upstream
 
-Source code of this kernel originally comes from {{ upstream }} and it was repurposed for compatibility with `kernels`.
+The original source code for this kernel comes from {{ upstream }}.
+{% endif %}
+{% if source %}
+
+## Source
+
+The kernel-builder formatted source for this kernel is available at {{ source }}.
 {% endif %}
 

examples/kernels/silu-and-mul/CARD.md

@@ -49,8 +49,14 @@ No benchmark available yet.
 {% endif %}
 {% if upstream %}
 
-## Source code
+## Upstream
 
-Source code of this kernel originally comes from {{ upstream }} and it was repurposed for compatibility with `kernels`.
+The original source code for this kernel comes from {{ upstream }}.
+{% endif %}
+{% if source %}
+
+## Source
+
+The kernel-builder formatted source for this kernel is available at {{ source }}.
 {% endif %}
 

kernel-builder/src/card.rs

@@ -135,7 +135,8 @@ fn render_card(build: &Build, kernel_dir: &Path) -> Result<String> {
             functions => functions,
             layers => layers,
             has_benchmark => has_benchmark,
-            upstream => build.general.upstream.as_ref().map(|u| u.to_string()),
+            upstream => build.general.upstream.as_ref().map(|u| u.as_url().to_string()),
+            source => build.general.source.as_ref().map(|u| u.as_url().to_string()),
             license => build.general.license.to_lowercase(),
         })
         .wrap_err("Cannot render card template")

kernel-builder/src/init/templates/CARD.md

@@ -49,8 +49,14 @@ No benchmark available yet.
 {% endif %}
 {% if upstream %}
 
-## Source code
+## Upstream
 
-Source code of this kernel originally comes from {{ upstream }} and it was repurposed for compatibility with `kernels`.
+The original source code for this kernel comes from {{ upstream }}.
+{% endif %}
+{% if source %}
+
+## Source
+
+The kernel-builder formatted source for this kernel is available at {{ source }}.
 {% endif %}
 {% endraw %}

kernel-builder/src/pyproject/common.rs

@@ -44,6 +44,7 @@ pub fn write_metadata(
             version: general.version,
             license: general.license.clone(),
             upstream: general.upstream.clone(),
+            source: general.source.clone(),
             python_depends,
             backend: BackendInfo {
                 archs: None,

kernels-data/bindings/python/kernels_data.pyi

@@ -123,6 +123,8 @@ class Metadata:
     @property
     def upstream(self) -> Optional[str]: ...
     @property
+    def source(self) -> Optional[str]: ...
+    @property
     def python_depends(self) -> list[str]: ...
     @property
     def backend(self) -> BackendInfo: ...

kernels-data/bindings/python/src/lib.rs

@@ -195,6 +195,7 @@ struct PyMetadata {
     version: usize,
     license: String,
     upstream: Option<String>,
+    source: Option<String>,
     python_depends: Vec<String>,
     backend: PyBackendInfo,
 }
@@ -206,7 +207,8 @@ impl From<Metadata> for PyMetadata {
             name: PyKernelName { inner: m.name },
             version: m.version,
             license: m.license,
-            upstream: m.upstream.map(|u| u.to_string()),
+            upstream: m.upstream.map(|u| u.as_url().to_string()),
+            source: m.source.map(|u| u.as_url().to_string()),
             python_depends: m.python_depends,
             backend: m.backend.into(),
         }
@@ -257,6 +259,11 @@ impl PyMetadata {
         self.upstream.as_deref()
     }
 
+    #[getter]
+    fn source(&self) -> Option<&str> {
+        self.source.as_deref()
+    }
+
     #[getter]
     fn python_depends(&self) -> &[String] {
         &self.python_depends
@@ -269,12 +276,13 @@ impl PyMetadata {
 
     fn __repr__(&self) -> String {
         format!(
-            "Metadata(id={}, name={:?}, version={:?}, license={:?}, upstream={:?}, python_depends={:?}, backend={})",
+            "Metadata(id={}, name={:?}, version={:?}, license={:?}, upstream={:?}, source={:?}, python_depends={:?}, backend={})",
             self.id,
             self.name,
             self.version,
             self.license,
             self.upstream,
+            self.source,
             self.python_depends,
             self.backend.__repr__()
         )

kernels-data/bindings/python/tests/test_kernels_data.py

@@ -95,6 +95,7 @@ def test_metadata_load_full(tmp_path):
                 "name": "my-kernel",
                 "license": "Apache-2.0",
                 "upstream": "https://github.com/example/kernel",
+                "source": "https://github.com/example/kernel-builder",
                 "python-depends": ["torch"],
                 "backend": {"type": "cuda", "archs": ["9.0", "10.0"]},
             }
@@ -106,6 +107,7 @@ def test_metadata_load_full(tmp_path):
     assert m.version == 1
     assert m.license == "Apache-2.0"
     assert m.upstream == "https://github.com/example/kernel"
+    assert m.source == "https://github.com/example/kernel-builder"
     assert m.python_depends == ["torch"]
     assert m.backend.backend_type == Backend.CUDA
     assert m.backend.archs == ["9.0", "10.0"]
@@ -129,6 +131,7 @@ def test_metadata_load_minimal(tmp_path):
     assert m.version == 1
     assert m.license == "Apache-2.0"
     assert m.upstream is None
+    assert m.source is None
     assert m.python_depends == []
     assert m.backend.backend_type == Backend.CPU