For the complete documentation index, see llms.txt. Markdown versions of all pages are available by appending .md to any URL (e.g. /get-started.md).
Mojo package
gpu
GPU programming primitives.
These low level constructs allow you to write code that runs on the GPU with traditional programming style--partitioning work across threads that are mapped onto 1-, 2-, or 3-dimensional blocks. The thread blocks can subsequently be grouped into a grid of thread blocks.
A kernel is a function that runs on the GPU in parallel across many threads.
Currently, the
DeviceContext struct
provides the interface for compiling and launching GPU kernels inside MAX
custom operations.
The gpu.host package includes APIs to manage
interaction between the host (that is, the CPU) and device (that is, the GPU
or accelerator).
The gpu package exports aliases you can use to access information about the
grid and the current thread, including block dimensions, block index in the grid,
and thread index. Import these directly from gpu:
from max.gpu import block_dim, block_idx, thread_idx, global_idxFor an example of launching a GPU kernel from a MAX custom operation, see the vector addition example in the MAX repo.
comptime values
block_dim
comptime block_dim = _BlockDim()
Contains the dimensions of the block as x, y, and z values.
For example: block_dim.y.
block_id_in_cluster
comptime block_id_in_cluster = _ClusterBlockIdx()
Contains the block id of the threadblock within a cluster, as x, y, and z values.
block_idx
comptime block_idx = _BlockIdx()
Contains the block index in the grid, as x, y, and z values.
cluster_dim
comptime cluster_dim = _ClusterDim()
Contains the dimensions of the cluster, as x, y, and z values.
cluster_idx
comptime cluster_idx = _ClusterIdx()
Contains the cluster index in the grid, as x, y, and z values.
global_idx
comptime global_idx = _GlobalIdx()
Contains the global offset of the kernel launch, as x, y, and z values.
grid_dim
comptime grid_dim = _GridDim()
Provides accessors for getting the x, y, and z dimensions of a grid.
thread_idx
comptime thread_idx = _ThreadIdx()
Contains the thread index in the block, as x, y, and z values.
Packages
-
compute: GPU compute operations package - MMA and tensor core operations. -
host: Implements the gpu host package. -
memory: GPU memory operations package. -
primitives: GPU primitives package - warp, block, and cluster operations. -
sync: GPU synchronization primitives package.
Modules
-
globals: This module provides GPU-specific global constants and configuration values. -
intrinsics: Provides low-level GPU intrinsic operations and memory access primitives. -
tdm: CDNA5 (gfx1250) Tensor Data Mover (TDM) descriptors and instructions.
Functions
-
lane_id: Returns the lane ID of the current thread within its warp.