Skip to content

Commit decab2e

Browse files
authored
Improvement to IR docs 2/n (#2229)
Major improvement in documenting all submodules in onnxscript.ir. Also added documentation for the rewriter, optimizer and version converter. ![image](https://github.com/user-attachments/assets/cdb66f93-0f93-4112-b20f-055f275b2cca) ![image](https://github.com/user-attachments/assets/2610c439-4ecf-4e96-9c9b-ff98b5d6dc23)
1 parent a028d2b commit decab2e

28 files changed

Lines changed: 367 additions & 40 deletions

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ dmypy.json
100100
*.onnxlib
101101
**/onnx_backend_test_code/**
102102
docs/auto_examples/*
103-
docs/intermediate_representation/generated/*
103+
docs/**/generated/*
104104
tests/export/*
105105
tests/models/testoutputs/*
106106
tests/mylib.onnxlib

docs/_templates/classtemplate.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77

88
.. autoclass:: {{ name }}
99
:members:
10-
10+
:undoc-members:
11+
:member-order: bysource
1112

1213
..
1314
autogenerated from docs/_templates/classtemplate.rst
14-
note it does not have :inherited-members:
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.. role:: hidden
2+
:class: hidden-section
3+
.. currentmodule:: {{ module }}
4+
5+
6+
{{ name | underline}}
7+
8+
.. autoclass:: {{ name }}
9+
:members:
10+
:undoc-members:
11+
:inherited-members:
12+
:member-order: bysource
13+
14+
15+
..
16+
autogenerated from docs/_templates/classtemplate.rst
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.. role:: hidden
2+
:class: hidden-section
3+
.. currentmodule:: {{ module }}
4+
5+
6+
{{ name | underline}}
7+
8+
.. autofunction:: {{ name }}
9+
10+
11+
..
12+
autogenerated from docs/_templates/functiontemplate.rst

docs/api/index.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,29 @@
33
## Author Models
44

55
```{toctree}
6+
:maxdepth: 1
7+
68
decorator
79
opsets
810
converter
911
values
1012
```
1113

12-
## Tests and Tools
14+
## Model transformation
1315

1416
```{toctree}
17+
:maxdepth: 1
18+
19+
optimizer
20+
rewriter
21+
rewriter_pattern
22+
version_converter
23+
```
24+
25+
## Testing
26+
27+
```{toctree}
28+
:maxdepth: 1
29+
1530
testing
16-
tools
1731
```

docs/api/optimizer.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# onnxscript.optimizer
2+
3+
```{eval-rst}
4+
.. automodule::onnxscript.optimizer
5+
.. currentmodule:: onnxscript
6+
```
7+
8+
```{eval-rst}
9+
.. autosummary::
10+
:toctree: generated
11+
:template: functiontemplate.rst
12+
:nosignatures:
13+
14+
optimizer.optimize
15+
optimizer.inline
16+
optimizer.basic_constant_propagation
17+
optimizer.fold_constants
18+
optimizer.remove_unused_nodes
19+
```

docs/api/rewriter.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# onnxscript.rewriter
2+
3+
```{eval-rst}
4+
.. automodule::onnxscript.rewriter
5+
.. currentmodule:: onnxscript
6+
```
7+
8+
```{eval-rst}
9+
.. autosummary::
10+
:toctree: generated
11+
:template: functiontemplate.rst
12+
:nosignatures:
13+
14+
rewriter.rewrite
15+
```
16+
17+
## IR passes
18+
19+
```{eval-rst}
20+
.. autosummary::
21+
:toctree: generated
22+
:template: classtemplate.rst
23+
:nosignatures:
24+
25+
rewriter.RewritePass
26+
```

docs/api/rewriter_pattern.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# onnxscript.rewriter.pattern
2+
3+
```{eval-rst}
4+
.. automodule::onnxscript.rewriter.pattern
5+
.. currentmodule:: onnxscript
6+
```
7+
8+
```{eval-rst}
9+
.. autosummary::
10+
:toctree: generated
11+
:template: classtemplate.rst
12+
:nosignatures:
13+
14+
rewriter.pattern.Pattern
15+
rewriter.pattern.StringPattern
16+
rewriter.pattern.StringConstantPattern
17+
rewriter.pattern.PrefixPattern
18+
rewriter.pattern.AttrPattern
19+
rewriter.pattern.AttrConstantPattern
20+
rewriter.pattern.OpsetPatternBuilder
21+
rewriter.pattern.OpPatternBuilder
22+
rewriter.pattern.MatchResult
23+
rewriter.pattern.ValuePattern
24+
rewriter.pattern.NodePattern
25+
rewriter.pattern.NodeOutputPattern
26+
rewriter.pattern.AnyValue
27+
rewriter.pattern.Constant
28+
rewriter.pattern.GraphPattern
29+
rewriter.pattern.ReplacementSubgraph
30+
rewriter.pattern.ReplacementPatternFunction
31+
rewriter.pattern.PatternMatcher
32+
rewriter.pattern.SimplePatternMatcher
33+
rewriter.pattern.RewriteRule
34+
rewriter.pattern.RewriteRuleAsClass
35+
rewriter.pattern.RewriteRuleSet
36+
rewriter.pattern.MatchStatus
37+
rewriter.pattern.MatchInfo
38+
rewriter.pattern.MatchingTracer
39+
```

docs/api/tools.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

docs/api/version_converter.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# onnxscript.version_converter
2+
3+
```{eval-rst}
4+
.. automodule::onnxscript.version_converter
5+
.. currentmodule:: onnxscript
6+
```
7+
8+
## Functions
9+
10+
```{eval-rst}
11+
.. autosummary::
12+
:toctree: generated
13+
:template: functiontemplate.rst
14+
:nosignatures:
15+
16+
version_converter.convert_version
17+
```
18+
19+
## IR passes
20+
21+
```{eval-rst}
22+
.. autosummary::
23+
:toctree: generated
24+
:template: classtemplate.rst
25+
:nosignatures:
26+
27+
version_converter.ConvertVersionPass
28+
```

0 commit comments

Comments
 (0)