Refresh some docs and samples from SHARK-Turbine to iree-turbine. (#17577)
Still need to complete the namespace migration from the `shark-turbine/`
subfolder to `iree/turbine` in https://github.com/iree-org/iree-turbine,
but some of these docs and URLs were already broken.
Also added a note about sharktank to https://iree.dev/community/ and
removed the mention of https://github.com/nod-ai/SRT (no more work is
happening in that downstream repo).
diff --git a/docs/website/docs/community/index.md b/docs/website/docs/community/index.md
index 339136d..34869fd 100644
--- a/docs/website/docs/community/index.md
+++ b/docs/website/docs/community/index.md
@@ -2,12 +2,17 @@
Projects built by community members:
-* The [SHARK](https://github.com/nod-ai/SHARK) and
- [SRT](https://github.com/nod-ai/SRT) projects offer highly tuned performance
- and user interfaces for running a large corpus of machine learning programs.
+* The [SHARK](https://github.com/nod-ai/SHARK) project offers user interfaces
+ for running a large corpus of machine learning programs.
-* The [SHARK-Turbine](https://github.com/nod-ai/SHARK-Turbine) project provides
- tools for bridging between PyTorch and IREE.
+* The [sharktank](https://github.com/nod-ai/sharktank) project contains
+ modeling and serving libraries for popular genai applications.
+
+* The [SHARK-Turbine](https://github.com/nod-ai/SHARK-Turbine) project is an
+ integration repository for various model bringup activities. Several parts
+ of SHARK-Turbine graduated to
+ [iree-turbine](https://github.com/iree-org/iree-turbine) and
+ [sharktank](https://github.com/nod-ai/sharktank).
* The [IREE Bare-Metal Arm Sample](https://github.com/iml130/iree-bare-metal-arm)
shows how to build IREE with the
@@ -21,6 +26,9 @@
Official repositories:
+* [iree-turbine](https://github.com/iree-org/iree-turbine) is home to IREE's
+ [PyTorch](https://pytorch.org/) frontend.
+
* [iree-jax](https://github.com/iree-org/iree-jax) is home to
IREE's AOT support for [JAX](https://github.com/google/jax) programs.
diff --git a/docs/website/docs/guides/ml-frameworks/pytorch.md b/docs/website/docs/guides/ml-frameworks/pytorch.md
index 14fb2bd..d816a6b 100644
--- a/docs/website/docs/guides/ml-frameworks/pytorch.md
+++ b/docs/website/docs/guides/ml-frameworks/pytorch.md
@@ -155,7 +155,7 @@
| Code samples | |
| -- | -- |
JIT compilation notebook | [](https://colab.research.google.com/github/iree-org/iree/blob/main/samples/colab/pytorch_jit.ipynb)
-Simple MLP eager | [`core/examples/eager_mlp/mlp_eager_simple.py`](https://github.com/nod-ai/SHARK-Turbine/blob/main/core/examples/eager_mlp/mlp_eager_simple.py)
+Simple MLP eager | [`core/examples/eager_mlp/mlp_eager_simple.py`](https://github.com/iree-org/iree-turbine/tree/main/examples/eager_mlp/mlp_eager_simple.py)
## :octicons-package-dependents-16: Ahead-of-time (AOT) export
@@ -232,7 +232,7 @@
| -- | -- |
Simple AOT export notebook | [](https://colab.research.google.com/github/iree-org/iree/blob/main/samples/colab/pytorch_aot_simple.ipynb)
Import [Whisper](https://huggingface.co/openai/whisper-small) from [:hugging: Hugging Face](https://huggingface.co/) notebook | [](https://colab.research.google.com/github/iree-org/iree/blob/main/samples/colab/pytorch_huggingface_whisper.ipynb)
-Simple MLP export | [`core/examples/aot_mlp/mlp_export_simple.py`](https://github.com/nod-ai/SHARK-Turbine/blob/main/core/examples/aot_mlp/mlp_export_simple.py)
+Simple MLP export | [`core/examples/aot_mlp/mlp_export_simple.py`](https://github.com/iree-org/iree-turbine/tree/main/examples/aot_mlp/mlp_export_simple.py)
### :octicons-tools-16: Advanced API
@@ -264,7 +264,7 @@
```
Advanced export workflows can use the
-[`aot.CompiledModule`](https://github.com/nod-ai/SHARK-Turbine/blob/main/core/shark_turbine/aot/compiled_module.py)
+[`aot.CompiledModule`](https://github.com/iree-org/iree-turbine/tree/main/shark_turbine/aot/compiled_module.py)
class to define and constrain the structure of a program prior to compiling it.
<!-- TODO(scotttodd): API reference pages for aot.CompiledModule etc.?
@@ -412,6 +412,6 @@
| -- | -- |
Advanced AOT export notebook | [](https://colab.research.google.com/github/iree-org/iree/blob/main/samples/colab/pytorch_aot_advanced.ipynb)
PyTorch dynamic shapes notebook | [](https://colab.research.google.com/github/iree-org/iree/blob/main/samples/dynamic_shapes/pytorch_dynamic_shapes.ipynb)
-AOT unit tests | [`core/tests/aot/`](https://github.com/nod-ai/SHARK-Turbine/tree/main/core/tests/aot)
-Dynamic MLP export | [`core/examples/aot_mlp/mlp_export_dynamic.py`](https://github.com/nod-ai/SHARK-Turbine/blob/main/core/examples/aot_mlp/mlp_export_dynamic.py)
+AOT unit tests | [`tests/aot/`](https://github.com/iree-org/iree-turbine/tree/main/tests/aot)
+Dynamic MLP export | [`core/examples/aot_mlp/mlp_export_dynamic.py`](https://github.com/iree-org/iree-turbine/tree/main/examples/aot_mlp/mlp_export_dynamic.py)
stateless llama2 | [`models/turbine_models/custom_models/stateless_llama.py`](https://github.com/nod-ai/SHARK-Turbine/blob/main/models/turbine_models/custom_models/stateless_llama.py)
diff --git a/samples/colab/README.md b/samples/colab/README.md
index 8241713..01f5926 100644
--- a/samples/colab/README.md
+++ b/samples/colab/README.md
@@ -8,9 +8,9 @@
Framework | Notebook file | Description | Link
-------- | ------------- | ----------- | ----
Generic | [low_level_invoke_function](low_level_invoke_function.ipynb) | Shows low level IREE python binding concepts | [](https://colab.research.google.com/github/iree-org/iree/blob/main/samples/colab/low_level_invoke_function.ipynb)
-PyTorch | [pytorch_aot_advanced](pytorch_aot_advanced.ipynb) | Uses [Turbine](https://github.com/nod-ai/SHARK-Turbine) to export a PyTorch program | [](https://colab.research.google.com/github/iree-org/iree/blob/main/samples/colab/pytorch_aot_advanced.ipynb)
-PyTorch | [pytorch_aot_simple](pytorch_aot_simple.ipynb) | Uses [Turbine](https://github.com/nod-ai/SHARK-Turbine) to export a simple PyTorch program | [](https://colab.research.google.com/github/iree-org/iree/blob/main/samples/colab/pytorch_aot_simple.ipynb)
-PyTorch | [pytorch_jit](pytorch_jit.ipynb) | Uses [Turbine](https://github.com/nod-ai/SHARK-Turbine) for eager execution in a PyTorch session | [](https://colab.research.google.com/github/iree-org/iree/blob/main/samples/colab/pytorch_jit.ipynb)
+PyTorch | [pytorch_aot_advanced](pytorch_aot_advanced.ipynb) | Uses [Turbine](https://github.com/iree-org/iree-turbine) to export a PyTorch program | [](https://colab.research.google.com/github/iree-org/iree/blob/main/samples/colab/pytorch_aot_advanced.ipynb)
+PyTorch | [pytorch_aot_simple](pytorch_aot_simple.ipynb) | Uses [Turbine](https://github.com/iree-org/iree-turbine) to export a simple PyTorch program | [](https://colab.research.google.com/github/iree-org/iree/blob/main/samples/colab/pytorch_aot_simple.ipynb)
+PyTorch | [pytorch_jit](pytorch_jit.ipynb) | Uses [Turbine](https://github.com/iree-org/iree-turbine) for eager execution in a PyTorch session | [](https://colab.research.google.com/github/iree-org/iree/blob/main/samples/colab/pytorch_jit.ipynb)
PyTorch | [pytorch_huggingface_whisper](pytorch_huggingface_whisper.ipynb) | Imports the [Whisper](https://huggingface.co/openai/whisper-small) model from [Hugging Face](https://huggingface.co/) | [](https://colab.research.google.com/github/iree-org/iree/blob/main/samples/colab/pytorch_huggingface_whisper.ipynb)
TensorFlow | [tensorflow_edge_detection](tensorflow_edge_detection.ipynb) |Performs image edge detection | [](https://colab.research.google.com/github/iree-org/iree/blob/main/samples/colab/tensorflow_edge_detection.ipynb)
TensorFlow | [tensorflow_hub_import](tensorflow_hub_import.ipynb) | Imports a [MobileNet V2](https://tfhub.dev/google/tf2-preview/mobilenet_v2/classification) model from [TensorFlow Hub](https://tfhub.dev/) | [](https://colab.research.google.com/github/iree-org/iree/blob/main/samples/colab/tensorflow_hub_import.ipynb)
diff --git a/samples/colab/pytorch_aot_advanced.ipynb b/samples/colab/pytorch_aot_advanced.ipynb
index bc6272d..0d5113a 100644
--- a/samples/colab/pytorch_aot_advanced.ipynb
+++ b/samples/colab/pytorch_aot_advanced.ipynb
@@ -45,9 +45,9 @@
"source": [
"# <img src=\"https://upload.wikimedia.org/wikipedia/commons/thumb/1/10/PyTorch_logo_icon.svg/640px-PyTorch_logo_icon.svg.png\" height=\"20px\"> PyTorch Ahead-of-time (AOT) export workflows using <img src=\"https://raw.githubusercontent.com/iree-org/iree/main/docs/website/docs/assets/images/IREE_Logo_Icon_Color.svg\" height=\"20px\"> IREE\n",
"\n",
- "This notebook shows how to use [SHARK-Turbine](https://github.com/nod-ai/SHARK-Turbine) for export from a PyTorch session to [IREE](https://github.com/iree-org/iree), leveraging [torch-mlir](https://github.com/llvm/torch-mlir) under the covers.\n",
+ "This notebook shows how to use [iree-turbine](https://github.com/iree-org/iree-turbine) for export from a PyTorch session to [IREE](https://github.com/iree-org/iree), leveraging [torch-mlir](https://github.com/llvm/torch-mlir) under the covers.\n",
"\n",
- "SHARK-Turbine contains both a \"simple\" AOT exporter and an underlying advanced\n",
+ "iree-turbine contains both a \"simple\" AOT exporter and an underlying advanced\n",
"API for complicated models and full feature availability. This notebook shows\n",
"some of the features available in the \"advanced\" toolkit."
],
diff --git a/samples/colab/pytorch_aot_simple.ipynb b/samples/colab/pytorch_aot_simple.ipynb
index a4c1719..aff1f45 100644
--- a/samples/colab/pytorch_aot_simple.ipynb
+++ b/samples/colab/pytorch_aot_simple.ipynb
@@ -45,9 +45,9 @@
"source": [
"# <img src=\"https://upload.wikimedia.org/wikipedia/commons/thumb/1/10/PyTorch_logo_icon.svg/640px-PyTorch_logo_icon.svg.png\" height=\"20px\"> PyTorch Ahead-of-time (AOT) export workflows using <img src=\"https://raw.githubusercontent.com/iree-org/iree/main/docs/website/docs/assets/images/IREE_Logo_Icon_Color.svg\" height=\"20px\"> IREE\n",
"\n",
- "This notebook shows how to use [SHARK-Turbine](https://github.com/nod-ai/SHARK-Turbine) for export from a PyTorch session to [IREE](https://github.com/iree-org/iree), leveraging [torch-mlir](https://github.com/llvm/torch-mlir) under the covers.\n",
+ "This notebook shows how to use [iree-turbine](https://github.com/iree-org/iree-turbine) for export from a PyTorch session to [IREE](https://github.com/iree-org/iree), leveraging [torch-mlir](https://github.com/llvm/torch-mlir) under the covers.\n",
"\n",
- "SHARK-Turbine contains both a \"simple\" AOT exporter and an underlying advanced\n",
+ "iree-turbine contains both a \"simple\" AOT exporter and an underlying advanced\n",
"API for complicated models and full feature availability. This notebook only\n",
"uses the \"simple\" exporter."
],
diff --git a/samples/colab/pytorch_huggingface_whisper.ipynb b/samples/colab/pytorch_huggingface_whisper.ipynb
index 7bcbe0a..ef61b9c 100644
--- a/samples/colab/pytorch_huggingface_whisper.ipynb
+++ b/samples/colab/pytorch_huggingface_whisper.ipynb
@@ -46,7 +46,7 @@
"source": [
"# <img src=\"https://huggingface.co/datasets/huggingface/brand-assets/resolve/main/hf-logo.png\" height=\"20px\"> Hugging Face to <img src=\"https://upload.wikimedia.org/wikipedia/commons/thumb/1/10/PyTorch_logo_icon.svg/640px-PyTorch_logo_icon.svg.png\" height=\"20px\"> PyTorch to <img src=\"https://raw.githubusercontent.com/iree-org/iree/main/docs/website/docs/assets/images/IREE_Logo_Icon_Color.svg\" height=\"20px\"> IREE\n",
"\n",
- "This notebook uses [SHARK-Turbine](https://github.com/nod-ai/SHARK-Turbine) to export a pretrained [Hugging Face Transformers](https://huggingface.co/docs/transformers/) model to [IREE](https://github.com/iree-org/iree), leveraging [torch-mlir](https://github.com/llvm/torch-mlir) under the covers.\n",
+ "This notebook uses [iree-turbine](https://github.com/iree-org/iree-turbine) to export a pretrained [Hugging Face Transformers](https://huggingface.co/docs/transformers/) model to [IREE](https://github.com/iree-org/iree), leveraging [torch-mlir](https://github.com/llvm/torch-mlir) under the covers.\n",
"\n",
"* The pretrained [whisper-small](https://huggingface.co/openai/whisper-small)\n",
" model is showcased here as it is small enough to fit comfortably into a Colab\n",
diff --git a/samples/colab/pytorch_jit.ipynb b/samples/colab/pytorch_jit.ipynb
index f5129e1..74a7967 100644
--- a/samples/colab/pytorch_jit.ipynb
+++ b/samples/colab/pytorch_jit.ipynb
@@ -45,7 +45,7 @@
"source": [
"# <img src=\"https://upload.wikimedia.org/wikipedia/commons/thumb/1/10/PyTorch_logo_icon.svg/640px-PyTorch_logo_icon.svg.png\" height=\"20px\"> PyTorch Just-in-time (JIT) workflows using <img src=\"https://raw.githubusercontent.com/iree-org/iree/main/docs/website/docs/assets/images/IREE_Logo_Icon_Color.svg\" height=\"20px\"> IREE\n",
"\n",
- "This notebook shows how to use [SHARK-Turbine](https://github.com/nod-ai/SHARK-Turbine) for eager execution within a PyTorch session using [IREE](https://github.com/iree-org/iree) and [torch-mlir](https://github.com/llvm/torch-mlir) under the covers."
+ "This notebook shows how to use [iree-turbine](https://github.com/iree-org/iree-turbine) for eager execution within a PyTorch session using [IREE](https://github.com/iree-org/iree) and [torch-mlir](https://github.com/llvm/torch-mlir) under the covers."
],
"metadata": {
"id": "38UDc27KBPD1"
diff --git a/samples/dynamic_shapes/pytorch_dynamic_shapes.ipynb b/samples/dynamic_shapes/pytorch_dynamic_shapes.ipynb
index 5442dcd..dc08015 100644
--- a/samples/dynamic_shapes/pytorch_dynamic_shapes.ipynb
+++ b/samples/dynamic_shapes/pytorch_dynamic_shapes.ipynb
@@ -47,7 +47,7 @@
"\n",
"This notebook\n",
"\n",
- "1. Creates a PyTorch program with dynamic shapes using [SHARK-Turbine](https://github.com/nod-ai/SHARK-Turbine)'s advanced AOT toolkit\n",
+ "1. Creates a PyTorch program with dynamic shapes using [iree-turbine](https://github.com/iree-org/iree-turbine)'s advanced AOT toolkit\n",
"2. Compiles the program to an IREE VM bytecode module\n",
"3. Tests running the compiled VM module using IREE's runtime\n",
"4. Downloads compilation artifacts for use with the native (C API) sample application"
