This is an automated email from the ASF dual-hosted git repository.
bgawrych pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-mxnet.git
The following commit(s) were added to refs/heads/master by this push:
new ecb5026116 Comments formatting fix (#21101)
ecb5026116 is described below
commit ecb50261163c5d4afe307d6e1224530151d96c22
Author: DominikaJedynak <[email protected]>
AuthorDate: Thu Jul 21 09:43:23 2022 +0200
Comments formatting fix (#21101)
* Fix comments formating
* Review suggestion
* Fix file name
---
src/operator/subgraph/build_subgraph.cc | 14 +++++++-------
src/operator/subgraph/default_subgraph_property.cc | 4 ++--
src/operator/subgraph/default_subgraph_property_v2.cc | 4 ++--
src/operator/subgraph/dnnl/dnnl_fc_sum_fuse_property.h | 4 ++--
src/operator/subgraph/dnnl/dnnl_transformer_qk_property.h | 2 +-
.../subgraph/partitioner/custom_subgraph_property.h | 8 +++++---
src/operator/subgraph/static_shape_subgraph_property.cc | 4 ++--
src/operator/subgraph/subgraph_property.h | 12 +++++++-----
8 files changed, 28 insertions(+), 24 deletions(-)
diff --git a/src/operator/subgraph/build_subgraph.cc
b/src/operator/subgraph/build_subgraph.cc
index 4acaa22cdc..d3c23dd5b9 100644
--- a/src/operator/subgraph/build_subgraph.cc
+++ b/src/operator/subgraph/build_subgraph.cc
@@ -105,7 +105,7 @@ void ResetNodeLabels(const nnvm::Graph& g,
subgraph_nodes->clear();
}
-/*
+/*!
* \brief Prepare NodeAttr for node. NodeAttr will be used in
SubgraphSelectorV2.
*/
static const std::shared_ptr<NodeAttr> PrepareNodeAttr(const nnvm::Graph& g,
@@ -172,12 +172,12 @@ bool HasInputEntries(const nnvm::Graph& g,
* and the outside nodes. If so, add the node that should break the loop
* in excluded_nodes and return false. Otherwise, return true.
* \param g the whole graph
- * \subgraph_selector determines whether the visited node should be choosen or
not
- * \label the label of the current subgraph
- * \snid node id of the seed simple node
- * \simple_nodes all simple nodes in the top sorted order
- * \subgraph_nodes all the nodes belonging to the same subgraph of seed node
- * \excluded_nodes set of nodes that should be excluded from the current
subgraph
+ * \param subgraph_selector determines whether the visited node should be
choosen or not
+ * \param label the label of the current subgraph
+ * \param snid node id of the seed simple node
+ * \param simple_nodes all simple nodes in the top sorted order
+ * \param subgraph_nodes all the nodes belonging to the same subgraph of seed
node
+ * \param excluded_nodes set of nodes that should be excluded from the current
subgraph
*/
bool LabelSubgraph(const nnvm::Graph& g,
SubgraphSelectorV2Ptr subgraph_selector,
diff --git a/src/operator/subgraph/default_subgraph_property.cc
b/src/operator/subgraph/default_subgraph_property.cc
index 576e5c1dab..f57d0f3d33 100644
--- a/src/operator/subgraph/default_subgraph_property.cc
+++ b/src/operator/subgraph/default_subgraph_property.cc
@@ -26,7 +26,7 @@
namespace mxnet {
namespace op {
-/*
+/*!
* This selects nodes for a subgraph that only contains operators
* in a given set and it visits nodes via both input and output links.
*/
@@ -51,7 +51,7 @@ class ContainOpSelector : public SubgraphSelector {
const std::unordered_set<std::string>& op_names_;
};
-/*
+/*!
* This subgraph property finds a subgraph whose nodes have only operators
* within a set. The operators in the subgraph will be executed by _CachedOp.
*/
diff --git a/src/operator/subgraph/default_subgraph_property_v2.cc
b/src/operator/subgraph/default_subgraph_property_v2.cc
index c4cc9fe433..e0a52bcad1 100644
--- a/src/operator/subgraph/default_subgraph_property_v2.cc
+++ b/src/operator/subgraph/default_subgraph_property_v2.cc
@@ -26,7 +26,7 @@
namespace mxnet {
namespace op {
-/*
+/*!
* This selects nodes for a subgraph that only contains operators
* in a given set and it visits nodes via both input and output links.
*/
@@ -54,7 +54,7 @@ class ContainOpSelectorV2 : public SubgraphSelectorV2 {
const std::unordered_set<std::string>& op_names_;
};
-/*
+/*!
* This subgraph property finds a subgraph whose nodes have only operators
* within a set. The operators in the subgraph will be executed by _CachedOp.
*/
diff --git a/src/operator/subgraph/dnnl/dnnl_fc_sum_fuse_property.h
b/src/operator/subgraph/dnnl/dnnl_fc_sum_fuse_property.h
index 34d3c7a86b..c434b76e03 100644
--- a/src/operator/subgraph/dnnl/dnnl_fc_sum_fuse_property.h
+++ b/src/operator/subgraph/dnnl/dnnl_fc_sum_fuse_property.h
@@ -17,8 +17,8 @@
* under the License.
*/
-/*
- \file
+/*!
+ \file dnnl_fc_sum_fuse_property.h
\brief For fusing FullyConnected operator with element-wise add.
Element-wise add operator is replaced by DNNL FC "sum" post operator.
diff --git a/src/operator/subgraph/dnnl/dnnl_transformer_qk_property.h
b/src/operator/subgraph/dnnl/dnnl_transformer_qk_property.h
index a70be63283..9f4a9991a1 100644
--- a/src/operator/subgraph/dnnl/dnnl_transformer_qk_property.h
+++ b/src/operator/subgraph/dnnl/dnnl_transformer_qk_property.h
@@ -62,7 +62,7 @@ class SgDNNLTransformerQKSelector : public SubgraphSelectorV2
{
kSuccess
};
- /*
+ /*!
kStart ---> kFirstSwapAx ---> kSecondSwapAx ---> kFirstReshape --->
kSecondReshape ---> kSuccess
Each status except kStart is connected with kFail
*/
diff --git a/src/operator/subgraph/partitioner/custom_subgraph_property.h
b/src/operator/subgraph/partitioner/custom_subgraph_property.h
index 777eebfc52..5b29efe15f 100644
--- a/src/operator/subgraph/partitioner/custom_subgraph_property.h
+++ b/src/operator/subgraph/partitioner/custom_subgraph_property.h
@@ -17,7 +17,9 @@
* under the License.
*/
-/*
+/*!
+ * \file custom_subgraph_property.h
+ *
* This file contains an implementation of a subgraph property
* that interfaces between MXNet and custom subgraph properties
* created by users in external libraries. It does not implement
@@ -41,7 +43,7 @@
namespace mxnet {
namespace op {
-/*
+/*!
* This selects nodes for a subgraph based on node name as supplied
* by the supportedOps from an external library. It visits nodes via
* both input and output links.
@@ -138,7 +140,7 @@ class CustomContainOpSelector : public SubgraphSelector {
std::unordered_map<const nnvm::Node*, unsigned> node2id_;
};
-/*
+/*!
* This subgraph property finds a subgraph that only contains
* nodes as specified by the supportedOps from an external library.
* The operators in the subgraph will be executed by the operator
diff --git a/src/operator/subgraph/static_shape_subgraph_property.cc
b/src/operator/subgraph/static_shape_subgraph_property.cc
index 90f16fe2e1..6d1d4ab584 100644
--- a/src/operator/subgraph/static_shape_subgraph_property.cc
+++ b/src/operator/subgraph/static_shape_subgraph_property.cc
@@ -24,7 +24,7 @@
namespace mxnet {
namespace op {
-/*
+/*!
* This selects nodes for a subgraph that only contains static shape operators
* and it visits nodes via both input and output links.
*/
@@ -58,7 +58,7 @@ class StaticShapeOpSelector : public SubgraphSelector {
std::unordered_set<std::string> unsupported_op_names_{"_npi_dstack",
"_npi_hstack"};
};
-/*
+/*!
* This subgraph property finds a subgraph whose nodes have only static shape
operators.
* The operators in the subgraph will be executed by _CachedOp.
*/
diff --git a/src/operator/subgraph/subgraph_property.h
b/src/operator/subgraph/subgraph_property.h
index 563516d51e..c2309f06cd 100644
--- a/src/operator/subgraph/subgraph_property.h
+++ b/src/operator/subgraph/subgraph_property.h
@@ -64,7 +64,7 @@ struct NodeAttr {
std::vector<int> itype;
};
-/*
+/*!
* This provides criteria for the graph partitioning algorithm to select
* nodes to subgraphs.
* The algorithm first sorts all the nodes in topological order, and then
@@ -588,10 +588,12 @@ class SubgraphBackendRegistry {
std::unordered_map<std::string, SubgraphBackendPtr> backend_map_;
};
-// This op name set is for setting the names of operators that should be
grouped into
-// subgraphs. In practice, every backend accelerator should have a predefined
name set.
-// This set is only used for the testing purpose.
-// key: property name, value: op name set
+/*!
+ * This op name set is for setting the names of operators that should be
grouped into
+ * subgraphs. In practice, every backend accelerator should have a predefined
name set.
+ * This set is only used for the testing purpose.
+ * key: property name, value: op name set
+ */
typedef dmlc::ThreadLocalStore<std::unordered_map<std::string,
std::unordered_set<std::string>>>
SubgraphPropertyOpNameSet;
