iree-org / iree

A retargetable MLIR-based machine learning compiler and runtime toolkit.
http://iree.dev/
Apache License 2.0
2.58k stars 579 forks source link

[New documentation] Write docs for "JAX frontend" #5454

Open ScottTodd opened 3 years ago

ScottTodd commented 3 years ago

Site and doc layout can be changed, but I've sketched out a rough draft already. This file just currently has some ideas in it, but it should match up with the TensorFlow and other frontend docs (see https://github.com/google/iree/issues/5453):

https://github.com/google/iree/blob/97d4eeac924177a094110984a825d8cce6604fa8/mkdocs/docs/frontends/jax.md#L1-L11

I was thinking we could have each "frontend" page discuss the formats used, features supported, and APIs available, while covering general Python binding details in the "bindings/python" page (preview: https://scotttodd.github.io/iree/bindings/python/). Some overlap and linking back and forth is fine, but we don't want people to get too lost in the docs.

ludgerpaehler commented 2 years ago

Really interested in this - does there exist an update on some branch to play around with, and possibly fill in a few gaps in the docs? :)

ScottTodd commented 2 years ago

The docs in IREE itself are still missing (https://google.github.io/iree/getting-started/jax/, https://github.com/google/iree/blob/main/docs/website/docs/getting-started/jax.md).

The https://github.com/google/iree-jax repo has the latest information and code.

@rsuderman / @stellaraccident , how stable is iree-jax? Could we fill in those docs now?

ScottTodd commented 1 year ago

Starting to work on this, sketches at https://github.com/ScottTodd/iree/tree/docs-jax

ScottTodd commented 2 days ago

https://openxla.org/stablehlo/tutorials/jax-export would be good to link to