Skip to content

Commit b959403

Browse files
committed
update class comments
1 parent 745e095 commit b959403

File tree

6 files changed

+14
-9
lines changed

6 files changed

+14
-9
lines changed

onnxruntime/core/graph/data_propagation/add_op_data_propagation.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,14 @@ namespace onnxruntime {
1818
* |
1919
* v
2020
* Shape (It saves [1, 3, 64, 64] in inferred_shape_values_ in output's node_arg
21-
* | after graph::SaveShapeValuesFromDataPropagation())
21+
* | during Graph::SaveShapeValuesFromDataPropagation())
2222
* |
2323
* | ______
2424
* | |
2525
* v v
2626
* Gather Gather (First 'Gather' saves 3 in inferred_scalar_value_ in output node_arg, and
2727
* | | second 'Gather' saves 64 in inferred_scalar_value_ in output node_arg
28-
* | | after graph::SaveShapeValuesFromDataPropagation(), if the 'index' attributes
28+
* | | during GatherOpDataPropagation(), if the 'index' attributes
2929
* | | are 1 and 2 respectively)
3030
* \ /
3131
* \ /

onnxruntime/core/graph/data_propagation/custom_data_propagation.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ namespace onnxruntime {
1414
* @class CustomDataPropagation
1515
* Custom data propagation for the operator to help enhance shape inference.
1616
*
17-
* Calling infer() can infer the output values for the specific operator given the input is shape values.
17+
* Calling infer() can infer the output values for the specific operator given the input is shape values
18+
* and saves the output values in output node_arg for other operators to use later.
1819
* The purpose of this class is to make shape values being correctly inferred and propogated through the graph.
1920
*/
2021
class CustomDataPropagationBase {

onnxruntime/core/graph/data_propagation/div_op_data_propagation.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,14 @@ namespace onnxruntime {
1818
* |
1919
* v
2020
* Shape (It saves [1, 3, 64, 64] in inferred_shape_values_ in output's node_arg
21-
* | after graph::SaveShapeValuesFromDataPropagation())
21+
* | during graph::SaveShapeValuesFromDataPropagation())
2222
* |
2323
* | ______
2424
* | |
2525
* v v
2626
* Gather Gather (First 'Gather' saves 64 in inferred_scalar_value_ in output node_arg, and
2727
* | | second 'Gather' saves 1 in inferred_scalar_value_ in output node_arg
28-
* | | after graph::SaveShapeValuesFromDataPropagation(), if the 'index' attributes
28+
* | | during GatherOpDataPropagation(), if the 'index' attributes
2929
* | | are 2 and 0 respectively)
3030
* \ /
3131
* \ /

onnxruntime/core/graph/data_propagation/mul_op_data_propagation.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,14 @@ namespace onnxruntime {
1717
* |
1818
* v
1919
* Shape (It saves [1, 3, 64, 64] in inferred_shape_values_ in output's node_arg
20-
* | after graph::SaveShapeValuesFromDataPropagation())
20+
* | during graph::SaveShapeValuesFromDataPropagation())
2121
* |
2222
* | ______
2323
* | |
2424
* v v
2525
* Gather Gather (First 'Gather' saves 3 in inferred_scalar_value_ in output node_arg, and
2626
* | | second 'Gather' saves 64 in inferred_scalar_value_ in output node_arg
27-
* | | after graph::SaveShapeValuesFromDataPropagation(), if the 'index' attributes
27+
* | | during GatherOpDataPropagation(), if the 'index' attributes
2828
* | | are 1 and 2 respectively)
2929
* \ /
3030
* \ /

onnxruntime/core/graph/data_propagation/size_op_data_propagation.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@
88

99
namespace onnxruntime {
1010

11+
/**
12+
* @brief Class to infer the output scalar for 'Size' operator given the input is shape values.
13+
*
14+
*/
1115
class SizeOpDataPropagation : public CustomDataPropagationBase {
1216
public:
1317
SizeOpDataPropagation(const Node& node,

onnxruntime/core/graph/data_propagation/sub_op_data_propagation.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,14 @@ namespace onnxruntime {
1818
* |
1919
* v
2020
* Shape (It saves [1, 3, 64, 64] in inferred_shape_values_ in output's node_arg
21-
* | after graph::SaveShapeValuesFromDataPropagation())
21+
* | during graph::SaveShapeValuesFromDataPropagation())
2222
* |
2323
* | ______
2424
* | |
2525
* v v
2626
* Gather Gather (First 'Gather' saves 64 in inferred_scalar_value_ in output node_arg, and
2727
* | | second 'Gather' saves 3 in inferred_scalar_value_ in output node_arg
28-
* | | after graph::SaveShapeValuesFromDataPropagation(), if the 'index' attributes
28+
* | | during GatherOpDataPropagation(), if the 'index' attributes
2929
* | | are 2 and 1 respectively)
3030
* \ /
3131
* \ /

0 commit comments

Comments
 (0)