Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
monorimet authored Sep 24, 2024
1 parent 5eb013d commit 3a4493d
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# SHARK Turbine

This repo is Nod-AI's integration repository for various model bringup
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
by being the place where FX/Dynamo based torch-mlir and IREE toolsets
were developed, including:
Expand All @@ -11,20 +11,20 @@ were developed, including:
* [IREE Turbine](https://github.com/iree-org/iree-turbine)
* [Sharktank and Shortfin](https://github.com/nod-ai/sharktank)

As these have all found upstream homes, this repo is a bit bare. We will
continue to use it as a staging ground for things that don't have a
more defined spot and as a way to drive certain kinds of upstreaming
activities.


## Current Projects
As these have all found upstream homes, this repo is now responsible for:
- Exporting (via iree-turbine tooling) and compiling (via iree-compile) torch modules from various sources, mostly huggingface libraries
- Carrying alternative (maximally exported and compiled) implementations to complex inference tasks e.g. Stable Diffusion (1.5, 2.1, SDXL, SD3, Flux)

### turbine-models

The `turbine-models` project (under models/) contains ports and adaptations
of various (mostly HF) models that we use in various ways.

### CI
The only implementation in turbine-models that is currently canonical is stable diffusion, which is 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.

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)

Integration CI for a variety of projects is rooted in this repo.
### CI / Tracking

A number of model support tasks are tracked in this repo's issues, and its CI is designed to be the origin point for any MLIR/VMFB artifacts used further downstream in test/benchmark/regression suites.

0 comments on commit 3a4493d

Please sign in to comment.