_reduction.py 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. import warnings
  2. from typing import Optional
  3. # NB: Keep this file in sync with enums in aten/src/ATen/core/Reduction.h
  4. def get_enum(reduction: str) -> int:
  5. if reduction == "none":
  6. ret = 0
  7. elif reduction == "mean":
  8. ret = 1
  9. elif reduction == "elementwise_mean":
  10. warnings.warn(
  11. "reduction='elementwise_mean' is deprecated. "
  12. "Please use reduction='mean' instead."
  13. )
  14. ret = 1
  15. elif reduction == "sum":
  16. ret = 2
  17. else:
  18. ret = -1 # TODO: remove once JIT exceptions support control flow
  19. raise ValueError(f"{reduction} is not a valid value for reduction")
  20. return ret
  21. # In order to support previous versions, accept boolean size_average and reduce
  22. # and convert them into the new constants for now
  23. # We use these functions in torch/legacy as well, in which case we'll silence the warning
  24. def legacy_get_string(
  25. size_average: Optional[bool],
  26. reduce: Optional[bool],
  27. emit_warning: bool = True,
  28. ) -> str:
  29. warning = "size_average and reduce args will be deprecated, please use reduction='{}' instead."
  30. if size_average is None:
  31. size_average = True
  32. if reduce is None:
  33. reduce = True
  34. if size_average and reduce:
  35. ret = "mean"
  36. elif reduce:
  37. ret = "sum"
  38. else:
  39. ret = "none"
  40. if emit_warning:
  41. warnings.warn(warning.format(ret))
  42. return ret
  43. def legacy_get_enum(
  44. size_average: Optional[bool],
  45. reduce: Optional[bool],
  46. emit_warning: bool = True,
  47. ) -> int:
  48. return get_enum(legacy_get_string(size_average, reduce, emit_warning))