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.pipelines.lib

Types to interface with ML pipelines such as text/token generation.

Submodules

max.pipelines.lib.arch_lookup	Architecture registration and lookup tables.
max.pipelines.lib.interfaces	Interfaces for MAX pipelines.
max.pipelines.lib.log_probabilities	Builds computation graphs for log probabilities over batched input sequences.

Configuration

DenoisingCacheConfig	Resolved denoising-cache config.
DenoisingCacheSettings	User denoising-cache settings.
KVConnectorConfig	KV cache connector configuration: the connector type and its settings.
MAXConfig	Abstract base class for all MAX configs.
MAXModelConfigBase	Abstract base class for MAX model configuration.
PipelineArgs	User-settable input arguments for a pipeline.
PipelineRuntimeConfig	Model-agnostic runtime settings for pipeline execution.

Pipelines

EmbeddingsPipelineType	alias of Pipeline[EmbeddingsGenerationInputs, EmbeddingsGenerationOutput]
OverlapTextGenerationPipeline	Overlap text generation pipeline.

Model interface

AlwaysSignalBuffersMixin	Mixin for models that always require signal buffers.
ModuleV3PipelineModelWithKVCache	The base class for a ModuleV3 model architecture that uses a KV cache.
PipelineModelWithKVCache	A pipeline model that supports KV cache.
UnifiedEagleOutputs	Outputs from a unified EAGLE graph execution.

Tokenizers

AudioGenerationTokenizer	Turns an audio generation request into an AudioContext.
PixelGenerationTokenizer	Encapsulates creation of PixelContext and specific token encode/decode logic.

Utilities

CompilationTimer	Timer for logging graph build, compile, and init phases.
HuggingFaceRepo	Handle for interacting with a Hugging Face repository (remote or local).
MemoryPlan	The memory plan computed when a pipeline is loaded.
ModelManifest	Registry mapping semantic role strings to MAXModelConfig instances.
RetrievedPipeline	Everything PipelineRegistry.retrieve_factory() resolves.
Speculator	One speculative variant of a target architecture.
VisionPreprocessCache	LRU cache of preprocessed media payloads, bounded by total bytes.
WeightPathParser	Parses and validates weight paths for model configuration.

Functions

build_eos_tracker_for_request	Builds an EOSTracker from request sampling params.
convert_max_config_value	Converts a config value to the appropriate type.
deep_merge_max_configs	Deep merge two MAXConfig configuration dictionaries.
float32_array_to_buffer	Create a device buffer from float32 host data without a cast-only graph.
float32_to_bfloat16_as_uint16	Converts a float32 array to bfloat16 representation stored as uint16.
generate_local_model_path	Generates the local filesystem path where a Hugging Face model repo is cached.
get_default_max_config_file_section_name	Gets the default section name for a MAXConfig class.
max_tokens_to_generate	Returns the max number of new tokens to generate.
parse_quant_config	Parses scaled quantization config from HuggingFace config and state dict.
resolve_eos_token_ids	Returns every token id that ends generation for the model.
resolve_max_config_inheritance	Resolves configuration inheritance by loading base config and merging.
try_to_load_from_cache	Wrapper around huggingface_hub.try_to_load_from_cache; validates repo exists.
validate_hf_repo_access	Validates repository access and raises clear, user-friendly errors.