Kernels documentation
Kernels CLI Reference
Kernels CLI Reference
Main Functions
kernels check
You can use kernels check to test compliance of a kernel on the Hub.
This currently checks that the kernel:
- Supports the currently-required Python ABI version.
- Works on supported operating system versions.
For example:
$ kernels check kernels-community/flash-attn3 Checking variant: torch28-cxx11-cu128-aarch64-linux 🐍 Python ABI 3.9 compatible 🐧 manylinux_2_28 compatible [...]
kernels to-wheel
We strongly recommend downloading kernels from the Hub using the kernels
package, since this comes with large benefits over using Python
wheels. That said, some projects may require deployment of kernels as
wheels. The kernels utility provides a simple solution to this. You can
convert any Hub kernel into a set of wheels with the to-wheel command:
$ kernels to-wheel drbh/img2grey 1.1.2 ☸ img2grey-1.1.2+torch27cu128cxx11-cp39-abi3-manylinux_2_28_x86_64.whl ☸ img2grey-1.1.2+torch26cu124cxx11-cp39-abi3-manylinux_2_28_x86_64.whl ☸ img2grey-1.1.2+torch26cu126cxx11-cp39-abi3-manylinux_2_28_x86_64.whl ☸ img2grey-1.1.2+torch27cu126cxx11-cp39-abi3-manylinux_2_28_x86_64.whl ☸ img2grey-1.1.2+torch26cu126cxx98-cp39-abi3-manylinux_2_28_x86_64.whl ☸ img2grey-1.1.2+torch27cu128cxx11-cp39-abi3-manylinux_2_28_aarch64.whl ☸ img2grey-1.1.2+torch26cu126cxx98-cp39-abi3-manylinux_2_28_aarch64.whl ☸ img2grey-1.1.2+torch27cu126cxx11-cp39-abi3-manylinux_2_28_aarch64.whl ☸ img2grey-1.1.2+torch26cu126cxx11-cp39-abi3-manylinux_2_28_aarch64.whl ☸ img2grey-1.1.2+torch26cu118cxx98-cp39-abi3-manylinux_2_28_x86_64.whl ☸ img2grey-1.1.2+torch26cu124cxx98-cp39-abi3-manylinux_2_28_x86_64.whl ☸ img2grey-1.1.2+torch26cu118cxx11-cp39-abi3-manylinux_2_28_x86_64.whl ☸ img2grey-1.1.2+torch27cu118cxx11-cp39-abi3-manylinux_2_28_x86_64.whl
kernels upload
Use kernels upload <dir_containing_build> --repo_id="hub-username/kernel" to upload
your kernel builds to the Hub.
Notes:
- This will take care of creating a repository on the Hub with the
repo_idprovided. - If a repo with the
repo_idalready exists and if it contains abuildwith the build variant being uploaded, it will attempt to delete the files existing under it. - Make sure to be authenticated (run
hf auth loginif not) to be able to perform uploads to the Hub.