Make onnx-modifier installable and publish to PyPI (#121)

Author: ZhangGe6

.gitignore

@@ -14,4 +14,6 @@ gym/
 local_tmp/
 *ppt
 *pptx
-local_test.py
+*.local.*
+README_pypi.md
+

Dockerfile

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 ZhangGe
+Copyright (c) 2025 ZhangGe
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE

@@ -0,0 +1,10 @@
+from onnx_modifier.flask_server import (launch_flask_server,
+                                        build_desktop_app)
+
+MODE = "LAUNCH_SERVER"
+assert MODE in ["LAUNCH_SERVER", "BUILD_EXE"]
+
+if MODE == "LAUNCH_SERVER":
+    launch_flask_server()
+else:
+    build_desktop_app()

README.md

@@ -0,0 +1,2 @@
+from .onnx_modifier import *
+from .flask_server import *

README_zh-CN.md

@@ -0,0 +1,80 @@
+import argparse
+import logging
+from flask import Flask, render_template, request
+from .onnx_modifier import onnxModifier
+logging.basicConfig(level=logging.INFO)
+
+app = Flask(__name__)
+onnx_modifier = None
+
+@app.route('/')
+def index():
+    return render_template('index.html')
+
+@app.route('/open_model', methods=['POST'])
+def open_model():
+    # https://blog.miguelgrinberg.com/post/handling-file-uploads-with-flask
+    onnx_file = request.files['file']
+
+    global onnx_modifier
+    onnx_modifier = onnxModifier.from_name_protobuf_stream(
+                                    onnx_file.filename, onnx_file.stream)
+
+    return 'OK', 200
+
+@app.route('/download', methods=['POST'])
+def modify_and_download_model():
+    modify_info = request.get_json()
+
+    global onnx_modifier
+    onnx_modifier.reload()   # allow downloading for multiple times
+    onnx_modifier.modify(modify_info)
+    save_path = onnx_modifier.check_and_save_model()
+
+    return save_path
+
+def parse_args():
+    parser = argparse.ArgumentParser()
+    parser.add_argument('--host', type=str, default='127.0.0.1',
+                        help='The hostname to listen on. \
+                              Set this to "0.0.0.0" to have the server available externally as well')
+    parser.add_argument('--port', type=int, default=5000,
+                        help='The port of the webserver. Defaults to 5000.')
+    parser.add_argument('--debug', type=bool, default=False,
+                        help='Enable or disable debug mode.')
+
+    args = parser.parse_args()
+    return args
+
+def launch_flask_server():
+    args = parse_args()
+    app.run(host=args.host, port=args.port, debug=args.debug)
+
+def build_desktop_app():
+    '''generating excutable files.
+
+    The following are some notes about How I worked for it.
+    1. How to make flaskwebgui work as expected:
+        a. install flaskwebgui: `pip install flaskwebgui`
+            - flaskwebgui github repo: https://github.com/ClimenteA/flaskwebgui
+        b. add some scripts to keep server running while gui is running
+            - see here: https://github.com/ClimenteA/flaskwebgui#install
+            - I added the code in the static/index.js (find "keep_alive_server()")
+        c. Then run: `python entry.py`, the web browser will be automatically launched for onnx-modifier
+
+    2. How to generate executable files:
+        a. For Windows:
+            - Run `pyinstaller -F -n onnx-modifier -i onnx_modifier/static/favicon.png --add-data "onnx_modifier/templates;templates" --add-data "onnx_modifier/static;static" entry.py`
+                - see here: https://stackoverflow.com/a/48976223/10096987
+            - Then we can find the the target `.exe` file in the ./dist folder.
+                - The icon will not show until we change it in another directory due to Windows Explorer caching.
+                    - see here: https://stackoverflow.com/a/35783199/10096987
+
+        b. For Ubuntu (not done):
+            - Run `pyinstaller -F -n onnx-modifier -i ./static/favicon.png --add-data "templates:templates" --add-data "static:static" app_desktop.py`
+                - However, I get a file with size of 400+MB
+
+    '''
+    from flaskwebgui import FlaskUI
+    flask_ui = FlaskUI(app, maximized=True, idle_interval=float("inf"))
+    flask_ui.run()

app.py

@@ -11,10 +11,10 @@
 import numpy as np
 import onnx
 from onnx import numpy_helper
-from utils import str2np, str2val
-from utils import np2onnxdtype, str2onnxdtype
-from utils import make_new_node, make_attr_changed_node, make_input
-from utils import get_infered_shape
+from .utils import str2np, str2val
+from .utils import np2onnxdtype, str2onnxdtype
+from .utils import make_new_node, make_attr_changed_node, make_input
+from .utils import get_infered_shape
 
 class onnxModifier:
     def __init__(self, model_name, model_proto):

app_desktop.py

@@ -441,7 +441,6 @@
     <button id="add-node" class="graph-op-button-addNode">Add node</button>
     <select id="add-node-dropdown" class="graph-op-add-node-dropdown">
     </select>
-	<button id="load-model" class="graph-button-load">LoadModel</button>
 
     <button id="back-button" class="toolbar-back-button" title="Back">
         &#x276E;

entry.py

@@ -0,0 +1,25 @@
+[project]
+name = "onnx-modifier"
+version = "1.0.0"
+description = "A tool to modify ONNX models in a visualization fashion, based on Netron and Flask."
+readme = "README_pypi.md"
+authors = [
+  { name="Zhang Ge", email="[email protected]" },
+]
+
+dependencies = [
+    "onnx==1.13.0",
+    "flask==2.2.5",
+    "onnx-tool==0.8.1"
+]
+
+[build-system]
+requires = ["flit_core<4"]
+build-backend = "flit_core.buildapi"
+
+[project.scripts]
+onnx-modifier = "onnx_modifier.flask_server:launch_flask_server"
+
+[project.urls]
+Homepage = "https://github.com/ZhangGe6/onnx-modifier"
+Issues = "https://github.com/ZhangGe6/onnx-modifier/issues"