[docs] Update README.md for brief descriptions of optimizer and rewriter tools. #1702
Conversation
shubhambhokare1
added
documentation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1702 +/- ##
=======================================
Coverage 75.75% 75.75%
=======================================
Files 240 240
Lines 25495 25495
Branches 4549 4549
=======================================
Hits 19313 19313
Misses 5281 5281
Partials 901 901 ☔ View full report in Codecov by Sentry. |
Test Results 30 files ±0 30 suites ±0 1h 7m 4s ⏱️ - 1m 52s For more details on these failures, see this check. Results for commit c2c08b6. ± Comparison against base commit 1aa7a70. |
| from onnxscript.rewriter import pattern | ||
|
|
||
| # Create multiple rules | ||
| rule1 = pattern.RewriteRule( |
There was a problem hiding this comment.
You should include the code of both rewriting functions.
|
|
||
| For a detailed summary of all the optimizations applied by the optimizer call, refer to the tutorial [Optimizing a Model using the Optimizer](https://onnxscript.ai/tutorial/optimizer/optimize.html) | ||
|
|
||
| ### ONNX Rewriter |
There was a problem hiding this comment.
We should also have a short paragraph on ONNX IR
| @@ -142,6 +142,56 @@ result = Hardmax(v) | |||
|
|
|||
| More examples can be found in the [docs/examples](docs/examples) directory. | |||
|
|
|||
| ## ONNX Script Tools | |||
There was a problem hiding this comment.
I think updating the very first paragraph would also be helpful. Saying something like "The repo covers ONNXScript + IR/Optimizer/Rewriter", expanded into a couple of sentences
#TODO Add more details about function-based rewriting once tutorial for function-based rewriting is merged