linear.py 63.4 KB
Newer Older
1
# Copyright (c) 2022-2025, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2
3
4
5
#
# See LICENSE for license information.

"""Linear API"""
6
from typing import Callable, Dict, Optional, Tuple, Union
7
8
from functools import reduce
from operator import mul as multiply_op
9
import warnings
10
11
12

import torch

13
import transformer_engine_torch as tex
14

15
from transformer_engine.common.recipe import Recipe
16
from transformer_engine.pytorch import torch_version
17

18
from .base import (
19
20
    fill_userbuffers_buffer_for_all_gather,
    get_dummy_wgrad,
21
    get_ub,
22
    get_workspace,
23
24
25
26
27
    TransformerEngineBaseModule,
    _2X_ACC_FPROP,
    _2X_ACC_DGRAD,
    _2X_ACC_WGRAD,
)
28
from ._common import noop_cat, WeightGradStore
29
from ..fp8 import FP8GlobalStateManager
30
31
from ..utils import (
    cast_if_needed,
32
    clear_tensor_data,
33
    divide,
34
    init_method_constant,
35
36
    requires_grad,
    needs_quantized_gemm,
37
    assert_dim_for_fp8_exec,
38
39
    nvtx_range_pop,
    nvtx_range_push,
40
41
42
43
44
)
from ..distributed import (
    set_tensor_model_parallel_attributes,
    get_distributed_world_size,
    allreduce,
45
    symmetric_all_reduce,
46
47
    reduce_scatter_along_first_dim,
    gather_along_first_dim,
48
    is_fp8_activation_recompute_enabled,
49
    in_fp8_activation_recompute_phase,
50
51
    _fsdp_scatter_tensors,
    _fsdp_gather_tensors,
52
53
)
from ..cpp_extensions import (
54
    general_gemm,
55
)
56
from ..constants import GemmParallelModes, dist_group_type
57
from ..jit import no_torch_dynamo
58
from ..graph import is_graph_capturing
59
60
from ..tensor.quantized_tensor import (
    QuantizedTensor,
61
    QuantizedTensorBase,
62
63
64
65
    Quantizer,
    prepare_for_saving,
    restore_from_saved,
)
66
from ..tensor.float8_tensor import Float8CurrentScalingQuantizer, Float8Quantizer
67
from ..tensor.mxfp8_tensor import MXFP8Quantizer
68
from ..tensor._internal.mxfp8_tensor_base import MXFP8TensorBase
69
from ..tensor.float8_blockwise_tensor import Float8BlockQuantizer
70
from ..cpu_offload import is_cpu_offload_enabled, mark_activation_offload
71
72
from ...debug.pytorch.debug_state import TEDebugState
from ...debug.pytorch.utils import any_feature_enabled
73

74
75
76
77
78
79
80
81
82
83
84
__all__ = ["Linear"]


class _Linear(torch.autograd.Function):
    """Linear semi-top level module
    Calls custom cuda extensions.
    """

    @staticmethod
    def forward(
        ctx,
85
        weight: torch.Tensor,
86
        inp: torch.Tensor,
87
        bias: Optional[torch.Tensor],
88
89
90
        is_first_microbatch: Union[bool, None],
        fp8: bool,
        fp8_calibration: bool,
91
        wgrad_store: WeightGradStore,
92
93
94
95
        input_quantizer: Optional[Quantizer],
        weight_quantizer: Optional[Quantizer],
        output_quantizer: Optional[Quantizer],
        grad_input_quantizer: Optional[Quantizer],
96
97
        grad_weight_quantizer: Optional[Quantizer],
        grad_output_quantizer: Optional[Quantizer],
98
        fuse_wgrad_accumulation: bool,
99
        cpu_offloading: bool,
100
101
102
103
104
105
106
        tp_group: Union[dist_group_type, None],
        tp_size: int,
        sequence_parallel: bool,
        tensor_parallel: bool,
        activation_dtype: torch.dtype,
        parallel_mode: Union[str, None],
        is_grad_enabled: bool,
107
108
109
110
111
112
        ub_overlap_rs_fprop: bool,
        ub_overlap_ag_dgrad: bool,
        ub_overlap_ag_fprop: bool,
        ub_overlap_rs_dgrad: bool,
        ub_bulk_dgrad: bool,
        ub_bulk_wgrad: bool,
113
        ub_name: str,
114
        fp8_output: bool,  # pylint: disable=unused-argument
115
        fsdp_group: Union[dist_group_type, None],
116
117
        module: torch.nn.Module,
        skip_fp8_weight_update: bool,
118
        symmetric_ar_type: str,
119
        debug: Optional[bool] = False,
120
    ) -> torch.Tensor:
121
        # pylint: disable=missing-function-docstring
122

123
124
125
126
127
        # NVTX label for profiling
        nvtx_label = "transformer_engine._Linear.forward"
        if ub_name is not None:
            nvtx_label = f"{nvtx_label}.{ub_name}"

128
        # Make sure input dimensions are compatible
129
        out_features, in_features = weight.shape
130
        assert inp.shape[-1] == in_features, "GEMM not possible"
131

132
        # Configure tensor-parallel communication
133
        tp_world_size = get_distributed_world_size(tp_group)
134
135
136
137
        backward_needs_input = is_grad_enabled and weight.requires_grad
        with_input_all_gather_nccl = (
            parallel_mode == "column" and sequence_parallel and not ub_overlap_ag_fprop
        )
138
139
140

        # Do TP communication in high precision if quantized format
        # does not support communication
141
142
        force_hp_input_gather = (
            fp8 and with_input_all_gather_nccl and isinstance(input_quantizer, Float8BlockQuantizer)
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
        )

        # Configure Userbuffers communication (comm+GEMM overlap)
        ub_obj = None
        ub_type = None
        if ub_overlap_rs_fprop:
            ub_obj = get_ub(ub_name + "_fprop")
            ub_type = tex.CommOverlapType.RS
        elif ub_overlap_ag_fprop:
            ub_obj = get_ub(ub_name + "_fprop")
            ub_type = tex.CommOverlapType.AG

        # ------------------------------------------------------
        # Prepare input tensor
        # Note: Cast to expected dtype and perform tensor-parallel communication
        # ------------------------------------------------------
        nvtx_range_push(f"{nvtx_label}.input_cast_comm")
        inputmat = inp  # Input tensor to save for backward (maybe sharded)
        inputmat_total = None  # Input tensor to pass to GEMM (gathered)
        own_quantized_input = False
163
        if fp8:
164
            assert_dim_for_fp8_exec(inputmat, weight)
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
        if with_input_all_gather_nccl or ub_overlap_ag_fprop:  # All-gather input tensor

            # Cast local input tensor if needed
            if fp8 or debug:
                if input_quantizer is None:
                    raise ValueError("Missing quantizer for input tensor")
                if not force_hp_input_gather and not isinstance(inputmat, QuantizedTensorBase):
                    input_quantizer.set_usage(rowwise=True, columnwise=backward_needs_input)
                    if isinstance(
                        input_quantizer, (Float8Quantizer, Float8CurrentScalingQuantizer)
                    ):
                        # All-gather is not supported with FP8 column-wise data
                        input_quantizer.set_usage(columnwise=False)
                    inputmat = input_quantizer(inputmat)
                    own_quantized_input = True
180
            else:
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
                inputmat = cast_if_needed(inp, activation_dtype)  # Cast for AMP

            # Initialize gathered input tensor
            quantizer = None
            if fp8 or debug:
                quantizer = input_quantizer
                quantizer.set_usage(rowwise=True, columnwise=False)
            if with_input_all_gather_nccl:  # Perform NCCL all-gather
                inputmat_total, _ = gather_along_first_dim(
                    inputmat,
                    tp_group,
                    quantizer=quantizer,
                )
            elif ub_overlap_ag_fprop:  # Initialize Userbuffers all-gather
                inputmat_total, _ = fill_userbuffers_buffer_for_all_gather(
                    ub_obj,
                    inputmat,
                    quantizer,
                    tp_group,
                )

        else:  # Do not all-gather input tensor
            if fp8 or debug:
                if isinstance(inputmat, QuantizedTensorBase):
                    inputmat.update_usage(rowwise_usage=True)
206
                else:
207
208
209
                    if input_quantizer is None:
                        raise ValueError("Missing quantizer for input tensor")
                    input_quantizer.set_usage(rowwise=True, columnwise=backward_needs_input)
210
                    inputmat = input_quantizer(inputmat)
211
                    own_quantized_input = True
212
            else:
213
214
                inputmat = cast_if_needed(inp, activation_dtype)  # Cast for AMP
            inputmat_total = inputmat
215
        nvtx_range_pop(f"{nvtx_label}.input_cast_comm")
216
217
218
        # ------------------------------------------------------
        # Input tensor is ready for GEMM...
        # ------------------------------------------------------
219

220
221
222
        # ------------------------------------------------------
        # Prepare weight tensor
        # ------------------------------------------------------
223
224
        weightmat = weight
        if fp8 or debug:
225
226
227
228
229
230
231
232
233
            # Configure quantizer
            if weight_quantizer is not None:
                columnwise_usage = is_grad_enabled and inp.requires_grad
                if not columnwise_usage:
                    columnwise_usage = (
                        is_fp8_activation_recompute_enabled()
                        and not in_fp8_activation_recompute_phase()
                    )
                weight_quantizer.set_usage(rowwise=True, columnwise=columnwise_usage)
234
235

            # Get quantized weight
236
237
238
239
240
241
242
243
            update_workspace = is_first_microbatch is None or is_first_microbatch
            weightmat = module.get_weight_workspace(
                tensor=weight,
                quantizer=weight_quantizer,
                cache_name=(None if is_first_microbatch is None else "weight"),
                update_workspace=update_workspace,
                skip_update_flag=skip_fp8_weight_update,
                fsdp_group=fsdp_group,
244
                workspace_dtype=activation_dtype,
245
            )
246
247
            weightmat.update_usage(rowwise_usage=True)

248
        else:
249
250
251
252
            weightmat = cast_if_needed(weightmat, activation_dtype)  # Cast for AMP
        # ------------------------------------------------------
        # Weight tensor is ready for GEMM...
        # ------------------------------------------------------
253
254
255

        # Cast bias to expected dtype
        bias_dtype = activation_dtype
256
        if needs_quantized_gemm(inputmat_total) and activation_dtype == torch.float32:
257
            # cuBLAS does not support FP8 GEMM with FP32 bias, so we cast to BF16
258
259
260
261
262
263
264
265
266
267
            bias_dtype = torch.bfloat16
        bias = cast_if_needed(bias, bias_dtype) if bias is not None else bias

        # Calibrate quantizers if needed
        if not fp8 and fp8_calibration:
            if input_quantizer is not None:
                input_quantizer.calibrate(inputmat_total)
            if weight_quantizer is not None:
                weight_quantizer.calibrate(weight)

268
269
        # Choose whether to use GEMM kernel with split accumulator
        use_split_accumulator = _2X_ACC_FPROP
270
271
272
        if fp8:
            recipe = FP8GlobalStateManager.get_fp8_recipe()
            if hasattr(recipe, "fp8_gemm_fprop"):
273
274
275
276
277
                use_split_accumulator = recipe.fp8_gemm_fprop.use_split_accumulator

        # Configure output quantizer
        if output_quantizer is not None:
            output_quantizer.set_usage(rowwise=True, columnwise=False)
278

279
280
281
282
283
284
285
286
287
288
289
290
291
292
        # Output buffer for Userbuffers reduce-scatter
        reduce_scatter_out = None
        if ub_overlap_rs_fprop:
            out_shape = list(inp.shape)
            out_shape[0] //= tp_world_size
            out_shape[-1] = out_features
            reduce_scatter_out = torch.empty(out_shape, dtype=activation_dtype, device=inp.device)

        # ------------------------------------------------------
        # Forward GEMM
        # Note: y = x * w^T
        # ------------------------------------------------------
        nvtx_range_push(f"{nvtx_label}.gemm")
        gemm_out, *_, reduce_scatter_out = general_gemm(
293
294
295
296
            weightmat,
            inputmat_total,
            get_workspace(),
            quantization_params=output_quantizer,
297
            out_dtype=activation_dtype,
298
            bias=bias,
299
            use_split_accumulator=use_split_accumulator,
300
301
            ub=ub_obj,
            ub_type=ub_type,
302
            extra_output=reduce_scatter_out,
303
        )
304
        nvtx_range_pop(f"{nvtx_label}.gemm")
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
        # ------------------------------------------------------
        # Finished forward GEMM...
        # ------------------------------------------------------

        # ------------------------------------------------------
        # Prepare output tensor
        # Note: Perform tensor-parallel communication
        # ------------------------------------------------------
        out = None
        if ub_overlap_rs_fprop:
            out = reduce_scatter_out
        elif parallel_mode == "row" and tp_size > 1:
            nvtx_range_push(f"{nvtx_label}.row_parallel_comm")
            out = gemm_out
            if sequence_parallel:
                out, _ = reduce_scatter_along_first_dim(out, tp_group)
            elif tensor_parallel:
                if symmetric_ar_type is not None:
                    out, _ = symmetric_all_reduce(out, tp_group, all_reduce_type=symmetric_ar_type)
                else:
                    out, _ = allreduce(out, tp_group)
            nvtx_range_pop(f"{nvtx_label}.row_parallel_comm")
        else:
            out = gemm_out
        # ------------------------------------------------------
        # Output tensor is ready to return...
        # ------------------------------------------------------

        # ------------------------------------------------------
        # Cache state for backward pass
        # ------------------------------------------------------
336
337

        if is_grad_enabled:
338
            ctx.weight_quantizer = weight_quantizer
339
            saved_inputmat = None
340
341
342
343
344

            ctx.backward_input_needs_gather = (
                weight.requires_grad and parallel_mode == "column" and sequence_parallel
            )

345
            if backward_needs_input:
346
                if own_quantized_input and isinstance(inputmat, QuantizedTensorBase):
347
348
349
350
                    # For sequence parallel in vanilla FP8, rowwise data is
                    # to gather the input. For MXFP8, columnwise only data
                    # can be allgathered.
                    if isinstance(inputmat, MXFP8TensorBase) or not ctx.backward_input_needs_gather:
351
                        inputmat.update_usage(rowwise_usage=False, columnwise_usage=True)
352
                if force_hp_input_gather:
353
                    assert not isinstance(inputmat, QuantizedTensorBase)
354
                saved_inputmat = inputmat
355

356
357
            # Weight with column-wise usage is needed for dgrad GEMM.
            if inp.requires_grad:
358
                if isinstance(weightmat, QuantizedTensorBase):
359
360
                    weightmat.update_usage(columnwise_usage=True)

361
362
            if cpu_offloading and saved_inputmat is not None:
                mark_activation_offload(saved_inputmat)
363

364
365
            # Scatter intermediate/activation tensors saved for the backward pass
            # NOTE: FSDP sharding is not valid for models initialized with primary Fp8 weights
366
            nvtx_range_push(f"{nvtx_label}.fsdp_scatter")
367
368
369
            ctx.fsdp_group = fsdp_group
            ctx.fsdp_shapes = _fsdp_scatter_tensors(
                fsdp_group,
370
                saved_inputmat,
371
                weightmat if fp8 and not isinstance(weight, QuantizedTensorBase) else None,
372
            )
373
            nvtx_range_pop(f"{nvtx_label}.fsdp_scatter")
374

375
376
377
378
379
380
381
382
383
384
385
            if cpu_offloading:
                ctx.grad_added_to_main_grad = hasattr(weight, "grad_added_to_main_grad")

                if ctx.grad_added_to_main_grad:
                    # If you are passing torch.nn.Parameter through the Torch hooks, you will
                    # get back torch.Tensor. Torch rips off the Parameter wrapper.
                    # You need to preserve the weight object to have all the attributes user
                    # sets for the weights. Because of this, it is not recommended to offload
                    # weights if weights are externally touched outside this module
                    ctx.weight_object = weight

386
387
            # TODO(ksivamani): Check memory usage
            tensors_to_save, tensor_objects = prepare_for_saving(
388
                saved_inputmat,
389
                weightmat,
390
                weight,
391
                bias,
392
            )
393
394
            ctx.save_for_backward(*tensors_to_save)
            ctx.tensor_objects = tensor_objects
395

396
397
            ctx.activation_dtype = activation_dtype
            ctx.fp8 = fp8
398
399
            ctx.fp8_recipe = FP8GlobalStateManager.get_fp8_recipe() if fp8 else None
            ctx.force_hp_input_gather = force_hp_input_gather
400
401
            ctx.input_quantizer = input_quantizer
            ctx.grad_input_quantizer = grad_input_quantizer
402
403
            ctx.grad_weight_quantizer = grad_weight_quantizer
            ctx.grad_output_quantizer = grad_output_quantizer
404
            ctx.fuse_wgrad_accumulation = fuse_wgrad_accumulation
405
406
407
            if fuse_wgrad_accumulation and weight.requires_grad:
                ctx.main_grad = weight.main_grad

408
            ctx.debug = debug
409
            ctx.cpu_offloading = cpu_offloading
410
            ctx.is_first_microbatch = is_first_microbatch
411
            ctx.use_bias = bias is not None
412
413
            ctx.sequence_parallel = sequence_parallel
            ctx.tensor_parallel = tensor_parallel
414
            ctx.inp_shape = inp.shape
415
416
            ctx.parallel_mode = parallel_mode
            ctx.tp_group = tp_group
417
418
419
420
            ctx.ub_overlap_ag = ub_overlap_ag_dgrad
            ctx.ub_overlap_rs_dgrad = ub_overlap_rs_dgrad
            ctx.ub_bulk_dgrad = ub_bulk_dgrad
            ctx.ub_bulk_wgrad = ub_bulk_wgrad
421
            ctx.ub_name = ub_name
422
423
            ctx.tp_size = tp_size
            ctx.requires_dgrad = inp.requires_grad
424
            ctx.requires_wgrad = weight.requires_grad
425
            ctx.reduce_and_update_bwd_fp8_tensors = False
426

427
            ctx.owns_input = saved_inputmat is not inp
428
            if ctx.fp8 and requires_grad(inp, weight, bias):
429
430
431
432
                _first_fp8_module = FP8GlobalStateManager.IS_FIRST_FP8_MODULE
                ctx.reduce_and_update_bwd_fp8_tensors = FP8GlobalStateManager.is_first_fp8_module()
                if in_fp8_activation_recompute_phase():
                    FP8GlobalStateManager.IS_FIRST_FP8_MODULE = _first_fp8_module
433
            ctx.wgrad_store = wgrad_store
434

435
436
437
        # ------------------------------------------------------
        # Cached state for backward pass is ready...
        # ------------------------------------------------------
438

439
        return out
440
441

    @staticmethod
442
    def backward(ctx, grad_output: torch.Tensor) -> Tuple[Union[torch.Tensor, None], ...]:
443
        # pylint: disable=missing-function-docstring
444

445
446
447
448
449
        # NVTX label for profiling
        nvtx_label = "transformer_engine._Linear.backward"
        if ctx.ub_name is not None:
            nvtx_label = f"{nvtx_label}.{ctx.ub_name}"

450
        with torch.cuda.nvtx.range("_Linear_backward"):
451
452
453
454
            saved_tensors = ctx.saved_tensors
            inputmat, weight_fp8, weight, bias = (  # pylint: disable=unbalanced-tuple-unpacking
                restore_from_saved(ctx.tensor_objects, saved_tensors)
            )
455

456
457
458
            # Delete the references to tensor objects once they've been consumed
            # by the `restore_from_saved` method to construct back the actual tensors.
            ctx.tensor_objects = None
459
460
461
462
463
464
465
466

            # Since main_grad can be modified inplace, it should not be a part of saved_tensors
            main_grad = (
                ctx.main_grad
                if weight is not None and ctx.fuse_wgrad_accumulation and ctx.requires_wgrad
                else None
            )

467
468
469
470
471
            if ctx.cpu_offloading:
                if ctx.grad_added_to_main_grad:
                    weight = ctx.weight_object
                if ctx.requires_wgrad and ctx.fuse_wgrad_accumulation:
                    weight.main_grad = main_grad
472

473
474
475
            # Gather intermediate/activation tensors if needed
            # NOTE: weight_fp8 = weight when ctx.fp8 == False and torch.disttributed.FSDP already
            #       shards/unshards the base weights so we don't do it ourselves
476
            nvtx_range_push(f"{nvtx_label}.fsdp_gather")
477
478
479
480
            _fsdp_gather_tensors(
                ctx.fsdp_group,
                ctx.fsdp_shapes,
                inputmat,
481
                weight_fp8,
482
            )
483
            nvtx_range_pop(f"{nvtx_label}.fsdp_gather")
484

485
            # Configure Userbuffers communication (comm+GEMM overlap)
486
            ctx.ub_obj_gradout = None
487
            ub_obj_dgrad = None
488
            ub_obj_wgrad = None
489
490
            ub_type_dgrad = None
            ub_type_wgrad = None
491
            dgrad_shape = [reduce(multiply_op, ctx.inp_shape[:-1]), ctx.inp_shape[-1]]
492
            if ctx.ub_overlap_ag:
493
                # Overlap grad_output all-gather with dgrad compute
494
                ctx.ub_obj_gradout = get_ub(ctx.ub_name + "_dgrad")
495
496
                ub_obj_dgrad = ctx.ub_obj_gradout
                ub_type_dgrad = tex.CommOverlapType.AG
497
498
499
            elif ctx.ub_overlap_rs_dgrad:
                # Overlap dgrad reduce-scatter with dgrad compute
                ctx.ub_obj_gradout = get_ub(ctx.ub_name + "_dgrad")
500
501
                ub_obj_dgrad = ctx.ub_obj_gradout
                ub_type_dgrad = tex.CommOverlapType.RS
502
503
504
505
            else:
                if ctx.ub_bulk_dgrad:
                    # Overlap inputmat all-gather with dgrad compute
                    ctx.ub_obj_gradout = get_ub(ctx.ub_name + "_dgrad")
506
507
                    ub_obj_dgrad = ctx.ub_obj_gradout
                    ub_type_dgrad = tex.CommOverlapType.AG
508
509
510
                if ctx.ub_bulk_wgrad:
                    # Overlap dgrad reduce-scatter with wgrad compute
                    ub_obj_wgrad = get_ub(ctx.ub_name + "_wgrad")
511
                    ub_type_wgrad = tex.CommOverlapType.RS
512
513
514
515
516
517
518
519

            # --------------------------------------------------
            # Prepare grad output tensor
            # Note: Cast to expected dtype and perform tensor-parallel communication
            # --------------------------------------------------

            # Unmodified grad output tensor
            grad_output_arg = grad_output
520

521
522
523
524
            # Configure quantizer for grad output tensor
            # Note: dgrad GEMM requires row-wise usage, wgrad GEMM
            # requires column-wise usage
            if ctx.grad_output_quantizer is not None:
525
526
527
528
529
530
531
                quantizer = ctx.grad_output_quantizer
                quantizer.set_usage(rowwise=True, columnwise=True)
                if ctx.ub_overlap_ag:
                    # Userbuffers only supports communication for one
                    # tensor usage at a time. Configure quantizer with
                    # usage for only dgrad GEMM.
                    quantizer.set_usage(columnwise=False)
532

533
            # Prepare grad output tensor
534
            nvtx_range_push(f"{nvtx_label}.grad_output_preprocess")
535
536
537
538
            (
                grad_output,
                grad_bias,
            ) = TransformerEngineBaseModule.grad_output_preprocess(
539
540
541
542
                ctx,
                grad_output,
                ctx.parallel_mode == "row",
                ctx.grad_output_quantizer,
543
            )
544
            nvtx_range_pop(f"{nvtx_label}.grad_output_preprocess")
545

546
547
548
549
550
551
552
553
554
555
            # --------------------------------------------------
            # Grad output tensor is ready for computing grad input...
            # --------------------------------------------------

            # --------------------------------------------------
            # Prepare input tensor
            # Note: Input tensor is needed for wgrad GEMM.
            # Tensor-parallel communication is overlapped with dgrad
            # GEMM.
            # --------------------------------------------------
556
            inputmat_total = None
557
            inputmat_total_work = None
558
            if ctx.backward_input_needs_gather:
559
                quantizer = None
560
                if (ctx.fp8 or ctx.debug) and not ctx.force_hp_input_gather:
561
                    quantizer = ctx.input_quantizer
562
563
564
565
566
567
                    if isinstance(quantizer, (Float8Quantizer, Float8CurrentScalingQuantizer)):
                        # If data is in FP8, we compute FP8 transposes manually
                        quantizer.set_usage(rowwise=True, columnwise=False)
                    else:
                        # wgrad GEMM requires input with column-wise usage
                        quantizer.set_usage(rowwise=False, columnwise=True)
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
                if ctx.ub_bulk_dgrad:
                    inputmat_total, _ = fill_userbuffers_buffer_for_all_gather(
                        ub_obj_dgrad,
                        inputmat,
                        quantizer,
                        ctx.tp_group,
                    )
                else:
                    nvtx_range_push(f"{nvtx_label}.column_parallel_comm_input")
                    inputmat_total, inputmat_total_work = gather_along_first_dim(
                        inputmat,
                        ctx.tp_group,
                        async_op=True,
                        quantizer=quantizer,
                    )
                    nvtx_range_pop(f"{nvtx_label}.column_parallel_comm_input")
584
585
            else:
                inputmat_total = inputmat
586
587
588
            # --------------------------------------------------
            # Input tensor is ready for computing grad weight...
            # --------------------------------------------------
589

590
            # --------------------------------------------------
591
            # Compute grad input tensor
592
593
            # --------------------------------------------------

594
595
            dgrad = None
            dgrad_work = None
596
            if ctx.requires_dgrad:
597

598
599
600
601
602
603
604
605
                # Make sure required data is available
                if isinstance(grad_output, QuantizedTensorBase):
                    grad_output.update_usage(rowwise_usage=True)
                if ctx.weight_quantizer is not None and isinstance(weight_fp8, QuantizedTensorBase):
                    weight_fp8.update_usage(columnwise_usage=True)

                # Choose whether to use GEMM kernel with split accumulator
                use_split_accumulator = _2X_ACC_DGRAD
606
607
608
                if ctx.fp8:
                    recipe = ctx.fp8_recipe
                    if hasattr(recipe, "fp8_gemm_dgrad"):
609
                        use_split_accumulator = recipe.fp8_gemm_dgrad.use_split_accumulator
610

611
612
613
614
615
616
617
618
619
620
                # Update grad input quantizer
                if ctx.grad_input_quantizer is not None:
                    ctx.grad_input_quantizer.set_usage(rowwise=True, columnwise=False)

                # Output buffers for Userbuffers reduce-scatter
                gemm_out = None
                reduce_scatter_out = None
                if ctx.ub_overlap_rs_dgrad:
                    reduce_scatter_out = torch.empty(
                        dgrad_shape, dtype=ctx.activation_dtype, device=grad_output_arg.device
621
                    )
622
623
                elif ctx.ub_bulk_wgrad:
                    gemm_out = ub_obj_wgrad.get_buffer(local_chunk=False)
624

625
626
627
628
                # dgrad GEMM
                # Note: dx = dy * w
                nvtx_range_push(f"{nvtx_label}.dgrad_gemm")
                gemm_out, *_, reduce_scatter_out = general_gemm(
629
630
631
632
633
634
                    weight_fp8,
                    grad_output,
                    get_workspace(),
                    layout="NN",
                    grad=True,
                    quantization_params=ctx.grad_input_quantizer,
635
                    out=gemm_out,
636
                    out_dtype=ctx.activation_dtype,
637
                    use_split_accumulator=use_split_accumulator,
638
639
                    ub=ub_obj_dgrad,
                    ub_type=ub_type_dgrad,
640
                    extra_output=reduce_scatter_out,
641
642
                    bulk_overlap=ctx.ub_bulk_dgrad,
                )
643
                nvtx_range_pop(f"{nvtx_label}.dgrad_gemm")
644

645
646
                # Prepare grad input tensor
                # Note: Perform tensor-parallel communication
647
                if ctx.ub_overlap_rs_dgrad:
648
649
650
651
                    dgrad = reduce_scatter_out
                elif ctx.ub_bulk_wgrad:
                    dgrad = ub_obj_wgrad.get_buffer(local_chunk=True)
                elif ctx.parallel_mode == "column" and ctx.tp_size > 1:
652
                    nvtx_range_push(f"{nvtx_label}.column_parallel_comm_dgrad")
653
                    dgrad = gemm_out
654
655
656
657
658
                    if ctx.sequence_parallel:
                        dgrad, dgrad_work = reduce_scatter_along_first_dim(
                            dgrad,
                            ctx.tp_group,
                            async_op=True,
659
                        )
660
                    else:
661
                        dgrad, dgrad_work = allreduce(dgrad, ctx.tp_group, async_op=True)
662
                    nvtx_range_pop(f"{nvtx_label}.column_parallel_comm_dgrad")
663
664
665
666
667
668
669
670
671
672
                else:
                    dgrad = gemm_out

            # --------------------------------------------------
            # Grad input tensor has been computed...
            # --------------------------------------------------

            # --------------------------------------------------
            # Compute grad weight
            # --------------------------------------------------
673

674
675
            wgrad = None
            if ctx.requires_wgrad:
676

677
678
679
                # Prepare input tensor
                # Note: Synchronize tensor-parallel communication and
                # make sure required data is available
680
681
682
                if inputmat_total_work is not None:
                    inputmat_total_work.wait()
                    inputmat_total_work = None
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
                if ctx.fp8 or ctx.debug:
                    if isinstance(inputmat_total, QuantizedTensorBase):
                        inputmat_total.update_usage(columnwise_usage=True)
                    else:
                        ctx.input_quantizer.set_usage(rowwise=False, columnwise=True)
                        inputmat_total = ctx.input_quantizer(inputmat_total)

                # Prepare grad output tensor
                # Note: Synchronize tensor-parallel communication and
                # make sure required data is available
                if ctx.ub_overlap_ag and isinstance(ctx.grad_output_quantizer, MXFP8Quantizer):
                    # UB does not support overlapping grad output
                    # all-gather with wgrad GEMM. Also, we can't
                    # convert row-scaled MXFP8 to column-scaled, so we
                    # can't reuse the grad output that was gathered
                    # for the dgrad GEMM. We work around with blocking
                    # all-gather for column-scaled MXFP8 data.
                    ctx.grad_output_quantizer.set_usage(rowwise=False, columnwise=True)
                    grad_output, _ = gather_along_first_dim(
                        grad_output_arg,
                        ctx.tp_group,
                        quantizer=ctx.grad_output_quantizer,
                    )
                if ctx.fp8 or ctx.debug:
                    if isinstance(grad_output, QuantizedTensorBase):
                        grad_output.update_usage(columnwise_usage=True)
                    else:
                        ctx.grad_output_quantizer.set_usage(rowwise=False, columnwise=True)
                        grad_output = ctx.grad_output_quantizer(grad_output)
712

713
714
715
716
717
718
719
                # Figure out whether to use split accumulator
                use_split_accumulator = _2X_ACC_WGRAD
                if ctx.fp8:
                    recipe = ctx.fp8_recipe
                    if hasattr(recipe, "fp8_gemm_wgrad"):
                        use_split_accumulator = recipe.fp8_gemm_wgrad.use_split_accumulator

720
721
722
723
724
725
726
727
728
                # Figure out whether to output wgrad GEMM directly into main grad
                if ctx.is_first_microbatch is not None:
                    accumulate_wgrad_into_param_main_grad = (
                        ctx.fuse_wgrad_accumulation and not ctx.is_first_microbatch
                    )
                else:
                    accumulate_wgrad_into_param_main_grad = ctx.fuse_wgrad_accumulation

                # Output buffer for overlapping FP8 grad input
729
                # reduce-scatter with wgrad GEMM
730
                reduce_scatter_out = None
731
                if ctx.ub_bulk_wgrad and ub_obj_wgrad.is_fp8_ubuf():
732
733
                    reduce_scatter_out = torch.empty(
                        dgrad_shape, dtype=ctx.activation_dtype, device=grad_output_arg.device
734
735
                    )

736
737
738
739
                # Arguments to include in wgrad GEMM closure
                wgrad_gemm_kwargs = {
                    "workspace": get_workspace(),
                    "out_dtype": (
740
741
                        main_grad.dtype if ctx.fuse_wgrad_accumulation else ctx.activation_dtype
                    ),
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
                    "quantization_params": ctx.grad_weight_quantizer,
                    "accumulate": accumulate_wgrad_into_param_main_grad,
                    "layout": "NT",
                    "out": main_grad if ctx.fuse_wgrad_accumulation else None,
                    "bias": (bias if (grad_bias is None and not ctx.fp8) else None),
                    "use_split_accumulator": use_split_accumulator,
                    "grad": True,
                    "ub": ub_obj_wgrad,
                    "ub_type": ub_type_wgrad,
                    "extra_output": reduce_scatter_out,
                    "bulk_overlap": ctx.ub_bulk_wgrad,
                }

                def wgrad_gemm(
                    x: torch.Tensor,
                    dy: torch.Tensor,
                ) -> Tuple[torch.Tensor, torch.Tensor, torch.Tensor]:
                    """Perform wgrad GEMM: dw = dy^T * x

                    May be fused with bgrad computation.

                    May be called outside of this function to enable
                    some advanced communication/compute overlapping.

                    """
                    nvtx_range_push(f"{nvtx_label}.wgrad_gemm")
                    dw, db, *_ = general_gemm(x, dy, **wgrad_gemm_kwargs)
                    nvtx_range_pop(f"{nvtx_label}.wgrad_gemm")
                    return dw, db

                # Choose whether to call wgrad GEMM now or delay
773
                if ctx.wgrad_store is not None and ctx.wgrad_store.delay_wgrad_compute():
774
775
776
777
778
779
780
781
782
783
784
                    if (
                        wgrad_gemm_kwargs["ub"] is not None
                        or wgrad_gemm_kwargs["ub_type"] is not None
                        or wgrad_gemm_kwargs["extra_output"] is not None
                        or wgrad_gemm_kwargs["bulk_overlap"]
                    ):
                        raise NotImplementedError(
                            "Delayed weight grad computation is not supported "
                            "with Userbuffers (tensor-parallel communication overlapping)"
                        )
                    ctx.wgrad_store.put([inputmat_total, grad_output], wgrad_gemm)
785
786
                else:

787
788
789
790
                    # Call wgrad GEMM now
                    wgrad, grad_bias_ = wgrad_gemm(inputmat_total, grad_output)

                    # Update grad bias if needed
791
792
793
794
                    if grad_bias is None:
                        grad_bias = grad_bias_
                    del grad_bias_

795
                    # Deallocate input tensor if permitted
796
797
                    if ctx.owns_input:
                        clear_tensor_data(inputmat_total)
798

799
                # Update grad input if overlapping reduce-scatter with wgrad GEMM
800
801
                if ctx.ub_bulk_wgrad:
                    if ub_obj_wgrad.is_fp8_ubuf():
802
                        dgrad = reduce_scatter_out
803
                    else:
804
805
806
807
808
                        dgrad = ub_obj_wgrad.get_buffer(local_chunk=True).clone()

            # --------------------------------------------------
            # Grad weight has been computed...
            # --------------------------------------------------
809

810
            # Don't return grad bias if not needed
811
812
813
            if not ctx.use_bias:
                grad_bias = None

814
            # Make sure all tensor-parallel communication is finished
815
816
817
818
819
820
821
822
            if inputmat_total_work is not None:
                inputmat_total_work.wait()
                inputmat_total_work = None
            if dgrad_work is not None:
                dgrad_work.wait()
                dgrad_work = None

        if ctx.requires_wgrad:
823
            # Handle custom DDP from mcore.
824
825
826
827
828
            if (
                ctx.fuse_wgrad_accumulation
                and weight is not None
                and hasattr(weight, "grad_added_to_main_grad")
            ):
829
                weight.grad_added_to_main_grad = True
830
                if getattr(weight, "zero_out_wgrad", False):
831
832
833
834
                    wgrad = get_dummy_wgrad(
                        list(weight.main_grad.shape),
                        weight.dtype,
                        zero=True,
835
                    )
836
                else:
837
838
839
                    wgrad = get_dummy_wgrad(
                        list(weight.main_grad.shape),
                        weight.dtype,
840
                    )
841
842
843
844
            elif ctx.fuse_wgrad_accumulation:
                wgrad = None
        else:
            wgrad = None
845

846
        # Update FP8 scaling factors if needed
847
        if ctx.reduce_and_update_bwd_fp8_tensors and not is_graph_capturing():
848
            nvtx_range_push(f"{nvtx_label}.reduce_and_update_fp8_tensors")
849
            FP8GlobalStateManager.reduce_and_update_fp8_tensors(forward=False)
850
            nvtx_range_pop(f"{nvtx_label}.reduce_and_update_fp8_tensors")
851

852
        # Scatter fp8 weight buffers
853
        if ctx.fp8 and not isinstance(weight, QuantizedTensorBase):
854
            _fsdp_scatter_tensors(ctx.fsdp_group, weight_fp8)
855
        return (
856
            wgrad,
857
858
            dgrad.view(ctx.inp_shape) if ctx.requires_dgrad else None,
            grad_bias,
859
860
861
            None,  # is_first_microbatch
            None,  # fp8
            None,  # fp8_calibration
862
            None,  # wgrad_store
863
864
865
866
            None,  # input_quantizer
            None,  # weight_quantizer
            None,  # output_quantizer
            None,  # grad_input_quantizer
867
868
            None,  # grad_weight_quantizer
            None,  # grad_output_quantizer
869
870
871
872
873
874
875
876
877
            None,  # fuse_wgrad_accumulation
            None,  # cpu_offloading
            None,  # tp_group
            None,  # tp_size
            None,  # sequence_parallel
            None,  # tensor_parallel
            None,  # activation_dtype
            None,  # parallel_mode
            None,  # is_grad_enabled
878
879
880
881
882
883
            None,  # ub_overlap_rs_fprop
            None,  # ub_overlap_ag_dgrad
            None,  # ub_overlap_ag_fprop
            None,  # ub_overlap_rs_dgrad
            None,  # ub_bulk_dgrad
            None,  # ub_bulk_wgrad
884
            None,  # ub_name
885
            None,  # fp8_output
886
            None,  # fsdp_group
887
888
            None,  # module
            None,  # skip_fp8_weight_update
889
            None,  # symmetric_ar_type
890
            None,  # debug
891
892
893
894
        )


class Linear(TransformerEngineBaseModule):
895
    """Applies a linear transformation to the incoming data :math:`y = xA^T + b`
896
897
898
899
900
901
902
903
904
905
906
907
908
909

    On NVIDIA GPUs it is a drop-in replacement for `torch.nn.Linear`.

    Parameters
    ----------
    in_features : int
                 size of each input sample.
    out_features : int
                  size of each output sample.
    bias : bool, default = `True`
          if set to `False`, the layer will not learn an additive bias.
    init_method : Callable, default = `None`
                 used for initializing weights in the following way: `init_method(weight)`.
                 When set to `None`, defaults to `torch.nn.init.normal_(mean=0.0, std=0.023)`.
910
    get_rng_state_tracker : Callable, default = `None`
911
                 used to get the random number generator state tracker for initializing weights.
912
913
    rng_tracker_name : str, default = `None`
                 the param passed to get_rng_state_tracker to get the specific rng tracker.
cyanguwa's avatar
cyanguwa committed
914
    parameters_split : Optional[Union[Tuple[str, ...], Dict[str, int]]], default = None
915
916
917
918
919
920
921
                      Configuration for splitting the weight and bias tensors along dim 0 into
                      multiple PyTorch parameters. If a list or tuple of strings is provided,
                      they are used to make the names of equally-sized parameters. If a dict
                      (preferably an OrderedDict) is provided, the keys are used as names and
                      values as split sizes along dim 0. The resulting parameters will have
                      names that end in `_weight` or `_bias`, so trailing underscores are
                      stripped from any provided names.
922
    device : Union[torch.device, str], default = "cuda"
923
          The device on which the parameters of the model will be allocated. It is the user's
924
925
          responsibility to ensure all parameters are moved to the GPU before running the
          forward pass.
926
927
    name: str, default = `None`
        name of the module, currently used for debugging purposes.
928
929
930
931
932
933
934
935
936
937
938
939
940

    Parallelism parameters
    ----------------------
    sequence_parallel : bool, default = `False`
                       if set to `True`, uses sequence parallelism.
    tp_group : ProcessGroup, default = `None`
              tensor parallel process group.
    tp_size : int, default = 1
             used as TP (tensor parallel) world size when TP groups are not formed during
             initialization. In this case, users must call the
             `set_tensor_parallel_group(tp_group)` method on the initialized module before the
             forward pass to supply the tensor parallel group needed for tensor and sequence
             parallel collectives.
941
    parallel_mode : {None, 'column', 'row'}, default = `None`
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
                   used to decide whether this Linear layer is Column Parallel Linear or Row
                   Parallel Linear as described `here <https://arxiv.org/pdf/1909.08053.pdf>`_.
                   When set to `None`, no communication is performed.

    Optimization parameters
    -----------------------
    fuse_wgrad_accumulation : bool, default = 'False'
                             if set to `True`, enables fusing of creation and accumulation of
                             the weight gradient. When enabled, it is assumed that the weights
                             have an additional `main_grad` attribute (used instead of the
                             regular `grad`) which is a pre-allocated buffer of the correct
                             size to accumulate gradients in.
    return_bias : bool, default = `False`
                 when set to `True`, this module will not apply the additive bias itself, but
                 instead return the bias value during the forward pass together with the
                 output of the linear transformation :math:`y = xA^T`. This is useful when
                 the bias addition can be fused to subsequent operations.
959
    params_dtype : torch.dtype, default = `torch.get_default_dtype()`
960
961
962
                  it controls the type used to allocate the initial parameters. Useful when
                  the model is trained with lower precision and the original FP32 parameters
                  would not fit in GPU memory.
963
964
965
966
    delay_wgrad_compute : bool, default = `False`
                         Whether or not to delay weight gradient computation. If set to `True`,
                         it's the user's responsibility to call `module.backward_dw` to compute
                         weight gradients.
967
968
969
970
971
    symmetric_ar_type : {None, 'multimem_all_reduce', 'two_shot', 'one_shot'}, default = None
                   Type of symmetric memory all-reduce to use during the forward pass.
                   This can help in latency bound communication situations.
                   Requires PyTorch version 2.7.0 or higher. When set to None, standard all-reduce
                   is used.
972
973
974
975
976
977
978
979
980
981
982
    """

    def __init__(
        self,
        in_features: int,
        out_features: int,
        sequence_parallel: bool = False,
        fuse_wgrad_accumulation: bool = False,
        tp_group: Optional[dist_group_type] = None,
        tp_size: int = 1,
        get_rng_state_tracker: Optional[Callable] = None,
983
        rng_tracker_name: Optional[str] = None,
984
985
986
        init_method: Optional[Callable] = None,
        bias: bool = True,
        return_bias: bool = False,
987
        params_dtype: Optional[torch.dtype] = None,
988
        parallel_mode: Optional[str] = None,
cyanguwa's avatar
cyanguwa committed
989
        parameters_split: Optional[Union[Tuple[str, ...], Dict[str, int]]] = None,
990
        device: Union[torch.device, str] = "cuda",
991
        ub_overlap_ag: bool = False,
992
        ub_overlap_rs: bool = False,
993
        ub_overlap_rs_dgrad: bool = False,
994
995
        ub_bulk_dgrad: bool = False,
        ub_bulk_wgrad: bool = False,
996
        ub_name: Optional[str] = None,
997
        delay_wgrad_compute: bool = False,
998
        symmetric_ar_type: Optional[str] = None,
999
        name: Optional[str] = None,
1000
1001
    ) -> None:
        super().__init__()
1002
1003

        params_dtype = torch.get_default_dtype() if params_dtype is None else params_dtype
1004
1005
1006
1007
1008
1009
        self.in_features = in_features
        self.out_features = out_features
        self.fuse_wgrad_accumulation = fuse_wgrad_accumulation
        self.use_bias = bias
        self.return_bias = return_bias
        self.apply_bias = bias and not return_bias
1010
1011
        self.get_rng_state_tracker = get_rng_state_tracker
        self.rng_tracker_name = rng_tracker_name
1012
        self.symmetric_ar_type = symmetric_ar_type
1013
1014
1015
1016
        self.name = name

        if TEDebugState.debug_enabled:
            self._turn_off_unsupported_features_in_debug()  # turn off userbuffers
1017

1018
1019
        self.wgrad_store = WeightGradStore(delay_wgrad_compute, ub_bulk_wgrad)

1020
1021
        if device == "meta":
            assert parameters_split is None, "Cannot split module parameters on 'meta' device."
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
        if tp_group is None:
            self.tp_size = tp_size
            if tp_size == 1:
                self.set_tensor_parallel_group(tp_group)
        else:
            self.tp_size = get_distributed_world_size(tp_group)
            self.set_tensor_parallel_group(tp_group)
        self.set_nccl_overlap_warning_if_tp()

        self.parallel_mode = parallel_mode
        assert (
            self.parallel_mode in GemmParallelModes
        ), f"parallel_mode {parallel_mode} not supported"

        if self.parallel_mode == "column":
            self.out_features = divide(self.out_features, self.tp_size)
        elif self.parallel_mode == "row":
            self.in_features = divide(self.in_features, self.tp_size)

        self.sequence_parallel = (self.tp_size > 1) and sequence_parallel

1043
        # Column parallel TP overlap options
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
        self.ub_overlap_ag_fprop = (
            self.parallel_mode == "column" and self.sequence_parallel and ub_overlap_ag
        )
        self.ub_overlap_rs_dgrad = (
            self.parallel_mode == "column" and self.sequence_parallel and ub_overlap_rs_dgrad
        )
        self.ub_bulk_dgrad = (
            self.parallel_mode == "column"
            and self.sequence_parallel
            and ub_bulk_dgrad
            and not self.ub_overlap_rs_dgrad
        )
        self.ub_bulk_wgrad = (
            self.parallel_mode == "column"
            and self.sequence_parallel
            and ub_bulk_wgrad
            and not self.ub_overlap_rs_dgrad
        )
1062
1063

        # Row parallel TP overlap options
1064
1065
1066
1067
1068
1069
        self.ub_overlap_rs_fprop = (
            self.parallel_mode == "row" and self.sequence_parallel and ub_overlap_rs
        )
        self.ub_overlap_ag_dgrad = (
            self.parallel_mode == "row" and self.sequence_parallel and ub_overlap_ag
        )
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083

        if any(
            [
                self.ub_overlap_rs_fprop,
                self.ub_overlap_ag_dgrad,
                self.ub_overlap_ag_fprop,
                self.ub_overlap_rs_dgrad,
                self.ub_bulk_dgrad,
                self.ub_bulk_wgrad,
            ]
        ):
            assert ub_name is not None, f"Comm+GEMM overlap layer '{ub_name}' is not initialized."
        self.ub_name = ub_name

1084
1085
1086
1087
1088
1089
1090
        if self.symmetric_ar_type is not None:
            assert torch_version() >= (
                2,
                7,
                0,
            ), "Torch version must be at least 2.7 to use symmetric memory"

1091
1092
1093
        # Initialize params in FP8
        with_fp8_params = FP8GlobalStateManager.with_fp8_parameters()

1094
1095
1096
1097
1098
1099
1100
1101
        # Contiguous buffers for params
        weight_tensor = torch.empty(
            self.out_features,
            self.in_features,
            device=device,
            dtype=params_dtype,
        )
        bias_tensor = None
1102
        if self.use_bias:
1103
1104
1105
1106
1107
            bias_tensor = torch.empty(
                self.out_features,
                device=device,
                dtype=params_dtype,
            )
1108

1109
1110
1111
1112
        # Configure parameter splits
        self.weight_names = []
        self.bias_names = []
        self.parameter_split_sizes = []
1113
        if parameters_split is None:
1114
1115
1116
1117
1118
1119
            # Split into a single parameter by default
            self.weight_names = ["weight"]
            self.bias_names = ["bias"]
            self.parameter_split_sizes = [out_features]
        elif not parameters_split:
            raise ValueError("Cannot split weight buffer into 0 parameters")
cyanguwa's avatar
cyanguwa committed
1120
        elif isinstance(parameters_split, dict):
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
            # Split parameters with provided sizes
            for name, split_size in parameters_split.items():
                self.weight_names.append(f"{name.rstrip('_')}_weight")
                self.bias_names.append(f"{name.rstrip('_')}_bias")
                self.parameter_split_sizes.append(split_size)
        elif all(isinstance(name, str) for name in parameters_split):
            # Split parameters evenly
            split_size = out_features // len(parameters_split)
            for name in parameters_split:
                self.weight_names.append(f"{name.rstrip('_')}_weight")
                self.bias_names.append(f"{name.rstrip('_')}_bias")
                self.parameter_split_sizes.append(split_size)
cyanguwa's avatar
cyanguwa committed
1133
        else:
1134
            raise TypeError("Invalid configuration for parameters split")
1135

1136
1137
1138
1139
1140
1141
        # Make sure parameter splits are valid
        if sum(self.parameter_split_sizes) != out_features:
            raise ValueError(
                f"Trying to split weight buffer ({out_features=}) "
                f"with split sizes {self.parameter_split_sizes}"
            )
1142

1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
        # Adjust parameter splits for tensor-parallel distribution
        if self.parallel_mode == "column":
            for i, size in enumerate(self.parameter_split_sizes):
                if size % self.tp_size != 0:
                    raise RuntimeError(
                        f"Attempting to distribute a parameter with out_features={size} "
                        f"between {self.tp_size} tensor-parallel processes"
                    )
                self.parameter_split_sizes[i] = size // self.tp_size

1153
1154
1155
1156
1157
        # Construct weight parameters
        # Note: Register weights together so that they are adjacent to
        # each other in Linear.parameters(). This makes it more likely
        # that they will stay contiguous if the weights are
        # manipulated externally, e.g. by FSDP.
1158
1159
1160
1161
1162
1163
1164
1165
        offset = 0
        for i, split_size in enumerate(self.parameter_split_sizes):
            split_start = offset
            offset += split_size
            split_end = offset

            # Check if parameters are subviews of buffers
            is_subview = (split_start, split_end) != (0, self.out_features)
1166
            if is_subview and with_fp8_params:
1167
1168
1169
                raise RuntimeError(
                    "Splitting QuantizedTensor into multiple params is not supported"
                )
1170

1171
            # Construct weight parameter
1172
1173
1174
1175
1176
1177
1178
            self.register_parameter(
                self.weight_names[i],
                torch.nn.Parameter(weight_tensor[split_start:split_end]),
                init_fn=init_method,
                get_rng_state_tracker=get_rng_state_tracker,
                fp8_meta_index=tex.FP8FwdTensors.GEMM1_WEIGHT,
            )
1179

1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
        # Construct bias parameters if needed
        if self.use_bias:
            offset = 0
            for i, split_size in enumerate(self.parameter_split_sizes):
                split_start = offset
                offset += split_size
                split_end = offset
                self.register_parameter(
                    self.bias_names[i],
                    torch.nn.Parameter(bias_tensor[split_start:split_end]),
                    init_fn=init_method_constant(0.0),
                )
        else:
            for name in self.bias_names:
                bias = torch.Tensor().to(dtype=params_dtype, device=device)
                setattr(self, name, bias)
cyanguwa's avatar
cyanguwa committed
1196

1197
        if with_fp8_params:
1198
1199
            self.init_fp8_metadata()

1200
        self.reset_parameters(defer_init=device == "meta")
1201

1202
1203
1204
1205
1206
1207
1208
        # For RPL, bias has to be added after TP collectives
        # So it cannot be fused with the GEMM
        if self.parallel_mode == "row" and self.apply_bias:
            self.gemm_bias_unfused_add = True
        else:
            self.gemm_bias_unfused_add = False

1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
    def set_meta_tensor(self, fwd: bool, recipe: Recipe) -> None:
        """Init scales and amaxes for fwd | bwd."""
        super().set_meta_tensor(fwd, recipe)

        # customize quantizers based on each recipe & layer configs
        recipe = FP8GlobalStateManager.get_fp8_recipe()
        if recipe.float8_current_scaling():
            self._customize_quantizers_float8_current_scaling(fwd, recipe)
        # elif for other recipes (mxfp8, etc.)

1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
    def reset_parameters(self, defer_init=False):
        super().reset_parameters(defer_init=defer_init)

        if not defer_init:
            # Set parallelism attributes for linear weights
            for weight in self.weight_names:
                set_tensor_model_parallel_attributes(
                    tensor=getattr(self, weight),
                    is_parallel=True,
                    dim=1 if self.parallel_mode == "row" else 0,
                    stride=1,
                )

            # Set parallelism attributes for linear biases
            if self.use_bias:
                for bias in self.bias_names:
                    if self.parallel_mode == "row":
                        setattr(getattr(self, bias), "sequence_parallel", self.sequence_parallel)
                    elif self.parallel_mode == "column":
                        set_tensor_model_parallel_attributes(getattr(self, bias), True, 0, 1)

1240
    @no_torch_dynamo()
1241
1242
1243
1244
    def forward(
        self,
        inp: torch.Tensor,
        is_first_microbatch: Optional[bool] = None,
1245
        fp8_output: Optional[bool] = False,
1246
        fp8_grad: Optional[bool] = False,
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
    ) -> Union[torch.Tensor, Tuple[torch.Tensor, ...]]:
        """
        Apply the linear transformation to the input.

        Parameters
        ----------
        inp : torch.Tensor
             Input tensor.
        is_first_microbatch : {True, False, None}, default = None
                             During training using either gradient accumulation or
                             pipeline parallelism a minibatch of data is further split
                             into microbatches. Between the microbatches of the same minibatch
                             the model weights are not updated. Setting this parameter indicates
                             whether the current microbatch is the first in a minibatch or not.
                             When set, this parameter enables additional optimizations:

                             * during FP8 training, it allows caching of the FP8 versions of
                               the weights
                             * it also allows skipping gradient accumulation during the
                               first microbatch (since it is the first gradient being
                               produced)
        """
1269
1270
1271
1272
        debug = TEDebugState.debug_enabled
        if debug:
            self._validate_name()

1273
1274
1275
1276
        if FP8GlobalStateManager.fp8_graph_capturing():
            skip_fp8_weight_update = FP8GlobalStateManager.get_skip_fp8_weight_update_tensor()
        else:
            skip_fp8_weight_update = None
1277
1278
1279
        if skip_fp8_weight_update is not None:
            is_first_microbatch = False

1280
1281
1282
1283
1284
1285
1286
        if self.ub_overlap_rs_fprop:
            if get_ub(self.ub_name + "_fprop").is_fp8_ubuf():
                fp8_output = True
        if self.ub_overlap_rs_dgrad:
            if get_ub(self.ub_name + "_dgrad").is_fp8_ubuf():
                fp8_grad = True

1287
1288
        with self.prepare_forward(
            inp,
1289
            allow_non_contiguous=isinstance(inp, QuantizedTensor),
1290
        ) as inp:
1291
1292

            # Get concatenated weight and bias tensors
1293
            unfused_weights = [getattr(self, name) for name in self.weight_names]
1294
            if any(isinstance(w, QuantizedTensor) for w in unfused_weights):
1295
1296
1297
                if self.fp8:
                    if len(unfused_weights) != 1:
                        raise RuntimeError(
1298
                            "Splitting QuantizedTensor into multiple params is not supported"
1299
1300
                        )
                else:
1301
1302
1303
1304
                    warnings.warn(
                        "You are using quantized weights without quantized compute. "
                        "Please make sure this is intentional."
                    )
1305
                    unfused_weights = [w.dequantize() for w in unfused_weights]
1306

1307
            weight_tensor = noop_cat(unfused_weights)
1308
            if self.use_bias:
1309
                bias_tensor = noop_cat([getattr(self, name) for name in self.bias_names])
1310
            else:
1311
1312
                bias_tensor = None

1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
            quantizers = (
                self._get_quantizers(fp8_output, fp8_grad)
                if not debug
                else self._get_debug_quantizers(fp8_output, fp8_grad)
            )
            if debug:
                if not any_feature_enabled(quantizers):
                    # If no feature is used, then run faster implementation with debug = False.
                    quantizers = self._get_quantizers(fp8_output, fp8_grad)
                    debug = False

                if isinstance(weight_tensor, QuantizedTensor):
                    raise RuntimeError("FP8 weights are not supported in debug mode.")

1327
1328
1329
1330
1331
            (
                input_quantizer,
                weight_quantizer,
                output_quantizer,
                grad_input_quantizer,
1332
1333
1334
                grad_weight_quantizer,
                grad_output_quantizer,
            ) = quantizers
1335
1336
1337
1338
1339
1340

            # Make sure weight tensor has correct quantizer
            # Note: Quantizer might have changed if quantization
            # recipe changed
            if weight_quantizer is not None and isinstance(weight_tensor, QuantizedTensor):
                weight_tensor._quantizer = weight_quantizer
1341

1342
1343
1344
1345
1346
1347
1348
1349
1350
            if torch.is_grad_enabled():
                linear_fn = _Linear.apply
                args = []
            else:
                linear_fn = _Linear.forward
                args = [None]
            args += (
                weight_tensor,
                inp,
1351
                bias_tensor if (self.apply_bias and not self.gemm_bias_unfused_add) else None,
1352
1353
1354
                is_first_microbatch,
                self.fp8,
                self.fp8_calibration,
1355
                self.wgrad_store,
1356
1357
1358
1359
                input_quantizer,
                weight_quantizer,
                output_quantizer,
                grad_input_quantizer,
1360
1361
                grad_weight_quantizer,
                grad_output_quantizer,
1362
                self.fuse_wgrad_accumulation,
1363
                is_cpu_offload_enabled(),
1364
1365
1366
1367
1368
1369
1370
                self.tp_group,
                self.tp_size,
                self.sequence_parallel,
                self.tp_size > 1,
                self.activation_dtype,
                self.parallel_mode,
                torch.is_grad_enabled(),
1371
1372
1373
1374
1375
1376
                self.ub_overlap_rs_fprop,
                self.ub_overlap_ag_dgrad,
                self.ub_overlap_ag_fprop,
                self.ub_overlap_rs_dgrad,
                self.ub_bulk_dgrad,
                self.ub_bulk_wgrad,
1377
                self.ub_name,
1378
                fp8_output,
1379
                self.fsdp_group,
1380
1381
                self,
                skip_fp8_weight_update,
1382
                self.symmetric_ar_type,
1383
                debug,
1384
1385
1386
1387
1388
1389
1390
1391
            )
            out = linear_fn(*args)
        if self.gemm_bias_unfused_add:
            out = out + cast_if_needed(bias_tensor, self.activation_dtype)

        if self.return_bias:
            return out, cast_if_needed(bias_tensor, self.activation_dtype)
        return out
1392
1393
1394

    def _get_quantizers(self, fp8_output, fp8_grad):
        if not self.fp8:
1395
            return [None] * 6
1396
        grad_input_quantizer = None
1397
        grad_weight_quantizer = None
1398
1399
1400
        grad_output_quantizer = None
        output_quantizer = None
        input_quantizer = self.quantizers["scaling_fwd"][tex.FP8FwdTensors.GEMM1_INPUT]
1401
        input_quantizer.internal = True
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
        weight_quantizer = self.quantizers["scaling_fwd"][tex.FP8FwdTensors.GEMM1_WEIGHT]
        weight_quantizer.internal = True
        if fp8_output:
            output_quantizer = self.quantizers["scaling_fwd"][tex.FP8FwdTensors.GEMM1_OUTPUT]
        if torch.is_grad_enabled():
            grad_output_quantizer = self.quantizers["scaling_bwd"][tex.FP8BwdTensors.GRAD_OUTPUT1]
            grad_output_quantizer.internal = True
            if fp8_grad:
                grad_input_quantizer = self.quantizers["scaling_bwd"][tex.FP8BwdTensors.GRAD_INPUT1]
        return (
            input_quantizer,
            weight_quantizer,
            output_quantizer,
            grad_input_quantizer,
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
            grad_weight_quantizer,
            grad_output_quantizer,
        )

    def _get_debug_quantizers(self, fp8_output, fp8_grad):
        original_quantizers = self._get_quantizers(fp8_output, fp8_grad)
        assert TEDebugState.debug_enabled
        from ...debug.pytorch.debug_quantization import DebugQuantizer

        names = ["activation", "weight", "output", "dgrad", "wgrad", "gradient"]
        return tuple(
            DebugQuantizer(self.name, name, q, self.tp_group)
            for name, q in zip(names, original_quantizers)
1429
        )
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476

    def _customize_quantizers_float8_current_scaling(self, fwd: bool, recipe: Recipe) -> None:
        """Customize quantizers based on current scaling recipe + linear."""
        assert (
            recipe.float8_current_scaling()
        ), "current scaling recipe quantizer customization here"
        if fwd:
            # set configs about amax epsilon and power_2_scale
            self.quantizers["scaling_fwd"][
                tex.FP8FwdTensors.GEMM1_INPUT
            ].force_pow_2_scales = recipe.fp8_quant_fwd_inp.power_2_scale
            self.quantizers["scaling_fwd"][
                tex.FP8FwdTensors.GEMM1_INPUT
            ].amax_epsilon = recipe.fp8_quant_fwd_inp.amax_epsilon
            # also set weight quantizer with same amax_epsilon & power_2_scale
            self.quantizers["scaling_fwd"][
                tex.FP8FwdTensors.GEMM1_WEIGHT
            ].force_pow_2_scales = recipe.fp8_quant_fwd_weight.power_2_scale
            self.quantizers["scaling_fwd"][
                tex.FP8FwdTensors.GEMM1_WEIGHT
            ].amax_epsilon = recipe.fp8_quant_fwd_weight.amax_epsilon
            # paralle related
            if self.sequence_parallel and self.parallel_mode == "column":
                # customize input_quantizer with amax reduction TP group
                self.quantizers["scaling_fwd"][
                    tex.FP8FwdTensors.GEMM1_INPUT
                ].with_amax_reduction = True
                self.quantizers["scaling_fwd"][
                    tex.FP8FwdTensors.GEMM1_INPUT
                ].amax_reduction_group = self.tp_group
        else:
            # set grad_output_quantizer with amax epsilon and power_2_scale
            self.quantizers["scaling_bwd"][
                tex.FP8BwdTensors.GRAD_OUTPUT1
            ].force_pow_2_scales = recipe.fp8_quant_bwd_grad.power_2_scale
            self.quantizers["scaling_bwd"][
                tex.FP8BwdTensors.GRAD_OUTPUT1
            ].amax_epsilon = recipe.fp8_quant_bwd_grad.amax_epsilon
            # parallel related
            if self.sequence_parallel and self.parallel_mode == "row":
                # customize grad_output_quantizer with amax reduction TP group
                self.quantizers["scaling_bwd"][
                    tex.FP8BwdTensors.GRAD_OUTPUT1
                ].with_amax_reduction = True
                self.quantizers["scaling_bwd"][
                    tex.FP8BwdTensors.GRAD_OUTPUT1
                ].amax_reduction_group = self.tp_group