MlxMemorySnapshot

Best-effort snapshot of memory reported by MLX/Metal.

generatedAtGeneratedat (string)required

UTC timestamp when the snapshot was taken.

active object

Currently active MLX memory, when the runtime exposes it.

anyOf

• Memory
• null

inBytesInbytes (integer)

Default value: 0

cache object

MLX cache memory, when the runtime exposes it.

anyOf

• Memory
• null

inBytesInbytes (integer)

Default value: 0

peak object

Peak MLX memory since the last reset, when available.

anyOf

• Memory
• null

inBytesInbytes (integer)

Default value: 0

wiredLimit object

Configured MLX wired memory limit when known. Current MLX releases do not expose a getter on all platforms, so this may be null.

anyOf

• Memory
• null

inBytesInbytes (integer)

Default value: 0

sourceSource (string)required

Runtime module that supplied the measurement, such as mlx.core.

MlxMemorySnapshot

{
  "generatedAt": "string",
  "active": {
    "inBytes": 0
  },
  "cache": {
    "inBytes": 0
  },
  "peak": {
    "inBytes": 0
  },
  "wiredLimit": {
    "inBytes": 0
  },
  "source": "string"
}