Skip to content

gomlx/gomlx

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

GoMLX, an Accelerated ML and Math Framework

GoDev GitHub Go Report Card Linux Tests Darwin Tests Coverage Slack Sponsor gomlx

๐Ÿ“– About GoMLX

GoMLX Gopher

GoMLX is an easy-to-use set of Machine Learning and generic math libraries and tools. It can be seen as a PyTorch/Jax/TensorFlow for Go.

It can be used to train, fine-tune, modify, and combine machine learning models. It provides all the tools to make that work easy: from a complete set of differentiable operators, all the way to UI tools to plot metrics while training in a notebook.

It runs almost everywhere Go runs, using a pure Go backend. It runs even in the browser with WASM (see demo created with GoMLX). Likely, it will work in embedded devices as well (see Tamago).

It also supports a very optimized backend engine based on OpenXLA/PJRT that uses just-in-time compilation to CPU, GPUs (Nvidia, but soon AMD ROCm, Intel, Macs, and Google's TPUs also). It's the same engine that powers Google's Jax and TensorFlow, and it has the same speed in many cases. Use this backend to train large models or with large datasets. This only compiles for Linux/amd-64 for now (but with the integration of the StableHLO it should soon work in macOS as well).

Tip

It was developed to be a full-featured ML platform for Go and to easily experiment with ML ideasโ€”see Long-Term Goals below.

It strives to be simple to read and reason about, leading the user to a correct and transparent mental model of what is going on (no surprises)โ€”aligned with Go philosophy. At the cost of more typing (more verbose) at times.

It is also incredibly flexible and easy to extend and try non-conventional ideas: use it to experiment with new optimizer ideas, complex regularizers, funky multitasking, etc.

Documentation is kept up to date (if it is not well-documented, it is as if the code is not there), and error messages are useful (always with a stack-trace) and try to make it easy to solve issues.

๐Ÿ—บ๏ธ Overview

GoMLX is a full-featured ML framework, supporting various well-known ML components
from the bottom to the top of the stack. But it is still only a slice of what a major ML library/framework should provide (like TensorFlow, Jax, or PyTorch).

Examples developed using GoMLX:

Highlights:

๐Ÿš€ NEW ๐Ÿš€: Fixed Mac support for the XLA backend, including installer. Only CPU for now, see jax/issues/32800 for the request to Apple developers to update their support for GPU XLA.

๐Ÿš€ NEW ๐Ÿš€: gomlx_checkpoints, the command line tool to inspect checkpoints of train(-ing) models, now also generate plots with loss and arbitrary evaluation metrics using Plotly. See example of training session, with the effects of a learning rate change during the training. It also allows plotting different models together, to compare their evolution.

  • Converting ONNX models to GoMLX with onnx-gomlx: both as an alternative for onnxruntime (leveraging XLA), but also to further fine-tune models. See also go-huggingface to easily download ONNX model files from HuggingFace.
  • Docker "gomlx_jupyterlab" with integrated JupyterLab and GoNB (a Go kernel for Jupyter notebooks)
  • Two backends:
    1. xla: OpenXLA backend for CPUs, GPUs, and TPUs. State-of-the-art as these things go. Only linux/amd64 for now. 1.a: To be replaced by the new stablehlo backend, currently in beta. See the note above.
    2. go: a pure Go backend (no C/C++ dependencies): slower but very portable (compiles to WASM/Windows/etc.): SIMD support is planned when it becomes available; See also GoMLX compiled to WASM to power the AI for a game of Hive
  • Autograd: automatic differentiationโ€”only gradients for now, no jacobian.
  • Context: automatic variable management for ML models.
  • ML layers library with some of the most popular machine learning "layers": FFN layers,
    various activation functions, layer and batch normalization, convolutions, pooling, dropout, Multi-Head-Attention (for transformer layers), LSTM, KAN (B-Splines, GR-KAN/KAT networks, Discrete-KAN, PiecewiseLinear KAN), PiecewiseLinear (for calibration and normalization), various regularizations, FFT (reverse/differentiable), learnable rational functions (both for activations and GR-KAN/KAT networks), VNN (Vector Neural Networks) for SO(3)-Equivariant/Invariant layers, etc.
  • Training library, with some pretty-printing. Including plots for Jupyter notebook, using GoNB, a Go Kernel.
    • Also, various debugging tools: collecting values for particular nodes for plotting, simply logging the value of nodes during training, stack-trace of the code where nodes are created.
  • SGD and Adam (AdamW and Adamax) optimizers.
  • Various losses and metrics.
  • Pre-Trained models to use: InceptionV3 (image model), many more from HuggingFace using onnx-gomlx. See also go-huggingface to easily download ONNX model files from HuggingFace.
  • Read Numpy arrays into GoMLX tensors -- see package github.com/gomlx/gomlx/pkg/core/tensors/numpy.
  • Support static linking of PJRT: slower to build the Go program, but deploying it doesn't require installing a PJRT plugin in the machine you are deploying it. Use go build --tags=pjrt_cpu_static or include import _ "github.com/gomlx/gomlx/backends/stablehlo/cpu/static".

๐Ÿ‘ฅ Support

๐Ÿ› ๏ธ + โš™๏ธ Installation (Only needed for the XLA backend)

If you want to use only a pure Go backend, simply do import _ "github.com/gomlx/gomlx/backends/simplego" and there is no need to install anything.

For XLA there are two simple options:

(1) Use the Docker;

(2) Install the pre-built XLA/PJRT binaries (C/C++ libraries) for Linux (including CUDA) or macOS with the interactive self-explanatory installer:

go run github.com/gomlx/gopjrt/cmd/gopjrt_installer@latest

Note

For now it works for (1) CPU PJRT on linux/amd64 (or Windows+WSL); (2) Nvidia CUDA PJRT on Linux/amd64; (3) CPU PJRT on Darwin (macOS). I would love to support for AMD ROCm, Apple Metal (GPU), Intel, and others, but I don't have easy access to hardwre to test/maintain them. If you feel like contributing or donating hardware/cloud credits, please contact me.

๐Ÿณ Pre-built Docker

The easiest to start playing with it, it's just pulling the docker image that includes GoMLX + JupyterLab + GoNB (a Go kernel for Jupyter) and Nvidia's CUDA runtime (for optional support of GPU) pre-installed -- it is ~5Gb to download.

From a directory you want to make visible in Jupyter, do:

For GPU support add the flag --gpus all to the docker run command bellow.

docker pull janpfeifer/gomlx_jupyterlab:latest
docker run -it --rm -p 8888:8888 -v "${PWD}":/home/jupyter/work janpfeifer/gomlx_jupyterlab:latest

It will display a URL starting with 127.0.0.1:8888 in the terminal (it will include a secret token needed) that you can open in your browser.

You can open and interact with the tutorial from there, it is included in the docker under the directory Projects/gomlx/examples/tutorial.

More details on the docker here.

It runs on Windows as well: Docker Desktop uses WSL2 under the hood.

๐Ÿงญ Tutorial

See the tutorial here. It covers a bit of everything.

After that, look at the demos in the examples/ directory.

The library itself is well-documented (pls open issues if something is missing), and the code is not too hard to read. Godoc is available in pkg.go.dev.

Finally, feel free to ask questions: time allowing (when not at work), I'm always happy to helpโ€”I created groups.google.com/g/gomlx-discuss, or use the Slack channel #gomlx.

Inference

Inference or serving a model is done currently by using the Go code used to create the model along with the checkpoint with the trained weights and hyperparameters used to train the model. In other words, it uses the same tools used for training.

For a simple example of how to do this and export a model inference as a library, see .../examples/cifar/classifer, and its use in the last cells of the Cifar-10 demo.

In the future we plan to also export models to ONNX or StableHLO, and one could use tools that serve those.

๐ŸŽฏ Long-term Goals

  1. Building and training models in Go -- as opposed to Python (or some other language) -- with focus on:
    • Being easy(ier) to read and reason about, leading the user to a correct and transparent mental model of what is going on. Even if that means being more verbose when writing.
    • Clean, separable APIs: individual APIs should be self-contained and decoupled where possible.
    • Composability: Any component should be replaceable, so they can be customized and experimented with. That means sometimes more coding (there is not one magic train object that does everything), but it makes it clear what is happening, and to replace parts with custom versions.
    • Up-to-date documentation: if the documentation is not there or if it's badly written, it's as if the code was not there either.
    • Clear and actionable error reporting
  2. To be a productive research and educational platform to experiment with new ML ideas and learn.
    • Support mirrored training on multiple devices and various forms of distributed training (model and/or data parallelism), in particular to support for large language models and similarly large model training.
  3. To be a robust and reliable platform for production. Some subgoals:
    • Support modern accelerator hardware like TPUs and GPUs.
    • Multiple backends beyond XLA, e.g: llamacpp, WebNN (with Wasm), pure Go version, etc.
    • Import pre-trained models from Hugging Face Hub and allow fine-tuning -- ONNX versions already working for many models in onnx-gomlx.
    • Compile models to binary as in C-libraries and/or WebAssembly, to be linked and consumed (inference) anywhere (any language).

๐Ÿค” FAQ

  • What are the environment variables used by GoMLX?
    • GOMLX_BACKEND: defines the backend engine to use (if using backends.New()). The value is formatted as "<backend_name>[:<backend_config>]", with the config part being optional. Examples:
      • GOMLX_BACKEND=go: Use the SimpleGo backend, the pure Go implementation that is very portable but slow.
      • GOMLX_BACKEND="xla:cpu": Use XLA (the faster backend, only runs on Linux now) for CPU
      • GOMLX_BACKEND="xla:cuda": Use XLA for for Nvidia CUDA
      • GOMLX=BACKEND="xla:/path/to/my/pjrt_plugin.so": Use XLA with an arbitrary PJRT. PJRT is a plugin system for XLA to support different hardware. One can install PJRTs build for NVIDIA GPUs (there is an installation script for that), there is also one for ROCm (not tested by the author), for TPU (Google Cloud) and reports of PJRTs being built to even new accelerators (e.g.: TensTorrent XLA)
    • PJRT_PLUGIN_LIBRARY_PATH: the underlying XLA backend uses this variable as an extra directory to search for plugin locations. It searches for the systems library paths ($LD_LIBRARY_PATH, /etc/ld.so.conf), the default /usr/local/lib/gomlx/pjrt and $PJRT_PLUGIN_LIBRARY_PATH if set.
    • XLA_FLAGS: optional controls for XLA backend. It should be set to a semicolon (";") separated list of options. If you set to --help the backend will print out some help for all options. There is also a description on the page XLA Flags Guidance.
  • What backends to include when using GoMLX?
    • The recommendation is to use import _ "github.com/gomlx/gomlx/backends/default" which will import xla (alias to stablehlo) and go (SimpleGo) backends. If you add -tags=noxla to the compiler it won't include XLA/stablehlo backend.
    • import _ "github.com/gomlx/gomlx/backends/simplego" to include only go (no C++ dependencies)
    • import _ "github.com/gomlx/gomlx/backends/stablehlo" to import only XLA (stablehlo).
    • A deprecated version of XLA backend (named oldxla) is available if you import _ "github.com/gomlx/gomlx/backends/xla". This is temporary only and will be removed in future releases. It is also included if you import _ "github.com/gomlx/gomlx/backends/default" and use -tags=oldxla when building.

๐Ÿค Collaborating

The project is looking forward to contributions for anyone interested. Many parts are not yet set in stone, so there is plenty of space for improvements and re-designs for those interested and with good experience in Go, Machine Learning, and APIs in general. See the TODO file for inspiration.

No governance guidelines have been established yet.

See the section Support above to get in touch (Slack channel or Google Groups)!

๐Ÿ’– Support the Project

If you find this project helpful, please consider supporting our work through GitHub Sponsors.

Your contribution helps us (currently mostly me) dedicate more time to maintenance and add new features for the entire GoMLX ecosystem.

It also helps us acquire access (buying or cloud) to hardware for more portability: e.g.: ROCm, Apple Metal (GPU), Multi-GPU/TPU, NVidia DGX Spark, Tenstorrent, etc.

๐Ÿš€ Advanced Topics

๐Ÿ’– Thanks

โš–๏ธ License

Copyright 2025 Jan Pfeifer

GoMLX is distributed under the terms of the Apache License Version 2.0. Unless it is explicitly stated otherwise, any contribution intentionally submitted for inclusion in this project shall be licensed under Apache License Version 2.0 without any additional terms or conditions.

About

GoMLX: An Accelerated Machine Learning Framework For Go

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published

Contributors 14