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

Python module

max.driver

Devices

Accelerator	Creates an accelerator device with the specified ID and memory limit.
CompletionFlag	An 8-byte completion flag in pinned host memory mapped into a device's address space.
CPU	Creates a CPU device.
Device	Represents a compute device available for tensor operations.
DeviceEvent	Provides access to an event object.
DeviceQueue	Provides access to a queue of execution on a device.
DeviceSpec	A device specification containing an ID and device type.

Buffers

Buffer	Device-resident buffer representation.
DevicePinnedBuffer	Creates a pinned host memory allocation tied to the given device.
DLPackArray
HostHazardError
Usage	Allocation-intent descriptor for Buffer.

batch_inplace_copy	Copies srcs[i] into dsts[i] in as few driver submissions as possible.
load_max_buffer	Experimental method for loading serialized MAX buffers.

Device discovery

accelerator_api	Returns the API used to program the accelerator.
accelerator_architecture_name	Returns the architecture name of the accelerator device.
accelerator_count	accelerator_count() -> int
devices_exist	Returns True if all specified devices exist.
enable_all_peer_access	enable_all_peer_access() -> None
load_devices	Initializes and returns a list of Device objects from a sequence of DeviceSpec objects.
scan_available_devices	Returns all available accelerators, or a CPU device if none are available.

Launch tracing

LaunchTraceEntry	One operation recorded by max.driver.begin_launch_trace.

begin_launch_trace	begin_launch_trace() -> None
launch_trace	Records the device operations enqueued within the with block.
take_launch_trace	take_launch_trace() -> list[max.driver.LaunchTraceEntry]

Virtual devices

calculate_virtual_device_count	Calculates the minimum virtual device count needed for the given device specs.
calculate_virtual_device_count_from_cli	Calculates the minimum virtual device count from raw CLI inputs (before parsing).
get_virtual_cpu_target	get_virtual_cpu_target() -> str
get_virtual_device_api	get_virtual_device_api() -> str
get_virtual_device_count	get_virtual_device_count() -> int
get_virtual_device_target_arch	get_virtual_device_target_arch() -> str
is_virtual_device_mode	is_virtual_device_mode() -> bool
set_virtual_cpu_target	str) -> None
set_virtual_device_api	str) -> None
set_virtual_device_count	int) -> None
set_virtual_device_target_arch	str) -> None