Skip to content

Commit d794fca

Browse files
authored
Create diagram for IR objects (#69)
Create concepts diagram and display it on readme. Also updates the readme to display the logo. --------- Signed-off-by: Justin Chu <[email protected]>
1 parent 7b9b90b commit d794fca

File tree

4 files changed

+4267
-2
lines changed

4 files changed

+4267
-2
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ONNX IR
1+
# <img src="docs/_static/logo-light.png" alt="ONNX IR" width="250"/>
22

33
[![PyPI - Version](https://img.shields.io/pypi/v/onnx-ir.svg)](https://pypi.org/project/onnx-ir)
44
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/onnx-ir.svg)](https://pypi.org/project/onnx-ir)
@@ -36,6 +36,10 @@ pip install git+https://github.com/onnx/ir-py.git
3636
- Pythonic and familiar APIs: Classes define Pythonic apis and still map to ONNX protobuf concepts in an intuitive way.
3737
- No protobuf dependency: The IR does not require protobuf once the model is converted to the IR representation, decoupling from the serialization format.
3838

39+
## Concepts Diagram
40+
41+
![Concepts Diagram](docs/resource/onnx-ir-entities.svg)
42+
3943
## Code Organization 🗺️
4044

4145
- [`_protocols.py`](src/onnx_ir/_protocols.py): Interfaces defined for all entities in the IR.

REUSE.toml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,20 @@ path = [
1111
".editorconfig",
1212
".gitignore",
1313
"**/*.css",
14+
"**/*.excalidraw",
1415
"**/*.ipynb",
1516
"**/*.md",
1617
"**/*.png",
1718
"**/*.rst",
19+
"**/*.svg",
1820
"**/*.textproto",
1921
"**/*.toml",
2022
"**/*.yml",
2123
"CODEOWNERS",
2224
"MANIFEST.in",
23-
"src/onnx_ir/py.typed",
2425
"requirements*.txt",
2526
"requirements/**/*.txt",
27+
"src/onnx_ir/py.typed",
2628
]
2729
precedence = "aggregate"
2830
SPDX-FileCopyrightText = "Copyright (c) ONNX Project Contributors"

docs/resource/onnx-ir-entities.svg

Lines changed: 2 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)