Print utility extension #4246

gramalingam · 2022-06-02T18:56:52Z

Description

Extend the printer utilities and expose them in Python.

Create a class to encapsulate printer
Add support for indentation for more readable output for sub-graphs
Add support for printing ModelProto
Expose top-level functionality to Python

Motivation and Context

#4231

Limitations

Need support for external tensors. A textual-representation is not suitable for large tensor constants.

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

onnx/defs/printer.cc

onnx/defs/parser.h

onnx/defs/printer.cc

xadupre · 2022-06-06T15:22:00Z

onnx/defs/printer.cc

        break;
      case TensorProto::DataType::TensorProto_DataType_STRING: {
        const char* sep = "{";
        for (auto& elt : tensor.string_data()) {
-          os << sep << "\"" << elt << "\"";
+          output << sep << "\"" << elt << "\"";


escaping "?

Added support for escape character.

onnx/defs/printer.cc

onnx/printer.py

onnx/test/printer_test.py

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

xadupre · 2022-06-09T10:13:18Z

onnx/printer.py

+
+
+def to_text(proto: Union[onnx.ModelProto, onnx.FunctionProto, onnx.GraphProto]) -> Text:
+    if isinstance(proto, onnx.ModelProto):


It is better this way. There should be a documentation for this function. I still think the call to SerializeToString() should be avoided.

How do we avoid the serialization? (Of course, we can reimplement the pretty-printer in Python, but I assume that's not what you mean? That would lead to a potential divergence of behavior between C++ and Python. Since this usage is mostly for debugging and understanding etc., I think the efficiency issue is not that critical.)

The model is serialized here and then deserialized in C++. I think these steps should be avoided. The only change to make that happen is to change the C++ signature to take FunctionProto, ModelProto or a GraphProto and remove the call to ParseFromString. Users may call this function on deep learning models to compare two graphs. Avoiding serialization could make it a lot faster.

But a Python ModelProto and a C++ ModelProto are different types, with different representations. How do you convert between those?

Specifically, I don't think that Python serialization and C++ deserialization are inverses of each other (at least, it is not documented to be so, and I doubt it is). So, their composition is not a "no-op", but it serves to convert from the python-representation to C++-representation.

I did some measurements. I was hoping to see that serialization is independant of the size but it does not. So call SerializeToString and then ParseFromString is really inefficient.

A Python ModelProto and a C++ ModelProto are different: the Python ModelProto wraps the C++ ModelProto, probably in a capsule. I expect that the Python and C++ SerializeToString to produce the exact same sequence of bytes. That's what pybind11 does. They use swig to do it for ModelProto. It should work in a similar way.

Of course, SerializeToString will produce the same sequence of bytes, since that is defined by the Protobuf semantics. But that is not the question. The question is whether the C++ in-memory-representation is available in a Python ModelProto (as you imply). If so, what is the API/call we can use to get the C++ in-memory-representation from a Python ModelProto?

(The question is about the Deserialize part, that is: creating the in-memory-representation used by the two languages).

I don't see why the in-memory-representation would be different. I found this: https://github.com/pybind/pybind11_protobuf but I have some trouble to link it with onnx.

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

onnx/defs/parser.h

onnx/defs/printer.cc

onnx/defs/printer.h

onnx/onnx_cpp2py_export/parser.pyi

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

wschin

LGTM now. Thank you!

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

gramalingam · 2022-06-14T03:47:06Z

@liqunfu : could you take a look? This requires approval from archinfra sig too. Thanks!

jcwchen

Only one nit comment. Exciting to see Python printer has more supports!

jcwchen · 2022-06-21T18:56:55Z

onnx/test/printer_test.py

+# SPDX-License-Identifier: Apache-2.0
+import onnx
+import unittest
+from onnx import helper, parser, printer, GraphProto


nit: import alphabetically. Justin have an ongoing PR for it so going forward it would be great if we can always keep the order.

I can fix this manually, but out of curiosity, what will happen with/after Justins PR? Is there a specific auto-format tool/command recommended for people to apply? Thanks!

Good question. I think all these format tools will be included into style.sh as mentioned here. Then developer can simply run single script to check whether there is any error before submitting CIs. For auto-apply, perhaps we can also introduce another script if needed.

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

…into python-print-2

* Expose printing methods via Python Signed-off-by: Ganesan Ramalingam <grama@microsoft.com> * Use indentation in printing Signed-off-by: Ganesan Ramalingam <grama@microsoft.com> * Remove extra space Signed-off-by: Ganesan Ramalingam <grama@microsoft.com> * Encapsulate printer logic as a class Signed-off-by: Ganesan Ramalingam <grama@microsoft.com> * Delete VS config files Signed-off-by: Ganesan Ramalingam <grama@microsoft.com> * Add printer test Signed-off-by: Ganesan Ramalingam <grama@microsoft.com> * Add print support for ModelProto Signed-off-by: Ganesan Ramalingam <grama@microsoft.com> * Add to-string template Signed-off-by: Ganesan Ramalingam <grama@microsoft.com> * Cleanup duplicate code Signed-off-by: Ganesan Ramalingam <grama@microsoft.com> * Change Text to str Signed-off-by: Ganesan Ramalingam <grama@microsoft.com> * Fix template specialization compile error Signed-off-by: Ganesan Ramalingam <grama@microsoft.com> * Remove unused variable Signed-off-by: Ganesan Ramalingam <grama@microsoft.com> * Add more print tests Signed-off-by: Ganesan Ramalingam <grama@microsoft.com> * Flake8 warnings Signed-off-by: Ganesan Ramalingam <grama@microsoft.com> * Address PR feedback Signed-off-by: Ganesan Ramalingam <grama@microsoft.com> * FIx mypy error Signed-off-by: Ganesan Ramalingam <grama@microsoft.com> * Fix mypy errors Signed-off-by: Ganesan Ramalingam <grama@microsoft.com> * Fix typing Signed-off-by: Ganesan Ramalingam <grama@microsoft.com> * Format printer.cc Signed-off-by: Ganesan Ramalingam <grama@microsoft.com> * Format code Signed-off-by: Ganesan Ramalingam <grama@microsoft.com> * Support for escape char in strings Signed-off-by: Ganesan Ramalingam <grama@microsoft.com> * Address PR comments Signed-off-by: Ganesan Ramalingam <grama@microsoft.com> * Format file Signed-off-by: Ganesan Ramalingam <grama@microsoft.com> * Fix python imports Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

gramalingam added 9 commits May 19, 2022 14:51

Expose printing methods via Python

f6760af

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

Use indentation in printing

631de1e

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

Remove extra space

db2e22a

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

Encapsulate printer logic as a class

0cb5ca1

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

Delete VS config files

891a4bb

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

Add printer test

922a489

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

Add print support for ModelProto

c310660

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

Add to-string template

6f0937b

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

Cleanup duplicate code

e6ca615

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

gramalingam requested review from a team as code owners June 2, 2022 18:56

gramalingam added 2 commits June 2, 2022 12:07

Merge with main

b4a047e

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

Change Text to str

b763fef

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

xadupre reviewed Jun 6, 2022

View reviewed changes

onnx/defs/printer.cc Outdated Show resolved Hide resolved

xadupre reviewed Jun 6, 2022

View reviewed changes

onnx/defs/parser.h Show resolved Hide resolved

xadupre reviewed Jun 6, 2022

View reviewed changes

onnx/defs/printer.cc Outdated Show resolved Hide resolved

xadupre reviewed Jun 6, 2022

View reviewed changes

onnx/defs/printer.cc Outdated Show resolved Hide resolved

xadupre reviewed Jun 6, 2022

View reviewed changes

onnx/printer.py Outdated Show resolved Hide resolved

xadupre reviewed Jun 6, 2022

View reviewed changes

onnx/test/printer_test.py Show resolved Hide resolved

gramalingam added 6 commits June 8, 2022 15:21

Fix template specialization compile error

1986589

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

Remove unused variable

6a13269

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

Add more print tests

29b6538

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

Flake8 warnings

9df1e03

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

Address PR feedback

ffbfc7a

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

FIx mypy error

46d023b

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

xadupre reviewed Jun 9, 2022

View reviewed changes

gramalingam added 3 commits June 9, 2022 10:42

Fix mypy errors

09c105e

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

Fix typing

9b3b836

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

Format printer.cc

53470d9

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

gramalingam added 3 commits June 9, 2022 12:06

Format code

f776069

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

Support for escape char in strings

f8c166d

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

Merge branch 'main' into python-print-2

7a6f600

wschin reviewed Jun 13, 2022

View reviewed changes

onnx/defs/parser.h Outdated Show resolved Hide resolved

wschin reviewed Jun 13, 2022

View reviewed changes

onnx/defs/printer.cc Show resolved Hide resolved

wschin reviewed Jun 13, 2022

View reviewed changes

onnx/defs/printer.cc Outdated Show resolved Hide resolved

wschin reviewed Jun 13, 2022

View reviewed changes

onnx/defs/printer.h Show resolved Hide resolved

wschin reviewed Jun 13, 2022

View reviewed changes

onnx/onnx_cpp2py_export/parser.pyi Show resolved Hide resolved

Address PR comments

36bc7b5

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

wschin approved these changes Jun 14, 2022

View reviewed changes

gramalingam added 2 commits June 13, 2022 18:44

Format file

459fce0

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

Merge branch 'main' into python-print-2

614c3ba

jcwchen approved these changes Jun 21, 2022

View reviewed changes

jcwchen added the utility label Jun 21, 2022

gramalingam added 2 commits June 21, 2022 13:29

Fix python imports

2296281

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

Merge branch 'main' into python-print-2

1599a54

gramalingam enabled auto-merge (squash) June 21, 2022 20:30

gramalingam added 2 commits June 21, 2022 15:19

Fix flake8 warning

e7d51dc

Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>

Merge branch 'python-print-2' of https://github.com/gramalingam/onnx …

58665ca

…into python-print-2

gramalingam merged commit b064f0a into onnx:main Jun 21, 2022

gramalingam deleted the python-print-2 branch June 21, 2022 22:47

skottmckay mentioned this pull request Aug 11, 2022

Duplicate define operater<< microsoft/onnxruntime#11869

Closed

jcwchen mentioned this pull request Oct 13, 2022

onnx/printer.py is not expose and used #4592

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Print utility extension #4246

Print utility extension #4246

gramalingam commented Jun 2, 2022 •

edited

xadupre Jun 6, 2022

gramalingam Jun 9, 2022

xadupre Jun 9, 2022

gramalingam Jun 9, 2022

xadupre Jun 9, 2022

gramalingam Jun 9, 2022

gramalingam Jun 9, 2022

xadupre Jun 14, 2022

gramalingam Jun 14, 2022

gramalingam Jun 14, 2022

xadupre Jun 14, 2022

xadupre Jun 14, 2022

wschin left a comment

gramalingam commented Jun 14, 2022

jcwchen left a comment

jcwchen Jun 21, 2022

gramalingam Jun 21, 2022

gramalingam Jun 21, 2022

jcwchen Jun 21, 2022



		def to_text(proto: Union[onnx.ModelProto, onnx.FunctionProto, onnx.GraphProto]) -> Text:
		if isinstance(proto, onnx.ModelProto):

Print utility extension #4246

Print utility extension #4246

Conversation

gramalingam commented Jun 2, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wschin left a comment

Choose a reason for hiding this comment

gramalingam commented Jun 14, 2022

jcwchen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gramalingam commented Jun 2, 2022 •

edited