Class LAMB8bit

bitsandbytes/optim/lamb.py:67–134

class LAMB8bit(Optimizer2State):
    def __init__(
        self,
        params,
        lr=1e-3,
        bias_correction=True,
        betas=(0.9, 0.999),
        eps=1e-8,
        weight_decay=0,
        amsgrad=False,
        adam_w_mode=True,
        args=None,
        min_8bit_size=4096,
        max_unorm=1.0,
    ):
        """
        8-bit LAMB optimizer.

        Arguments:
            params (`torch.tensor`):
                The input parameters to optimize.
            lr (`float`, defaults to 1e-3):
                The learning rate.
            bias_correction (`bool`, defaults to `True`):
                Whether to apply bias correction to the first and second-order moments.
            betas (`tuple(float, float)`, defaults to (0.9, 0.999)):
                The beta values are the decay rates of the first and second-order moment of the optimizer.
            eps (`float`, defaults to 1e-8):
                The epsilon value prevents division by zero in the optimizer.
            weight_decay (`float`, defaults to 1e-2):
                The weight decay value for the optimizer.
            amsgrad (`bool`, defaults to `False`):
                Whether to use the [AMSGrad](https://hf.co/papers/1904.09237) variant of Adam that uses the maximum of past squared gradients instead.
                Note: This parameter is not supported in LAMB8bit and must be False.
            adam_w_mode (`bool`, defaults to `True`):
                Whether to use the AdamW variant.
            args (`object`, defaults to `None`):
                An object with additional arguments.
            min_8bit_size (`int`, defaults to 4096):
                The minimum number of elements of the parameter tensors for 8-bit optimization.
            max_unorm (`float`, defaults to 1.0):
                The maximum update norm for trust-ratio clipping.
                Note: This parameter is not supported in LAMB8bit and must be left at the
                default 1.0. The 8-bit blockwise update does not implement update-norm
                clipping; it is honored by the 32-bit LAMB / LAMB32bit optimizers.
        """
        # Validate unsupported parameters
        if amsgrad:
            raise ValueError("LAMB8bit does not support amsgrad=True")

        if max_unorm != 1.0:
            # We allow the default value of 1.0 to maintain compatibility with the function
            # signature, but the 8-bit blockwise update does not implement update-norm
            # clipping, so any other value would be silently ignored.
            raise ValueError("LAMB8bit only supports max_unorm=1.0 (default value for compatibility)")

        super().__init__(
            "lamb",