Skip to content

About

Metal backend for ug micro-compiler in Kotlin Multiplatform

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

ug-metal-kotlin in Kotlin

GitHub link Maven Central Build status

This is a Kotlin Multiplatform line-by-line transliteration port of LaurentMazare/ug (crate ug-metal).

Original Project: This port is based on LaurentMazare/ug. 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.


About this Kotlin port

Installation

dependencies {
    implementation("io.github.kotlinmania:ug-metal-kotlin:0.1.1")
}

Typed buffer access

Device.zeros<T>() and Device.sliceFromValues() retain the scalar type when reading buffer contents. Supported scalars are Float, Double, Int, Long, Short, Byte, F16, and BF16. Each toVec() reads the current buffer and returns a copy. A custom SliceReader<T> supplies decoding for other buffer layouts.

Builds resolve the published UG and Candle Metal Kernels dependencies from Maven Central.

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 LaurentMazare/ug. See LICENSE (and any sibling LICENSE-* / NOTICE files mirrored from upstream) for the full text.

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

Acknowledgments

Thanks to the LaurentMazare/ug 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

Metal backend for ug micro-compiler in Kotlin Multiplatform

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages