Add documentation guide for parameters. (#16382)
This adds a new guide to the website explaining what "parameters" are in
IREE and walking through a few ways to work with them.
A few sections are not yet completed, but this should be enough to
introduce some of the concepts and get people started.
**Notable omissions** that I'm aware of (these can/should be documented
but I haven't written the content yet):
* Existing `.mlir` with embedded weights --> `.irpa` file by using
`--iree-io-export-parameters`
* Existing `.mlir` with parameters + `.irpa` file --> `.mlir` with
embedded weights by using `--iree-io-import-parameters` (this pass does
not exist yet)
* More concrete examples (e.g. Colab notebooks) of working with GGUF /
Safetensors
* Scopes and overlays
* Sharding of `.irpa` files
* Concrete examples of using splats for developer workflows
* Reading _and_ writing parameters (training loops)
* Custom parameter indices (e.g. Python/Java/etc. code loading from
memory or the network, or cuFile/DirectStorage)
Progress on https://github.com/openxla/iree/issues/14987
diff --git a/docs/website/mkdocs.yml b/docs/website/mkdocs.yml
index 18a1639..15412e5 100644
--- a/docs/website/mkdocs.yml
+++ b/docs/website/mkdocs.yml
@@ -139,6 +139,8 @@
- GPU - CUDA: "guides/deployment-configurations/gpu-cuda.md"
- GPU - ROCm: "guides/deployment-configurations/gpu-rocm.md"
- GPU - Metal: "guides/deployment-configurations/gpu-metal.md"
+ - "General topics":
+ - "guides/parameters.md"
- "Reference":
- "reference/index.md"
- "API bindings":