allow variadic parameters of different types (#1615)

gramalingam · web-flow · commit eb4b7c2cc2a0 · 2018-11-14T16:54:51.000-08:00
* allow variadic parameters of different types

* fix formatting issues

* add isHomogeneous to defs.pyi
diff --git a/docs/Changelog.md b/docs/Changelog.md
@@ -1839,7 +1839,7 @@ This version of the operator has been available since version 1 of the default O
 #### Outputs (1 - &#8734;)
 
 <dl>
-<dt><tt>outputs</tt> (variadic) : V</dt>
+<dt><tt>outputs</tt> (variadic, heterogeneous) : V</dt>
 <dd>Values that are live-out to the enclosing scope. The return values in the `then_branch` and `else_branch` must be of the same shape and same data type.</dd>
 </dl>
 
@@ -2445,14 +2445,14 @@ This version of the operator has been available since version 1 of the default O
 <dd>A maximum trip-count for the loop specified at runtime. Optional. pass empty string to skip.</dd>
 <dt><tt>cond</tt> : B</dt>
 <dd>A boolean termination condition. Pass empty string to skip.</dd>
-<dt><tt>v_initial</tt> (variadic) : V</dt>
+<dt><tt>v_initial</tt> (variadic, heterogeneous) : V</dt>
 <dd>The initial values of any loop-carried dependencies (values that change across loop iterations)</dd>
 </dl>
 
 #### Outputs (1 - &#8734;)
 
 <dl>
-<dt><tt>v_final_and_scan_outputs</tt> (variadic) : V</dt>
+<dt><tt>v_final_and_scan_outputs</tt> (variadic, heterogeneous) : V</dt>
 <dd>Final N loop carried dependency values then K scan_outputs</dd>
 </dl>
 
@@ -8288,14 +8288,14 @@ This version of the operator has been available since version 8 of the default O
 <dl>
 <dt><tt>sequence_lens</tt> (optional) : I</dt>
 <dd>Optional tensor specifying lengths of the sequences in a batch. If this input is not specified, all sequences are assumed to be of the maximum sequence length (the dimension of the sequence axis of the scan_input tensors).</dd>
-<dt><tt>initial_state_and_scan_inputs</tt> (variadic) : V</dt>
+<dt><tt>initial_state_and_scan_inputs</tt> (variadic, heterogeneous) : V</dt>
 <dd>Initial values of the loop's N state variables followed by M scan_inputs</dd>
 </dl>
 
 #### Outputs (1 - &#8734;)
 
 <dl>
-<dt><tt>final_state_and_scan_outputs</tt> (variadic) : V</dt>
+<dt><tt>final_state_and_scan_outputs</tt> (variadic, heterogeneous) : V</dt>
 <dd>Final values of the loop's N state variables followed by K scan_outputs</dd>
 </dl>
 
diff --git a/docs/Operators.md b/docs/Operators.md
@@ -4711,7 +4711,7 @@ This version of the operator has been available since version 1 of the default O
 #### Outputs (1 - &#8734;)
 
 <dl>
-<dt><tt>outputs</tt> (variadic) : V</dt>
+<dt><tt>outputs</tt> (variadic, heterogeneous) : V</dt>
 <dd>Values that are live-out to the enclosing scope. The return values in the `then_branch` and `else_branch` must be of the same shape and same data type.</dd>
 </dl>
 
@@ -5695,14 +5695,14 @@ This version of the operator has been available since version 1 of the default O
 <dd>A maximum trip-count for the loop specified at runtime. Optional. pass empty string to skip.</dd>
 <dt><tt>cond</tt> : B</dt>
 <dd>A boolean termination condition. Pass empty string to skip.</dd>
-<dt><tt>v_initial</tt> (variadic) : V</dt>
+<dt><tt>v_initial</tt> (variadic, heterogeneous) : V</dt>
 <dd>The initial values of any loop-carried dependencies (values that change across loop iterations)</dd>
 </dl>
 
 #### Outputs (1 - &#8734;)
 
 <dl>
-<dt><tt>v_final_and_scan_outputs</tt> (variadic) : V</dt>
+<dt><tt>v_final_and_scan_outputs</tt> (variadic, heterogeneous) : V</dt>
 <dd>Final N loop carried dependency values then K scan_outputs</dd>
 </dl>
 
@@ -9705,14 +9705,14 @@ This version of the operator has been available since version 8 of the default O
 <dl>
 <dt><tt>sequence_lens</tt> (optional) : I</dt>
 <dd>Optional tensor specifying lengths of the sequences in a batch. If this input is not specified, all sequences are assumed to be of the maximum sequence length (the dimension of the sequence axis of the scan_input tensors).</dd>
-<dt><tt>initial_state_and_scan_inputs</tt> (variadic) : V</dt>
+<dt><tt>initial_state_and_scan_inputs</tt> (variadic, heterogeneous) : V</dt>
 <dd>Initial values of the loop's N state variables followed by M scan_inputs</dd>
 </dl>
 
 #### Outputs (1 - &#8734;)
 
 <dl>
-<dt><tt>final_state_and_scan_outputs</tt> (variadic) : V</dt>
+<dt><tt>final_state_and_scan_outputs</tt> (variadic, heterogeneous) : V</dt>
 <dd>Final values of the loop's N state variables followed by K scan_outputs</dd>
 </dl>
 
diff --git a/onnx/cpp2py_export.cc b/onnx/cpp2py_export.cc
@@ -81,7 +81,9 @@ PYBIND11_MODULE(onnx_cpp2py_export, onnx_cpp2py_export) {
       .def_property_readonly("typeStr", &OpSchema::FormalParameter::GetTypeStr)
       .def_property_readonly(
           "description", &OpSchema::FormalParameter::GetDescription)
-      .def_property_readonly("option", &OpSchema::FormalParameter::GetOption);
+      .def_property_readonly("option", &OpSchema::FormalParameter::GetOption)
+      .def_property_readonly(
+          "isHomogeneous", &OpSchema::FormalParameter::GetIsHomogeneous);
 
   py::enum_<AttributeProto::AttributeType>(op_schema, "AttrType")
       .value("FLOAT", AttributeProto::FLOAT)
diff --git a/onnx/defs/controlflow/defs.cc b/onnx/defs/controlflow/defs.cc
@@ -396,7 +396,8 @@ ONNX_OPERATOR_SET_SCHEMA(
             "the `then_branch` and `else_branch` must be of the same shape and same "
             "data type.",
             "V",
-            OpSchema::Variadic)
+            OpSchema::Variadic,
+            false)
         .Attr(
             "then_branch",
             "Graph to run if condition is true. Has N outputs: values you wish to "
@@ -551,13 +552,15 @@ ONNX_OPERATOR_SET_SCHEMA(
             "The initial values of any loop-carried dependencies (values that "
             "change across loop iterations)",
             "V",
-            OpSchema::Variadic)
+            OpSchema::Variadic,
+            false)
         .Output(
             0,
             "v_final_and_scan_outputs",
             "Final N loop carried dependency values then K scan_outputs",
             "V",
-            OpSchema::Variadic)
+            OpSchema::Variadic,
+            false)
         .Attr(
             "body",
             "The graph run each iteration. It has 2+N inputs: (iteration_num, "
@@ -720,13 +723,15 @@ ONNX_OPERATOR_SET_SCHEMA(
             "initial_state_and_scan_inputs",
             "Initial values of the loop's N state variables followed by M scan_inputs",
             "V",
-            OpSchema::Variadic)
+            OpSchema::Variadic,
+            false)
         .Output(
             0,
             "final_state_and_scan_outputs",
             "Final values of the loop's N state variables followed by K scan_outputs",
             "V",
-            OpSchema::Variadic)
+            OpSchema::Variadic,
+            false)
         .Attr(
             "body",
             "The graph run each iteration. It has N+M inputs: "
diff --git a/onnx/defs/gen_doc.py b/onnx/defs/gen_doc.py
@@ -152,7 +152,10 @@ def format_value(value):  # type: (Any) -> Text
             if OpSchema.FormalParameterOption.Optional == input.option:
                 option_str = " (optional)"
             elif OpSchema.FormalParameterOption.Variadic == input.option:
-                option_str = " (variadic)"
+                if input.isHomogeneous:
+                    option_str = " (variadic)"
+                else:
+                    option_str = " (variadic, heterogeneous)"
             s += '<dt><tt>{}</tt>{} : {}</dt>\n'.format(input.name, option_str, input.typeStr)
             s += '<dd>{}</dd>\n'.format(input.description)
         s += '</dl>\n'
@@ -171,7 +174,10 @@ def format_value(value):  # type: (Any) -> Text
             if OpSchema.FormalParameterOption.Optional == output.option:
                 option_str = " (optional)"
             elif OpSchema.FormalParameterOption.Variadic == output.option:
-                option_str = " (variadic)"
+                if output.isHomogeneous:
+                    option_str = " (variadic)"
+                else:
+                    option_str = " (variadic, heterogeneous)"
             s += '<dt><tt>{}</tt>{} : {}</dt>\n'.format(output.name, option_str, output.typeStr)
             s += '<dd>{}</dd>\n'.format(output.description)
         s += '</dl>\n'
diff --git a/onnx/defs/schema.cc b/onnx/defs/schema.cc
@@ -32,22 +32,26 @@ OpSchema::FormalParameter::FormalParameter(
     DataTypeSet allowed_type_set,
     std::string type_str,
     std::string description,
-    FormalParameterOption param_option)
+    FormalParameterOption param_option,
+    bool is_homogeneous)
     : name_(std::move(name)),
       type_set_(std::move(allowed_type_set)),
       type_str_(std::move(type_str)),
       description_(std::move(description)),
-      param_option_(param_option) {}
+      param_option_(param_option),
+      is_homogeneous_(is_homogeneous) {}
 
 OpSchema::FormalParameter::FormalParameter(
     std::string name,
     std::string description,
     std::string type_str,
-    FormalParameterOption param_option)
+    FormalParameterOption param_option,
+    bool is_homogeneous)
     : name_(std::move(name)),
       type_str_(std::move(type_str)),
       description_(std::move(description)),
-      param_option_(param_option) {}
+      param_option_(param_option),
+      is_homogeneous_(is_homogeneous) {}
 
 const std::string& OpSchema::FormalParameter::GetName() const {
   return name_;
@@ -73,14 +77,22 @@ OpSchema::FormalParameterOption OpSchema::FormalParameter::GetOption() const {
   return param_option_;
 }
 
+bool OpSchema::FormalParameter::GetIsHomogeneous() const {
+  return is_homogeneous_;
+}
+
 OpSchemaRegistry* OpSchemaRegistry::Instance() {
   static OpSchemaRegistry instance;
   return &instance;
 }
 
 void OpSchema::Verify(const NodeProto& node) const {
   if (deprecated_) {
-    fail_check("Operator '", name_, "' has been deprecated since version ", since_version_);
+    fail_check(
+        "Operator '",
+        name_,
+        "' has been deprecated since version ",
+        since_version_);
   }
 
   // Check the number of inputs.
@@ -101,7 +113,9 @@ void OpSchema::Verify(const NodeProto& node) const {
     fail_check(
         "Node (",
         node.name(),
-        ") has input size ", node.input_size(), " not in allowed input sizes.");
+        ") has input size ",
+        node.input_size(),
+        " not in allowed input sizes.");
   }
 
   // Check the number of outputs.
@@ -122,7 +136,9 @@ void OpSchema::Verify(const NodeProto& node) const {
     fail_check(
         "Node (",
         node.name(),
-        "has output size ", node.output_size(), " not in allowed output sizes.");
+        "has output size ",
+        node.output_size(),
+        " not in allowed output sizes.");
   }
 
   // Check the values of inputs / outputs
@@ -203,7 +219,8 @@ void OpSchema::Verify(const NodeProto& node) const {
     } else if (allows_unchecked_attributes_ || isInternalSymbol(name)) {
       continue;
     } else {
-      fail_check("Unrecognized attribute: ", name, " for operator ", node.op_type());
+      fail_check(
+          "Unrecognized attribute: ", name, " for operator ", node.op_type());
     }
 
     if (attr_proto.has_ref_attr_name()) {
@@ -491,15 +508,17 @@ OpSchema& OpSchema::Input(
     std::string name,
     std::string description,
     std::string type_str,
-    OpSchema::FormalParameterOption param_option) {
+    OpSchema::FormalParameterOption param_option,
+    bool is_homogeneous) {
   if (int(inputs_.size()) <= n) {
     inputs_.resize(n + 1);
   }
   inputs_[n] = FormalParameter(
       std::move(name),
       std::move(description),
       std::move(type_str),
-      param_option);
+      param_option,
+      is_homogeneous);
   return *this;
 }
 
@@ -508,29 +527,33 @@ OpSchema& OpSchema::Input(
     const char* name,
     const char* description,
     const char* type_str,
-    FormalParameterOption param_option) {
+    FormalParameterOption param_option,
+    bool is_homogeneous) {
   return Input(
       n,
       std::string(name),
       std::string(description),
       std::string(type_str),
-      param_option);
+      param_option,
+      is_homogeneous);
 }
 
 OpSchema& OpSchema::Output(
     int n,
     std::string name,
     std::string description,
     std::string type_str,
-    OpSchema::FormalParameterOption param_option) {
+    OpSchema::FormalParameterOption param_option,
+    bool is_homogeneous) {
   if (int(outputs_.size()) <= n) {
     outputs_.resize(n + 1);
   }
   outputs_[n] = FormalParameter(
       std::move(name),
       std::move(description),
       std::move(type_str),
-      param_option);
+      param_option,
+      is_homogeneous);
   return *this;
 }
 
@@ -539,13 +562,15 @@ OpSchema& OpSchema::Output(
     const char* name,
     const char* description,
     const char* type_str,
-    FormalParameterOption param_option) {
+    FormalParameterOption param_option,
+    bool is_homogeneous) {
   return Output(
       n,
       std::string(name),
       std::string(description),
       std::string(type_str),
-      param_option);
+      param_option,
+      is_homogeneous);
 }
 
 OpSchema& OpSchema::TypeConstraint(
@@ -722,7 +747,8 @@ std::ostream& operator<<(std::ostream& out, const OpSchema& schema) {
   return out;
 }
 
-OpSchemaRegistry::DomainToVersionRange& OpSchemaRegistry::DomainToVersionRange::Instance() {
+OpSchemaRegistry::DomainToVersionRange&
+OpSchemaRegistry::DomainToVersionRange::Instance() {
   static DomainToVersionRange domain_to_version_range;
   return domain_to_version_range;
 };
diff --git a/onnx/defs/schema.h b/onnx/defs/schema.h
diff --git a/onnx/onnx_cpp2py_export/defs.pyi b/onnx/onnx_cpp2py_export/defs.pyi
