Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement a ONNX to ONNX Script code generator based on libcst #873

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

abock
Copy link
Contributor

@abock abock commented Jul 13, 2023

[WIP] Proposal to use libcst for code generation

This PR is somewhat experimental, but goes far enough to illustrate using libcst for code generation of ONNX to ONNX Script. It is nearly as complete as the existing template-based onnxscript.proto2python, and lays the groundwork for implementing more "raising" passes to produce idiomatic Python code.

I implemented this to learn more about libcst and currently I am heavily leaning on wanting to take a full dependency on libcst. I see adoption happening in three phases:

  1. Continue with the work in this PR by implementing more transformers to produce idiomatic Python ONNX Script from ONNX. This keeps the libcst dependency scoped to just this feature.

  2. Port the existing opgen generator to use libcst. Again, the libcst dependency would be scoped to just this code generator.

  3. Finally, let's port our existing Python AST support that uses the builtin ast module to libcst. I suspect if we do this, lots of utilities that are necessary for (1) and (2) will be highly useful here. More importantly, libcst provides scope analysis and qualified name resolving, which is the basis for doing real semantic analysis work with CSTTransformer.

Also note, that if we implement various passes as CSTTransformers, we can begin to define a very nice UX in IDEs for "lightbulb fixes". For example any pass we may apply as part of builtin code generation for ONNX to ONNX Script (phase 1), we can surface to the IDEs to upgrade user code to more idiomatic Python. PyTorch is also beginning to use libcst for providing fixes to PyTorch code as well.

Depending on libcst

libcst itself does not carry many dependencies and is relatively small (about 10MB). Comparatively, onnx itself is rather large (112MB). Thus, I am not too concerned about the size of the libcst dependency, considering it would become central to ONNX Script across the three identified phases.

Dependency Cost

Command Installed site-packages Disk Usage Delta
python3.10 -m venv venv --upgrade-deps setuptools, pip 19MB Baseline
pip install onnx onnx, google, protobuf, numpy, typing_extensions 131MB +112MB
pip install libcst libcst, pyyaml, mypy_extensions, typing_inspect 142MB +11MB

Current capability of this PR:

  • Adds some general codegen utilities based on libcst

  • Implements an ONNX to ONNX Script generator: the base converter produces ONNX Script that is very 1:1 with the structure of ONNX, and transformers are implemented to raise the generated code to more idiomatic Python that ONNX Script supports; this commit provides support for raising to Python binary operators and raising Constant/make_tensor to supported Python constants; more transformers need to be implemented, but this commit can be used as a guide.

  • Adds a new top-level command line interface, allowing the code generator to be invoked:

    python -m onnxscript convert model.onnx

- Adds some general codegen utilities based on libcst

- Implements an ONNX to ONNX Script generator: the base converter
  produces ONNX Script that is very 1:1 with the structure of ONNX,
  and transformers are implemented to raise the generated code to
  more idiomatic Python that ONNX Script supports; this commit
  provides support for raising to Python binary operators and raising
  Constant/make_tensor to supported Python constants; more transformers
  need to be implemented, but this commit can be used as a guide.

- Adds a new top-level command line interface, allowing the code
  generator to be invoked:

  python -m onnxscript convert model.onnx
@codecov
Copy link

codecov bot commented Jul 13, 2023

❌ 27 Tests Failed:

Tests completed Failed Passed Skipped
5847 27 5820 2765
View the top 3 failed tests by shortest run time
::onnxscript.codeanalysis.__init__
Stack Traces | 0s run time
ImportError while importing test module '.../onnxscript/codeanalysis/__init__.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
.../Library/Frameworks/Python.framework/Versions/3.10/lib/python3.10/importlib/__init__.py:126: in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
onnxscript/codeanalysis/__init__.py:17: in <module>
    import libcst as cst
E   ModuleNotFoundError: No module named 'libcst'
::onnxscript.codeanalysis.onnx_to_onnxscript
Stack Traces | 0s run time
ImportError while importing test module '.../onnxscript/codeanalysis/onnx_to_onnxscript.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
.../Library/Frameworks/Python.framework/Versions/3.10/lib/python3.10/importlib/__init__.py:126: in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
onnxscript/codeanalysis/__init__.py:17: in <module>
    import libcst as cst
E   ModuleNotFoundError: No module named 'libcst'
onnxscript.backend.onnx_export_test.TestOnnxBackEnd::test_export2python_produces_correct_onnx_script_model_1252_test_tril_square
Stack Traces | 0.003s run time
onnxscript\backend\onnx_export_test.py:137: in extract_functions
    mod = importlib.import_module(import_name)
C:\hostedtoolcache\windows\Python\3.10.11\x64\lib\importlib\__init__.py:126: in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
E   ModuleNotFoundError: No module named 'tests.onnx_backend_test_code.test_tril_square'

The above exception was the direct cause of the following exception:
.nox\test\lib\site-packages\parameterized\parameterized.py:620: in standalone_func
    return func(*(a + p.args), **p.kwargs, **kw)
onnxscript\backend\onnx_export_test.py:271: in test_export2python_produces_correct_onnx_script_model
    functions = extract_functions(backend_test.name, code, self.test_folder)
onnxscript\backend\onnx_export_test.py:139: in extract_functions
    raise AssertionError(
E   AssertionError: Unable to import 'tests.onnx_backend_test_code.test_tril_square' (e=No module named 'tests.onnx_backend_test_code.test_tril_square') (file: 'D:\\a\\onnxscript\\onnxscript\\tests\\onnx_backend_test_code\\test_tril_square.py', absolute path: 'D:\\a\\onnxscript\\onnxscript\\tests\\onnx_backend_test_code\\test_tril_square.py', current folder: D:\a\onnxscript\onnxscript
E   ---- CONTENT --
E   import numpy
E   from onnx import TensorProto
E   from onnx.helper import make_tensor
E   from onnxscript import script, external_tensor
E   from onnxscript.values import Opset
E   from onnxscript.onnx_types import INT64
E   from onnxscript.onnx_opset import opset14
E   
E   @script()
E   def bck_test_tril_square(x: INT64[2,3,3]) -> (INT64[2,3,3]):
E       y = opset14.Trilu(x, upper=0)
E       return y

To view more test analytics, go to the Test Analytics Dashboard
📢 Thoughts on this report? Let us know!

@justinchuby justinchuby self-requested a review July 13, 2023 18:01

numpy_tensor = onnx.numpy_helper.to_array(tensor_proto)

return cst.Call(
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is one example where verbosity makes this harder to read than the existing template-based mechanism. Do you think it might make sense to judiciously mix parsed strings, with formatted strings, with cst constructors to get the best of both worlds?

@justinchuby justinchuby marked this pull request as ready for review January 27, 2025 18:14

@abock please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

qualname: str,
source: cstmeta.QualifiedNameSource | None = None,
) -> bool:
...

Check notice

Code scanning / CodeQL

Statement has no effect Note

This statement has no effect.
qualname: re.Pattern[str],
source: cstmeta.QualifiedNameSource | None = None,
) -> re.Match[str] | None:
...

Check notice

Code scanning / CodeQL

Statement has no effect Note

This statement has no effect.
from __future__ import annotations

import argparse
from pathlib import Path

Check warning

Code scanning / lintrunner

RUFF/TID251 Warning

pathlib is banned: Using pathlib can impact performance. Use os.path instead.
See https://docs.astral.sh/ruff/rules/banned-api
import os
from collections import defaultdict
from dataclasses import dataclass
from pathlib import Path

Check warning

Code scanning / lintrunner

RUFF/TID251 Warning

pathlib is banned: Using pathlib can impact performance. Use os.path instead.
See https://docs.astral.sh/ruff/rules/banned-api
from pathlib import Path
from typing import Final, Protocol, Sequence, runtime_checkable

import libcst as cst

Check failure

Code scanning / lintrunner

MYPY/import-not-found Error

Cannot find implementation or library stub for module named "libcst" To disable, use # type: ignore[import-not-found]
from typing import Final, Protocol, Sequence, runtime_checkable

import libcst as cst
import libcst.matchers as cstm

Check failure

Code scanning / lintrunner

MYPY/import-not-found Error

Cannot find implementation or library stub for module named "libcst.matchers" To disable, use # type: ignore[import-not-found]

import libcst as cst
import libcst.matchers as cstm
import libcst.metadata as cstmeta

Check failure

Code scanning / lintrunner

MYPY/import-not-found Error

Cannot find implementation or library stub for module named "libcst.metadata" To disable, use # type: ignore[import-not-found]
name: str
version: int = 0

def __eq__(self, __value: object) -> bool:

Check warning

Code scanning / lintrunner

RUFF/PYI063 Warning

Use PEP 570 syntax for positional-only parameters.
See https://docs.astral.sh/ruff/rules/pep484-style-positional-only-parameter
def translate_graph_proto(
self,
function_proto: onnx.GraphProto,
func_type: Literal["graph"] | Literal["script"] = "graph",

Check warning

Code scanning / lintrunner

RUFF/PYI030 Warning

Multiple literal members in a union. Use a single literal, e.g. Literal["graph", "script"].
See https://docs.astral.sh/ruff/rules/unnecessary-literal-union
def __make_function(
self,
proto: onnx.GraphProto | onnx.FunctionProto,
func_type: Literal["graph"] | Literal["script"],

Check warning

Code scanning / lintrunner

RUFF/PYI030 Warning

Multiple literal members in a union. Use a single literal, e.g. Literal["graph", "script"].
See https://docs.astral.sh/ruff/rules/unnecessary-literal-union

for node in proto.node:
for stmt in self.translate_node_proto(node):
body.append(stmt)

Check warning

Code scanning / lintrunner

RUFF/PERF402 Warning

Use list or list.copy to create a copy of a list.
See https://docs.astral.sh/ruff/rules/manual-list-copy
return constant_op_call
vals_expr = vals_expr.elements[0].value
else:
kwarg += "s"

Check failure

Code scanning / lintrunner

PYLINT/E0602 Error

Undefined variable 'kwarg' (undefined-variable)
See undefined-variable. To disable, use # pylint: disable=undefined-variable
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants