Skip to content
KotlinManiaPublic

About

Micro compiler for tensor operations in Kotlin Multiplatform

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

ug-kotlin in Kotlin

GitHub link Maven Central Build status

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

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.


Upstream README — LaurentMazare/ug

The text below is reproduced from https://github.com/LaurentMazare/ug. 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.

ug

rust ci badge

Experimental compiler for deep-learning models inspired by triton, tinygrad, and micrograd.


About this Kotlin port

Installation

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

Typed data and error values

WithDType.F32, I32, I64, F16, and BF16 are concrete scalar descriptors. Each creates typed values and converts its matching CPU storage. Half-precision storage exposes a live read-only data list and indexed get/set operations; host/device copy methods preserve buffer contents.

UgError exposes domain variants, messages, and causes to Swift without inheriting from a platform exception. Kotlin code raises it with error.raise(). After catching an exception, UgError.fromException(exception) returns the original domain error, or null for an unrelated exception.

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 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

Micro compiler for tensor operations in Kotlin Multiplatform

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages