|
| 1 | +# Copyright (c) Meta Platforms, Inc. and affiliates. |
| 2 | +# All rights reserved. |
| 3 | +# |
| 4 | +# This source code is licensed under the BSD-style license found in the |
| 5 | +# LICENSE file in the root directory of this source tree. |
| 6 | + |
| 7 | +import unittest |
| 8 | + |
| 9 | +import torch |
| 10 | + |
| 11 | +from torchtitan.distributed.varlen_cp.mask_primitives import ( |
| 12 | + AttnSlice, |
| 13 | + cu_seqlens_to_attn_slices, |
| 14 | + make_slice_mask, |
| 15 | + MaskType, |
| 16 | + split_slice_at_chunk_boundary, |
| 17 | +) |
| 18 | + |
| 19 | + |
| 20 | +class TestMaskType(unittest.TestCase): |
| 21 | + def test_mask_type_values(self): |
| 22 | + self.assertEqual(MaskType.FULL, 0) |
| 23 | + self.assertEqual(MaskType.CAUSAL, 1) |
| 24 | + self.assertEqual(MaskType.INVCAUSAL, 2) |
| 25 | + self.assertEqual(MaskType.BICAUSAL, 3) |
| 26 | + |
| 27 | + |
| 28 | +class TestAttnSlice(unittest.TestCase): |
| 29 | + def test_basic_properties(self): |
| 30 | + s = AttnSlice(q_start=0, q_end=10, k_start=0, k_end=10, mask_type=MaskType.FULL) |
| 31 | + self.assertEqual(s.q_len, 10) |
| 32 | + self.assertEqual(s.k_len, 10) |
| 33 | + |
| 34 | + def test_work_estimate_full(self): |
| 35 | + s = AttnSlice(q_start=0, q_end=100, k_start=0, k_end=100, mask_type=MaskType.FULL) |
| 36 | + self.assertAlmostEqual(s.work_estimate, 10000.0) |
| 37 | + |
| 38 | + def test_work_estimate_causal(self): |
| 39 | + s = AttnSlice(q_start=0, q_end=100, k_start=0, k_end=100, mask_type=MaskType.CAUSAL) |
| 40 | + self.assertAlmostEqual(s.work_estimate, 5000.0) |
| 41 | + |
| 42 | + def test_work_estimate_invcausal(self): |
| 43 | + s = AttnSlice( |
| 44 | + q_start=0, q_end=100, k_start=0, k_end=100, mask_type=MaskType.INVCAUSAL |
| 45 | + ) |
| 46 | + self.assertAlmostEqual(s.work_estimate, 5000.0) |
| 47 | + |
| 48 | + def test_work_estimate_bicausal(self): |
| 49 | + s = AttnSlice( |
| 50 | + q_start=0, q_end=100, k_start=0, k_end=100, mask_type=MaskType.BICAUSAL |
| 51 | + ) |
| 52 | + self.assertAlmostEqual(s.work_estimate, 2500.0) |
| 53 | + |
| 54 | + def test_work_estimate_minimum(self): |
| 55 | + """Empty slices should have work_estimate >= 1.0.""" |
| 56 | + s = AttnSlice(q_start=0, q_end=1, k_start=0, k_end=1, mask_type=MaskType.CAUSAL) |
| 57 | + self.assertGreaterEqual(s.work_estimate, 1.0) |
| 58 | + |
| 59 | + |
| 60 | +class TestCuSeqlensToAttnSlices(unittest.TestCase): |
| 61 | + def test_single_doc(self): |
| 62 | + cu_seqlens = [0, 256] |
| 63 | + slices = cu_seqlens_to_attn_slices(cu_seqlens, is_causal=True) |
| 64 | + self.assertEqual(len(slices), 1) |
| 65 | + self.assertEqual(slices[0].q_start, 0) |
| 66 | + self.assertEqual(slices[0].q_end, 256) |
| 67 | + self.assertEqual(slices[0].mask_type, MaskType.CAUSAL) |
| 68 | + |
| 69 | + def test_multi_doc(self): |
| 70 | + cu_seqlens = [0, 128, 300, 512] |
| 71 | + slices = cu_seqlens_to_attn_slices(cu_seqlens, is_causal=True) |
| 72 | + self.assertEqual(len(slices), 3) |
| 73 | + self.assertEqual(slices[0], AttnSlice(0, 128, 0, 128, MaskType.CAUSAL)) |
| 74 | + self.assertEqual(slices[1], AttnSlice(128, 300, 128, 300, MaskType.CAUSAL)) |
| 75 | + self.assertEqual(slices[2], AttnSlice(300, 512, 300, 512, MaskType.CAUSAL)) |
| 76 | + |
| 77 | + def test_full_mask(self): |
| 78 | + cu_seqlens = [0, 256] |
| 79 | + slices = cu_seqlens_to_attn_slices(cu_seqlens, is_causal=False) |
| 80 | + self.assertEqual(len(slices), 1) |
| 81 | + self.assertEqual(slices[0].mask_type, MaskType.FULL) |
| 82 | + |
| 83 | + def test_tensor_input(self): |
| 84 | + cu_seqlens = torch.tensor([0, 128, 256]) |
| 85 | + slices = cu_seqlens_to_attn_slices(cu_seqlens, is_causal=True) |
| 86 | + self.assertEqual(len(slices), 2) |
| 87 | + |
| 88 | + def test_empty_doc(self): |
| 89 | + """Adjacent equal values in cu_seqlens create zero-length docs.""" |
| 90 | + cu_seqlens = [0, 128, 128, 256] |
| 91 | + slices = cu_seqlens_to_attn_slices(cu_seqlens) |
| 92 | + # Zero-length docs should be skipped |
| 93 | + self.assertEqual(len(slices), 2) |
| 94 | + |
| 95 | + |
| 96 | +class TestSplitSliceAtChunkBoundary(unittest.TestCase): |
| 97 | + def test_doc_within_one_chunk(self): |
| 98 | + """Document fits entirely within one chunk.""" |
| 99 | + s = AttnSlice(q_start=10, q_end=50, k_start=10, k_end=50, mask_type=MaskType.CAUSAL) |
| 100 | + result = split_slice_at_chunk_boundary(s, chunk_size=64, total_seqlen=128) |
| 101 | + self.assertEqual(len(result), 1) |
| 102 | + self.assertEqual(result[0].mask_type, MaskType.CAUSAL) |
| 103 | + self.assertEqual(result[0].q_start, 10) |
| 104 | + self.assertEqual(result[0].q_end, 50) |
| 105 | + |
| 106 | + def test_doc_spanning_two_chunks(self): |
| 107 | + """Document spans two chunks: diagonal blocks are CAUSAL, below-diagonal are FULL.""" |
| 108 | + s = AttnSlice(q_start=48, q_end=80, k_start=48, k_end=80, mask_type=MaskType.CAUSAL) |
| 109 | + result = split_slice_at_chunk_boundary(s, chunk_size=64, total_seqlen=128) |
| 110 | + |
| 111 | + # Should produce 3 sub-slices: |
| 112 | + # (chunk 0, chunk 0): q=[48,64), k=[48,64), CAUSAL |
| 113 | + # (chunk 1, chunk 0): q=[64,80), k=[48,64), FULL (below diagonal) |
| 114 | + # (chunk 1, chunk 1): q=[64,80), k=[64,80), CAUSAL (diagonal) |
| 115 | + self.assertEqual(len(result), 3) |
| 116 | + |
| 117 | + # Check that we have the expected types |
| 118 | + types = {(r.q_start // 64, r.k_start // 64): r.mask_type for r in result} |
| 119 | + self.assertEqual(types[(0, 0)], MaskType.CAUSAL) |
| 120 | + self.assertEqual(types[(1, 0)], MaskType.FULL) |
| 121 | + self.assertEqual(types[(1, 1)], MaskType.CAUSAL) |
| 122 | + |
| 123 | + def test_full_mask_stays_full(self): |
| 124 | + """FULL mask type sub-blocks are all FULL.""" |
| 125 | + s = AttnSlice(q_start=48, q_end=80, k_start=48, k_end=80, mask_type=MaskType.FULL) |
| 126 | + result = split_slice_at_chunk_boundary(s, chunk_size=64, total_seqlen=128) |
| 127 | + for r in result: |
| 128 | + self.assertEqual(r.mask_type, MaskType.FULL) |
| 129 | + |
| 130 | + |
| 131 | +class TestMakeSliceMask(unittest.TestCase): |
| 132 | + def test_full_mask(self): |
| 133 | + mask = make_slice_mask(4, 4, MaskType.FULL) |
| 134 | + self.assertTrue(mask.all()) |
| 135 | + |
| 136 | + def test_causal_square(self): |
| 137 | + mask = make_slice_mask(4, 4, MaskType.CAUSAL) |
| 138 | + expected = torch.tensor( |
| 139 | + [ |
| 140 | + [True, False, False, False], |
| 141 | + [True, True, False, False], |
| 142 | + [True, True, True, False], |
| 143 | + [True, True, True, True], |
| 144 | + ] |
| 145 | + ) |
| 146 | + self.assertTrue(torch.equal(mask, expected)) |
| 147 | + |
| 148 | + def test_causal_rectangular(self): |
| 149 | + """Bottom-right aligned causal for q_len < k_len.""" |
| 150 | + mask = make_slice_mask(2, 4, MaskType.CAUSAL) |
| 151 | + # q_len=2, k_len=4, offset = k_len - q_len = 2 |
| 152 | + # Row 0: j <= 0+2 → j in {0,1,2} |
| 153 | + # Row 1: j <= 1+2 → j in {0,1,2,3} |
| 154 | + expected = torch.tensor( |
| 155 | + [ |
| 156 | + [True, True, True, False], |
| 157 | + [True, True, True, True], |
| 158 | + ] |
| 159 | + ) |
| 160 | + self.assertTrue(torch.equal(mask, expected)) |
| 161 | + |
| 162 | + def test_invcausal_mask(self): |
| 163 | + mask = make_slice_mask(4, 4, MaskType.INVCAUSAL) |
| 164 | + expected = torch.tensor( |
| 165 | + [ |
| 166 | + [True, True, True, True], |
| 167 | + [False, True, True, True], |
| 168 | + [False, False, True, True], |
| 169 | + [False, False, False, True], |
| 170 | + ] |
| 171 | + ) |
| 172 | + self.assertTrue(torch.equal(mask, expected)) |
| 173 | + |
| 174 | + def test_bicausal_mask(self): |
| 175 | + mask = make_slice_mask(4, 4, MaskType.BICAUSAL) |
| 176 | + expected = torch.tensor( |
| 177 | + [ |
| 178 | + [True, False, False, False], |
| 179 | + [False, True, False, False], |
| 180 | + [False, False, True, False], |
| 181 | + [False, False, False, True], |
| 182 | + ] |
| 183 | + ) |
| 184 | + self.assertTrue(torch.equal(mask, expected)) |
| 185 | + |
| 186 | + |
| 187 | +if __name__ == "__main__": |
| 188 | + unittest.main() |
0 commit comments