BatchNormalization - 6 vs 14#

Next section compares an older to a newer version of the same operator after both definition are converted into markdown text. Green means an addition to the newer version, red means a deletion. Anything else is unchanged.

Files changed (1) hide show
  1. BatchNormalization6 → BatchNormalization14 +44 -70
BatchNormalization6 → BatchNormalization14 RENAMED
@@ -1 +1 @@
1
1
  Carries out batch normalization as described in the paper
2
2
  https://arxiv.org/abs/1502.03167. Depending on the mode it is being run,
3
- There are five required inputs 'X', 'scale', 'B', 'input_mean' and
4
- 'input_var'.
5
- Note that 'input_mean' and 'input_var' are expected to be the estimated
6
- statistics in inference mode (training_mode=False, default),
7
- and the running statistics in training mode (training_mode=True).
8
- There are multiple cases for the number of outputs, which we list below:
3
+ there are multiple cases for the number of outputs, which we list below:
4
+ Output case #1: Y, mean, var, saved_mean, saved_var (training mode)
5
+ Output case #2: Y (test mode)
9
- Output case #1: Y, running_mean, running_var (training_mode=True)
10
- Output case #2: Y (training_mode=False)
11
-
12
- When training_mode=False, extra outputs are invalid.
13
- The outputs are updated as follows when training_mode=True:
14
- ::
15
-
16
- running_mean = input_mean * momentum + current_mean * (1 - momentum)
17
- running_var = input_var * momentum + current_var * (1 - momentum)
18
-
19
- Y = (X - current_mean) / sqrt(current_var + epsilon) * scale + B
20
-
21
- where:
22
-
23
- current_mean = ReduceMean(X, axis=all_except_channel_index)
24
- current_var = ReduceVar(X, axis=all_except_channel_index)
25
-
26
- Notice that ReduceVar refers to the population variance, and it equals to
27
- sum(sqrd(x_i - x_avg)) / N
28
- where N is the population size (this formula does not use sample size N - 1).
29
-
30
- When training_mode=False:
31
- ::
32
-
33
- Y = (X - input_mean) / sqrt(input_var + epsilon) * scale + B
34
-
35
- For previous (depreciated) non-spatial cases, implementors are suggested
36
- to flatten the input shape to (N x C * D1 * D2 * ... * Dn) before a BatchNormalization Op.
37
- This operator has **optional** inputs/outputs. See ONNX <https://github.com/onnx/onnx/blob/master/docs/IR.md>_ for more details about the representation of optional arguments. An empty string may be used in the place of an actual argument's name to indicate a missing argument. Trailing optional arguments (those not followed by an argument that is present) may also be simply omitted.
38
6
  **Attributes**
39
7
  * **epsilon**:
40
- The epsilon value to use to avoid division by zero.
8
+ The epsilon value to use to avoid division by zero, default is
9
+ 1e-5f.
10
+ * **is_test**:
11
+ If set to nonzero, run spatial batch normalization in test mode,
12
+ default is 0.
41
13
  * **momentum**:
42
14
  Factor used in computing the running mean and variance.e.g.,
43
- running_mean = running_mean * momentum + mean * (1 - momentum).
15
+ running_mean = running_mean * momentum + mean * (1 - momentum),
16
+ default is 0.9f.
44
- * **training_mode**:
17
+ * **spatial**:
45
- If set to true, it indicates BatchNormalization is being used for
18
+ If true, compute the mean and variance across all spatial elements
46
- training, and outputs 1, 2, 3, and 4 would be populated.
19
+ If false, compute the mean and variance across per feature.Default
20
+ is 1.
47
21
  **Inputs**
48
22
  * **X** (heterogeneous) - **T**:
49
- Input data tensor from the previous operator; dimensions are in the
23
+ Input data tensor from the previous operator; dimensions for image
24
+ case are (N x C x H x W), where N is the batch size, C is the number
25
+ of channels, and H and W are the height and the width of the data.
26
+ For non image case, the dimensions are in the form of (N x C x D1 x
27
+ D2 ... Dn), where N is the batch size.
50
- form of (N x C x D1 x D2 ... Dn), where N is the batch size, C is
51
- the number of channels. Statistics are computed for every channel of
52
- C over N and D1 to Dn dimensions. For image data, input dimensions
53
- become (N x C x H x W). The op also accepts single dimension input
54
- of size N in which case C is assumed to be 1
55
28
  * **scale** (heterogeneous) - **T**:
56
- Scale tensor of shape (C).
29
+ The scale as a 1-dimensional tensor of size C to be applied to the
30
+ output.
57
31
  * **B** (heterogeneous) - **T**:
58
- Bias tensor of shape (C).
32
+ The bias as a 1-dimensional tensor of size C to be applied to the
33
+ output.
59
- * **input_mean** (heterogeneous) - **U**:
34
+ * **mean** (heterogeneous) - **T**:
60
- running (training) or estimated (testing) mean tensor of shape (C).
35
+ The running mean (training) or the estimated mean (testing) as a
36
+ 1-dimensional tensor of size C.
61
- * **input_var** (heterogeneous) - **U**:
37
+ * **var** (heterogeneous) - **T**:
62
- running (training) or estimated (testing) variance tensor of shape
38
+ The running variance (training) or the estimated variance (testing)
63
- (C).
39
+ as a 1-dimensional tensor of size C.
64
40
  **Outputs**
65
- Between 1 and 3 outputs.
41
+ Between 1 and 5 outputs.
66
42
  * **Y** (heterogeneous) - **T**:
67
- The output tensor of the same shape as X
43
+ The output tensor of the same shape as X.
68
- * **running_mean** (optional, heterogeneous) - **U**:
44
+ * **mean** (optional, heterogeneous) - **T**:
69
- The running mean after the BatchNormalization operator.
45
+ The running mean after the BatchNormalization operator. Must be in-
46
+ place with the input mean. Should not be used for testing.
70
- * **running_var** (optional, heterogeneous) - **U**:
47
+ * **var** (optional, heterogeneous) - **T**:
71
- The running variance after the BatchNormalization operator. This op
48
+ The running variance after the BatchNormalization operator. Must be
72
- uses the population size (N) for calculating variance, and not the
49
+ in-place with the input var. Should not be used for testing.
50
+ * **saved_mean** (optional, heterogeneous) - **T**:
51
+ Saved mean used during training to speed up gradient computation.
73
- sample size N-1.
52
+ Should not be used for testing.
53
+ * **saved_var** (optional, heterogeneous) - **T**:
54
+ Saved variance used during training to speed up gradient
55
+ computation. Should not be used for testing.
74
56
  **Type Constraints**
75
57
  * **T** in (
76
- tensor(bfloat16),
77
58
  tensor(double),
78
59
  tensor(float),
79
60
  tensor(float16)
80
61
  ):
81
- Constrain input and output types to float tensors.
62
+ Constrain input and output types to float tensors.- * **U** in (
82
- tensor(bfloat16),
83
- tensor(double),
84
- tensor(float),
85
- tensor(float16)
86
- ):
87
- Constrain mean and variance types to float tensors. It allows all
88
- float type for U.