_utils.py 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. # mypy: allow-untyped-defs
  2. """Defines utilities for interacting with scaled_dot_product_attention"""
  3. import math
  4. import torch
  5. __all__: list[str] = []
  6. def _input_requires_grad(*tensors: torch.Tensor) -> bool:
  7. """Returns True if any of the tensors requires grad"""
  8. return any(t.requires_grad for t in tensors)
  9. def _postprocess_flash_output(inpt_tensor: torch.Tensor, og_size: int) -> torch.Tensor:
  10. """Handles the unpad of the last dimension"""
  11. if inpt_tensor.size(-1) != og_size:
  12. return inpt_tensor[..., :og_size]
  13. return inpt_tensor
  14. def _calculate_scale(head_dim_size: int, scale: float | None) -> float:
  15. """
  16. For FlashAttention we pad the head dimension to be a multiple of 8 so we need to scale the output
  17. by the original head size and not the padded.
  18. """
  19. if scale is not None:
  20. return scale
  21. return 1.0 / math.sqrt(head_dim_size)
  22. def _validate_sdpa_input(
  23. query: torch.Tensor,
  24. key: torch.Tensor,
  25. value: torch.Tensor,
  26. attn_mask: torch.Tensor | None = None,
  27. dropout_p=0.0,
  28. is_causal=False,
  29. scale=None,
  30. allow_lowp_kv=False,
  31. ) -> None:
  32. if not allow_lowp_kv:
  33. if query.dtype != key.dtype or query.dtype != value.dtype:
  34. raise ValueError(
  35. f"Expected query, key, and value to have the same dtype, "
  36. f"but got query.dtype: {query.dtype}, key.dtype: {key.dtype}, "
  37. f"and value.dtype: {value.dtype} instead."
  38. )
  39. if query.device != key.device or query.device != value.device:
  40. raise ValueError(
  41. f"Expected query, key, and value to have the same device type, "
  42. f"but got query.device: {query.device}, key.device: {key.device}, "
  43. f"and value.device: {value.device} instead."
  44. )
  45. if query.dim() < 2 or key.dim() < 2 or value.dim() < 2:
  46. raise ValueError(
  47. f"Expected query, key, and value to all be at least 2 dimensional, but got query.dim: "
  48. f"{query.dim()}, key.dim: {key.dim()} and value.dim: {value.dim()} instead."
  49. )