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 struct
NullMask
struct NullMask
Mask that's effectively a noop.
Implemented traits
AnyType,
Copyable,
Defaultable,
Deinitable,
DevicePassable,
ImplicitlyCopyable,
MHAMask,
Movable,
RegisterPassable,
TrivialRegisterPassable
comptime members
apply_log2e_after_mask
comptime apply_log2e_after_mask = False
check_mask_during_decoding
comptime check_mask_during_decoding = False
device_type
comptime device_type = NullMask
has_row_bias
comptime has_row_bias = False
Whether add_row_bias adds this mask's additive bias, leaving visibility_mask the rest of mask.
mask_out_of_bound
comptime mask_out_of_bound = True
mask_safe_out_of_bounds
comptime mask_safe_out_of_bounds = True
MaskType
comptime MaskType[*Ts: Fused & Input & LoadAccess] = NullMask
Parameters
- *Ts (
Fused&Input&LoadAccess):
supports_decode_token_fold
comptime supports_decode_token_fold = False
Whether AMD decode may fold several query tokens into one tile under this mask, and start its split-K key range at start_column: both status and start_column stay valid when asked about the span of query rows a sequence's decode step carries.
Methods
get_type_name
name
mask
def mask[dtype: DType, width: SIMDLength, //](self, coord: Coord[Int, Int, Int, Int], score_vec: SIMD[dtype, width]) -> SIMD[dtype, width]
Returns:
status
def status(self, seq_id: UInt32, tile_offset: Coord[Int, Int], tile_size: Coord[Int, Int]) -> TileMaskStatus
Returns:
start_column
def start_column[BM: Int, BN: Int, page_size: Int](self, seq_id: UInt32, row: UInt32) -> UInt32
Returns:
start_column_alignment
total_iters
def total_iters[BM: Int, BN: Int, page_size: Int](self, seq_id: UInt32, row: UInt32, num_cols: UInt32) -> UInt32
The total number of column iterations for which this mask returns either `TileMaskStatus.NO_MASK' or 'TileMaskStatus.PARTIAL_MASK'.
Parameters:
- BM (
Int): Query tile height (number of query rows per block). - BN (
Int): Key tile width (number of key columns per block). - page_size (
Int): The KV cache page size in key columns (0 or 1 if unpaged).
Args:
- seq_id (
UInt32): The sequence/batch index. - row (
UInt32): The starting query-row index of the current query tile. - num_cols (
UInt32): The exclusive upper bound on key column indices.
Returns:
last_masked_set_end
def last_masked_set_end[BM: Int, BN: Int, page_size: Int](self, seq_id: UInt32, row: UInt32, num_cols: UInt32) -> UInt32
Returns:
count_nonfull_sets
masked_set_ends
def masked_set_ends[BM: Int, BN: Int, page_size: Int](self, seq_id: UInt32, row: UInt32, num_cols: UInt32) -> StaticTuple[UInt32, NullMask.count_nonfull_sets(BM, BN)]
Returns:
nonfull_sets
static def nonfull_sets[BM: Int, BN: Int]() -> StaticTuple[TileMaskStatus, NullMask.count_nonfull_sets(BM, BN)]
Returns:
StaticTuple[TileMaskStatus, NullMask.count_nonfull_sets(BM, BN)]
mask_strategies
static def mask_strategies[BM: Int, BN: Int]() -> StaticTuple[MaskStrategy, NullMask.count_nonfull_sets(BM, BN)]
Returns:
StaticTuple[MaskStrategy, NullMask.count_nonfull_sets(BM, BN)]
mask_bits
def mask_bits(self, seq_id: UInt32, score_row: Int32, col_start: Int32, num_keys: Int32) -> UInt32
Returns: