pytorch

1
from typing import Optional
2
import warnings
3

4
# NB: Keep this file in sync with enums in aten/src/ATen/core/Reduction.h
5

6

7
def get_enum(reduction: str) -> int:
8
    if reduction == 'none':
9
        ret = 0
10
    elif reduction == 'mean':
11
        ret = 1
12
    elif reduction == 'elementwise_mean':
13
        warnings.warn("reduction='elementwise_mean' is deprecated, please use reduction='mean' instead.")
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

22
# In order to support previous versions, accept boolean size_average and reduce
23
# and convert them into the new constants for now
24

25

26
# We use these functions in torch/legacy as well, in which case we'll silence the warning
27
def legacy_get_string(size_average: Optional[bool], reduce: Optional[bool], emit_warning: bool = True) -> str:
28
    warning = "size_average and reduce args will be deprecated, please use reduction='{}' instead."
29

30
    if size_average is None:
31
        size_average = True
32
    if reduce is None:
33
        reduce = True
34

35
    if size_average and reduce:
36
        ret = 'mean'
37
    elif reduce:
38
        ret = 'sum'
39
    else:
40
        ret = 'none'
41
    if emit_warning:
42
        warnings.warn(warning.format(ret))
43
    return ret
44

45

46
def legacy_get_enum(size_average: Optional[bool], reduce: Optional[bool], emit_warning: bool = True) -> int:
47
    return get_enum(legacy_get_string(size_average, reduce, emit_warning))
48