Skip to content

About

Candle Metal shader kernels in Kotlin Multiplatform

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

candle-metal-kernels-kotlin in Kotlin

GitHub link Maven Central Build status

This is a Kotlin Multiplatform line-by-line transliteration port of candle-metal-kernels.

Original Project: This port is based on candle-metal-kernels. All design credit and project intent belong to the upstream authors; this repository is a faithful port to Kotlin Multiplatform with no behavioural changes intended.

Porting status

This is an in-progress port. The goal is feature parity with the upstream Rust crate while providing a native Kotlin Multiplatform API. Every Kotlin file carries a // port-lint: source <path> header naming its upstream Rust counterpart so the AST-distance tool can track provenance.


Upstream README — candle-metal-kernels

The text below is reproduced from https://github.com/huggingface/candle. It is the upstream project's own description and remains under the upstream authors' authorship; links have been rewritten to absolute upstream URLs where appropriate so they continue to resolve from this repository.

candle-metal-kernels

This crate contains Metal kernels used from candle.


About this Kotlin port

Installation

dependencies {
    implementation("io.github.kotlinmania:candle-metal-kernels-kotlin:0.10.2")
}

Error values

MetalKernelError carries a kernel failure without inheriting from a platform exception, so its variants and messages are available in Swift. Kotlin code raises an error with error.raise(). After catching an exception, MetalKernelError.fromException(exception) returns the original domain error, or null for an unrelated exception. The original error and its cause are retained.

Building

./gradlew build
./gradlew test

Targets

  • macOS arm64
  • Linux x64
  • Windows mingw-x64
  • iOS arm64 / simulator-arm64 (Swift export + XCFramework)
  • JS (browser + Node.js)
  • Wasm-JS (browser + Node.js)
  • Android (API 24+)

Porting guidelines

See AGENTS.md for translator discipline, port-lint header convention, and Rust → Kotlin idiom mapping.

License

This Kotlin port is distributed under the same license terms as the upstream candle-metal-kernels. See LICENSE (and any sibling LICENSE-* / NOTICE files mirrored from upstream) for the full text.

Original work copyrighted by the candle-metal-kernels authors.
Kotlin port: Copyright (c) 2026 Sydney Renee and The Solace Project.

Acknowledgments

Thanks to the candle-metal-kernels maintainers and contributors for the original Rust implementation. This port reproduces their work in Kotlin Multiplatform; bug reports about upstream design or behavior should go to the upstream repository.

About

Candle Metal shader kernels in Kotlin Multiplatform

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages