Kernels documentation
kernels info
Get started
Use kernels
QuickstartUse layersLock kernel versionsEnvironment variablesProjects using kernelsMigrate from older versionsFAQ
Python API
kernels CLI
Overviewkernels infokernels versionskernels lockkernels downloadkernels benchmarkkernels verify-signature
Build kernels
Write kernelsBuild with NixDevelop locallySet up your IDESet up for Metal kernelsDevelop kernels with agentsSecure your kernelsGitHub Actions & HF Jobs
kernel-builder CLI
Kernel specifications
Concepts & design
Resources
You are viewing main version, which requires installation from source. If you'd like
regular pip install, checkout the latest stable version (v0.16.0).
kernels info
Use kernels info to describe a kernel from a Hub repo ID or a local path.
It prints the kernel metadata (name, version, license, upstream/source
repositories, Python dependencies, and supported backends). To list the
build variants of a kernel and their compatibility with the current system,
use kernels versions.
Usage
kernels info <repo_id_or_path>
When the argument is an existing local directory, it is treated as a kernel
repository with build variants in its build/ directory. Otherwise it is
treated as a Hub repo ID.
Options:
--revision <revision>: describe a specific branch, tag, or commit (Hub only). Cannot be used together with--version.--version <version>: describe a specific kernel version (Hub only). Cannot be used together with--revision. When neither is given, the latest version is used (ormainfor unversioned repositories).--json: print the kernel information as JSON for machine-readable output.
Examples
Describe a kernel on the Hub:
kernels info kernels-community/activation
Describe a local kernel repository (e.g. after kernel-builder build-and-copy):
kernels info ./relu
Get machine-readable output:
kernels info --json kernels-community/activation
Example Output
Repository: kernels-community/activation Revision: v1 Name: activation Version: 1 License: Apache-2.0 Upstream: - Source: - Python dependencies: - Backends: cuda, metal
See Also
- kernels versions - List available versions of a kernel
- kernels download - Download locked kernels