Skip to content

Commit

Permalink
Update batchnorm documentation (number of outputs for training mode) (#…
Browse files Browse the repository at this point in the history
…5932)

### Description
Update batchnorm documentation (number of outputs for training mode)

Redo of PR #5288 (since that PR is stalled).

---------

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>
Co-authored-by: Andreas Fehlner <fehlner@arcor.de>
  • Loading branch information
gramalingam and andife committed Feb 16, 2024
1 parent fe31f3a commit 00c2f02
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/Changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -19579,7 +19579,7 @@ This version of the operator has been available since version 15 of the default
<dt><tt>momentum</tt> : float (default is 0.9)</dt>
<dd>Factor used in computing the running mean and variance.e.g., running_mean = running_mean * momentum + mean * (1 - momentum).</dd>
<dt><tt>training_mode</tt> : int (default is 0)</dt>
<dd>If set to true, it indicates BatchNormalization is being used for training, and outputs 1, 2, 3, and 4 would be populated.</dd>
<dd>If set to true, it indicates BatchNormalization is being used for training, and outputs 1 and 2 are to be computed.</dd>
</dl>

#### Inputs
Expand Down
2 changes: 1 addition & 1 deletion docs/Operators.md
Original file line number Diff line number Diff line change
Expand Up @@ -2439,7 +2439,7 @@ Other versions of this operator: <a href="Changelog.md#BatchNormalization-1">1</
<dt><tt>momentum</tt> : float (default is 0.9)</dt>
<dd>Factor used in computing the running mean and variance.e.g., running_mean = running_mean * momentum + mean * (1 - momentum).</dd>
<dt><tt>training_mode</tt> : int (default is 0)</dt>
<dd>If set to true, it indicates BatchNormalization is being used for training, and outputs 1, 2, 3, and 4 would be populated.</dd>
<dd>If set to true, it indicates BatchNormalization is being used for training, and outputs 1 and 2 are to be computed.</dd>
</dl>

#### Inputs
Expand Down
4 changes: 2 additions & 2 deletions onnx/defs/nn/defs.cc
Original file line number Diff line number Diff line change
Expand Up @@ -1655,8 +1655,8 @@ ONNX_OPERATOR_SET_SCHEMA(
0.9f)
.Attr(
"training_mode",
"If set to true, it indicates BatchNormalization is being used for training, and outputs 1, "
"2, 3, and 4 would be populated.",
"If set to true, it indicates BatchNormalization is being used for training, and outputs 1 "
"and 2 are to be computed.",
AttributeProto::INT,
static_cast<int64_t>(0))
.Input(
Expand Down

0 comments on commit 00c2f02

Please sign in to comment.