Skip to content

Commit

Permalink
Small change to clean up main page for release (#548)
Browse files Browse the repository at this point in the history
Small change here to make user documentation more prominent and remove
the notice on the WIP banner (though it is ever true). If there are
other small touch ups on this page we want to clean up, feel free to
comment or submit a patch.
  • Loading branch information
amd-chrissosa authored Nov 15, 2024
1 parent 2d3bf36 commit 70b0096
Showing 1 changed file with 4 additions and 9 deletions.
13 changes: 4 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# shark-ai: SHARK Modeling and Serving Libraries

> [!IMPORTANT]
> Development is still in progress for several project components. See the
> notes below for which workflows are best supported.
![GitHub License](https://img.shields.io/github/license/nod-ai/shark-ai)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)

## SHARK Users

If you're looking to use SHARK check out our [User Guide](docs/user_guide.md). For developers continue to read on.

<!-- TODO: high level overview, features when components are used together -->

## Sub-projects
Expand Down Expand Up @@ -66,11 +66,6 @@ Model name | Model recipes | Serving apps
SDXL | [`sharktank/sharktank/models/punet/`](https://github.com/nod-ai/shark-ai/tree/main/sharktank/sharktank/models/punet) | [`shortfin/python/shortfin_apps/sd/`](https://github.com/nod-ai/shark-ai/tree/main/shortfin/python/shortfin_apps/sd)
llama | [`sharktank/sharktank/models/llama/`](https://github.com/nod-ai/shark-ai/tree/main/sharktank/sharktank/models/llama) | [`shortfin/python/shortfin_apps/llm/`](https://github.com/nod-ai/shark-ai/tree/main/shortfin/python/shortfin_apps/llm)


## SHARK Users

If you're looking to use SHARK check out our [User Guide](docs/user_guide.md).

## SHARK Developers

If you're looking to develop SHARK, check out our [Developer Guide](docs/developer_guide.md).

0 comments on commit 70b0096

Please sign in to comment.