mlx/mlx.h

// Copyright © 2023 Apple Inc.

#pragma once

#include "mlx/array.h"
#include "mlx/backend/cuda/cuda.h"
#include "mlx/backend/gpu/available.h"
#include "mlx/backend/metal/metal.h"
#include "mlx/compile.h"
#include "mlx/device.h"
#include "mlx/distributed/distributed.h"
#include "mlx/distributed/ops.h"
#include "mlx/einsum.h"
#include "mlx/export.h"
#include "mlx/fast.h"
#include "mlx/fft.h"
#include "mlx/io.h"
#include "mlx/linalg.h"
#include "mlx/memory.h"
#include "mlx/ops.h"
#include "mlx/random.h"
#include "mlx/stream.h"
#include "mlx/transforms.h"
#include "mlx/utils.h"
#include "mlx/version.h"
copyright + ack 2023-11-30 11:12:53 -08:00			`// Copyright © 2023 Apple Inc.`

awni's commit files 2023-11-29 10:30:41 -08:00			`#pragma once`

			`#include "mlx/array.h"`
start cuda circle config (#2256) * rebase * fix metal kernel linking issue on cuda * start cuda circle config 2025-06-10 21:19:47 -07:00			`#include "mlx/backend/cuda/cuda.h"`
Run CPP tests for CUDA build in CI (#2544) 2025-08-27 08:06:46 +09:00			`#include "mlx/backend/gpu/available.h"`
awni's commit files 2023-11-29 10:30:41 -08:00			`#include "mlx/backend/metal/metal.h"`
Compile primitive (#571) * Compiled primitive with basic binary, unary graph-level fusion 2024-02-05 06:51:22 -08:00			`#include "mlx/compile.h"`
awni's commit files 2023-11-29 10:30:41 -08:00			`#include "mlx/device.h"`
Comms (#1097) * Start the communications branch using MPI * Add ops and primitives * Add python bindings for distributed 2024-05-23 17:04:02 -07:00			`#include "mlx/distributed/distributed.h"`
			`#include "mlx/distributed/ops.h"`
Einsum (#1269) * einsum initial * fix comma break * sum axis was wrong * small cleanups * python binding * changed bindings to resemble numpy * remove todo comment * comment changes * add count of operands/inputs * fail fast if operands list is empty * ignore comma if no output * einsum path matching numpy * getting somewhere with path * remove print * it passes the first test * moved einsum tests to seperate file * seperated einsum path * moved einsum naive * remove space from equation * fast fail if no operands passed * update tests and remove printf * small cleanup * some more cleanups * removed python helper file * ack * utilize std for finding min in vector * duplicate def * remove the tuple as it was unreadable * moved einsum_naive back to ops * remaining isn't needed * avoid creating another set * cleanup * greedy path, start of naive einsum * more einsum * fix some bugs * some more fixes, tests pass * benchmark * some simplify * fix einsum and test Co-authored-by: Angelos Katharopoulos <a_katharopoulos@apple.com> * add a bunch more tests and fix a bunch more bugs * some docs nits --------- Co-authored-by: dc-dc-dc <dgcruz983@gmail.com> Co-authored-by: Angelos Katharopoulos <a_katharopoulos@apple.com> 2024-07-25 09:36:44 -07:00			`#include "mlx/einsum.h"`
Export / import functions to / from a file (#1642) * export and import functions * refactor + works for few primitives * nit * allow primitives with state * nit * nit * simplify serialize / deserialize * fix for constants * python bindings * maybe fix serialize failure case * add example * more primitives, training kind of works * same result for python and c++ * some fixes * fix export * template it up * some simplificatoin * rebase * allow kwargs and multiple functions * exporter * more primitives for exporting * deal with endianness * handle invalid stream * add docstring 2024-12-24 11:19:13 -08:00			`#include "mlx/export.h"`
Custom primitive + RoPE fat op (#676) * extensions start * rope custom op * fix build * docs + rope benchmark * fix test * Add a Metal kernel for RoPE * Fix position of traditional * transform tests * Move rope computation to float and fix tests * Fix the test and a typo * change to fast * fix no metal build --------- Co-authored-by: Angelos Katharopoulos <a_katharopoulos@apple.com> 2024-02-14 14:04:25 -08:00			`#include "mlx/fast.h"`
awni's commit files 2023-11-29 10:30:41 -08:00			`#include "mlx/fft.h"`
GGUF: Load and save metadata (#446) * gguf metadata --------- Co-authored-by: Awni Hannun <awni@apple.com> 2024-01-19 23:06:05 +01:00			`#include "mlx/io.h"`
linalg.norm (#187) * implemented vector_norm in cpp added linalg to mlx * implemented vector_norm python binding * renamed vector_norm to norm, implemented norm without provided ord * completed the implementation of the norm * added tests * removed unused import in linalg.cpp * updated python bindings * added some tests for python bindings * handling inf, -inf as numpy does, more extensive tests of compatibility with numpy * added better docs and examples * refactored mlx.linalg.norm bindings * reused existing util for implementation of linalg.norm * more tests * fixed a bug with no ord and axis provided * removed unused imports * some style and API consistency updates to linalg norm * remove unused includes * fix python tests * fixed a bug with frobenius norm of a complex-valued matrix * complex for vector too --------- Co-authored-by: Awni Hannun <awni@apple.com> 2023-12-27 04:42:04 +01:00			`#include "mlx/linalg.h"`
move memory APIs into top level mlx.core (#1982) 2025-03-21 07:25:12 -07:00			`#include "mlx/memory.h"`
awni's commit files 2023-11-29 10:30:41 -08:00			`#include "mlx/ops.h"`
			`#include "mlx/random.h"`
			`#include "mlx/stream.h"`
			`#include "mlx/transforms.h"`
			`#include "mlx/utils.h"`
Added mlx::core::version() returning std::string(MLX_VERSION) (#1819) * Added version.h providing mlx::core::version() returning std::string(MLX_VERSION) Also, added MLX_VERSION_MAJOR, MLX_VERSION_MINOR, MLX_VERSION_PATCH, MLX_VERSION_NUMERIC, and accompanying functions. * Added version.h to mlx.h * Changed version int functions to be constexpr * Formatting * Added handling of MLX_VERSION where only the prefix has major.minor.patch format * Changed version function to be constexpr 2025-02-20 05:30:19 +01:00			`#include "mlx/version.h"`