File size: 7,840 Bytes
fbd9366
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
"""
Shape inference methods
"""

from functools import partial
import math
from typing import List, Tuple, Union
import warnings

import numpy as np
import torch

# fmt: off
__all__ = [
    "shape_convnd",
    "shape_conv1d", "shape_conv2d", "shape_conv3d",
    "shape_transpose_convnd",
    "shape_transpose_conv1d", "shape_transpose_conv2d", "shape_transpose_conv3d",
    "shape_poolnd",
    "shape_maxpool1d", "shape_maxpool2d", "shape_maxpool3d",
    "shape_avgpool1d", "shape_avgpool2d", "shape_avgpool3d",
    "shape_slice",
    "check_shape"
]
# fmt: on


def _get_shape(x):
    "single object"
    if isinstance(x, np.ndarray):
        return tuple(x.shape)
    else:
        return tuple(x.size())


def _expands(dim, *xs):
    "repeat vars like kernel and stride to match dim"

    def _expand(x):
        if isinstance(x, int):
            return (x,) * dim
        else:
            assert len(x) == dim
            return x

    return map(lambda x: _expand(x), xs)


_HELPER_TENSOR = torch.zeros((1,))


def shape_slice(input_shape, slice):
    """
    Credit to Adam Paszke for the trick. Shape inference without instantiating
    an actual tensor.
    The key is that `.expand()` does not actually allocate memory
    Still needs to allocate a one-element HELPER_TENSOR.
    """
    shape = _HELPER_TENSOR.expand(*input_shape)[slice]
    if hasattr(shape, "size"):
        return tuple(shape.size())
    return (1,)


class ShapeSlice:
    """
    shape_slice inference with easy []-operator
    """

    def __init__(self, input_shape):
        self.input_shape = input_shape

    def __getitem__(self, slice):
        return shape_slice(self.input_shape, slice)


def check_shape(
    value: Union[Tuple, List, torch.Tensor, np.ndarray],
    expected: Union[Tuple, List, torch.Tensor, np.ndarray],
    err_msg="",
    mode="raise",
):
    """
    Args:
        value: np array or torch Tensor
        expected:
          - list[int], tuple[int]: if any value is None, will match any dim
          - np array or torch Tensor: must have the same dimensions
        mode:
          - "raise": raise ValueError, shape mismatch
          - "return": returns True if shape matches, otherwise False
          - "warning": warnings.warn
    """
    assert mode in ["raise", "return", "warning"]
    if torch.is_tensor(value):
        actual_shape = value.size()
    elif hasattr(value, "shape"):
        actual_shape = value.shape
    else:
        assert isinstance(value, (list, tuple))
        actual_shape = value
        assert all(
            isinstance(s, int) for s in actual_shape
        ), f"actual shape: {actual_shape} is not a list of ints"

    if torch.is_tensor(expected):
        expected_shape = expected.size()
    elif hasattr(expected, "shape"):
        expected_shape = expected.shape
    else:
        assert isinstance(expected, (list, tuple))
        expected_shape = expected

    err_msg = f" for {err_msg}" if err_msg else ""

    if len(actual_shape) != len(expected_shape):
        err_msg = (
            f"Dimension mismatch{err_msg}: actual shape {actual_shape} "
            f"!= expected shape {expected_shape}."
        )
        if mode == "raise":
            raise ValueError(err_msg)
        elif mode == "warning":
            warnings.warn(err_msg)
        return False

    for s_a, s_e in zip(actual_shape, expected_shape):
        if s_e is not None and s_a != s_e:
            err_msg = (
                f"Shape mismatch{err_msg}: actual shape {actual_shape} "
                f"!= expected shape {expected_shape}."
            )
            if mode == "raise":
                raise ValueError(err_msg)
            elif mode == "warning":
                warnings.warn(err_msg)
            return False
    return True


def shape_convnd(
    dim,
    input_shape,
    out_channels,
    kernel_size,
    stride=1,
    padding=0,
    dilation=1,
    has_batch=False,
):
    """
    http://pytorch.org/docs/nn.html#conv1d
    http://pytorch.org/docs/nn.html#conv2d
    http://pytorch.org/docs/nn.html#conv3d

    Args:
        dim: supports 1D to 3D
        input_shape:
        - 1D: [channel, length]
        - 2D: [channel, height, width]
        - 3D: [channel, depth, height, width]
        has_batch: whether the first dim is batch size or not
    """
    if has_batch:
        assert (
            len(input_shape) == dim + 2
        ), "input shape with batch should be {}-dimensional".format(dim + 2)
    else:
        assert (
            len(input_shape) == dim + 1
        ), "input shape without batch should be {}-dimensional".format(dim + 1)
    if stride is None:
        # for pooling convention in PyTorch
        stride = kernel_size
    kernel_size, stride, padding, dilation = _expands(dim, kernel_size, stride, padding, dilation)
    if has_batch:
        batch = input_shape[0]
        input_shape = input_shape[1:]
    else:
        batch = None
    _, *img = input_shape
    new_img_shape = [
        math.floor(
            (img[i] + 2 * padding[i] - dilation[i] * (kernel_size[i] - 1) - 1) // stride[i] + 1
        )
        for i in range(dim)
    ]
    return ((batch,) if has_batch else ()) + (out_channels, *new_img_shape)


def shape_poolnd(
    dim, input_shape, kernel_size, stride=None, padding=0, dilation=1, has_batch=False
):
    """
    The only difference from infer_shape_convnd is that `stride` default is None
    """
    if has_batch:
        out_channels = input_shape[1]
    else:
        out_channels = input_shape[0]
    return shape_convnd(
        dim,
        input_shape,
        out_channels,
        kernel_size,
        stride,
        padding,
        dilation,
        has_batch,
    )


def shape_transpose_convnd(
    dim,
    input_shape,
    out_channels,
    kernel_size,
    stride=1,
    padding=0,
    output_padding=0,
    dilation=1,
    has_batch=False,
):
    """
    http://pytorch.org/docs/nn.html#convtranspose1d
    http://pytorch.org/docs/nn.html#convtranspose2d
    http://pytorch.org/docs/nn.html#convtranspose3d

    Args:
        dim: supports 1D to 3D
        input_shape:
        - 1D: [channel, length]
        - 2D: [channel, height, width]
        - 3D: [channel, depth, height, width]
        has_batch: whether the first dim is batch size or not
    """
    if has_batch:
        assert (
            len(input_shape) == dim + 2
        ), "input shape with batch should be {}-dimensional".format(dim + 2)
    else:
        assert (
            len(input_shape) == dim + 1
        ), "input shape without batch should be {}-dimensional".format(dim + 1)
    kernel_size, stride, padding, output_padding, dilation = _expands(
        dim, kernel_size, stride, padding, output_padding, dilation
    )
    if has_batch:
        batch = input_shape[0]
        input_shape = input_shape[1:]
    else:
        batch = None
    _, *img = input_shape
    new_img_shape = [
        (img[i] - 1) * stride[i] - 2 * padding[i] + kernel_size[i] + output_padding[i]
        for i in range(dim)
    ]
    return ((batch,) if has_batch else ()) + (out_channels, *new_img_shape)


shape_conv1d = partial(shape_convnd, 1)
shape_conv2d = partial(shape_convnd, 2)
shape_conv3d = partial(shape_convnd, 3)


shape_transpose_conv1d = partial(shape_transpose_convnd, 1)
shape_transpose_conv2d = partial(shape_transpose_convnd, 2)
shape_transpose_conv3d = partial(shape_transpose_convnd, 3)


shape_maxpool1d = partial(shape_poolnd, 1)
shape_maxpool2d = partial(shape_poolnd, 2)
shape_maxpool3d = partial(shape_poolnd, 3)


"""
http://pytorch.org/docs/nn.html#avgpool1d
http://pytorch.org/docs/nn.html#avgpool2d
http://pytorch.org/docs/nn.html#avgpool3d
"""
shape_avgpool1d = partial(shape_maxpool1d, dilation=1)
shape_avgpool2d = partial(shape_maxpool2d, dilation=1)
shape_avgpool3d = partial(shape_maxpool3d, dilation=1)