diff --git a/README.md b/README.md index 7a352de1..584b1a3c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ -# SHARK Turbine +# SHARK-ModelDev -This is the AMD SHARK team's integration repository for various ML model bringup -activities and CI. In 2023 and early 2024, it played a different role +This is the AMD SHARK team's integration repository that connects inference tasks, such as Stable Diffusion, from their various source libraries to the IREE/SHARK ML acceleration and deployment framework. + +In 2023 and early 2024, it played a different role by being the place where FX/Dynamo based torch-mlir and IREE toolsets were developed, including: @@ -20,7 +21,7 @@ As these have all found upstream homes, this repo is now responsible for: The `turbine-models` project (under models/) contains ports and adaptations of various (mostly HF) models that we use in various ways. -The only implementation in turbine-models that is currently in use is its stable diffusion exports and pipeline, which are slated for migration to https://github.com/nod-ai/SHARK-Platform for productionization -- it is to be temporarily preserved here for proof of concept, functionality, and performance. +The only implementation in turbine-models that is currently in use is its stable diffusion exports and pipeline, which are slated for migration to https://github.com/nod-ai/SHARK-Platform for productionization -- it is to be temporarily preserved here for proof of concept, functionality, and performance. The current state of the turbine-models SD implementation is heavily based on Diffusers' StableDiffusionPipelines, with the harnessing and actual inference code rewritten to offload as much as possible from torch (cpu) to the IREE compiler and runtime. In the near future, the remaining purpose of turbine-models is to maintain and validate the " library import -> nn.module -> iree-turbine (dynamo) -> iree-compile " export and compilation stack, for a few different key model classes or suites. The model validation and benchmarking of compiled artifacts is under migration to [SHARK-TestSuite](https://github.com/nod-ai/SHARK-TestSuite)