microsoft / onnxscript

ONNX Script enables developers to naturally author ONNX functions and models using a subset of Python.
https://onnxscript.ai/
MIT License
244 stars 45 forks source link

[optimizer/rewriter] Create documentation for the optimizer and rewriter #1365

Open shubhambhokare1 opened 2 months ago

shubhambhokare1 commented 2 months ago

Create documentation for the optimizer and rewriter, feel free to add any cases we think we need to cover

### Tasks
- [ ] An example to show how to use the rewrite tool using the replacement by function name
- [ ] https://github.com/microsoft/onnxscript/issues/1361
- [ ] https://github.com/microsoft/onnxscript/issues/1049
- [ ] https://github.com/microsoft/onnxscript/pull/1413
- [ ] https://github.com/microsoft/onnxscript/pull/1482
- [ ] #1493
gramalingam commented 2 months ago

How about a section on the new IR?

gramalingam commented 2 months ago

All examples in documentation should also be actually run and validated (by the CI, etc.).

justinchuby commented 1 month ago

@shubhambhokare1 Would be nice to have a getting started page for the optimizer/rewriter to document the two-line code for running them